hal::user_feedback Namespace Reference

Classes
class	LayoutLocker
class	ProgressScope
class	ProgressPrinter

Functions
void	report_progress (int percent, const std::string &message)

Detailed Description

Feedback that a long-running operation gives to the user interface, such as its progress or the fact that it is about to change the netlist a lot.

The user interface is looked up at runtime through plugin_manager::get_ui_plugin, so all of this does nothing when running from a script or from the command line, and no plugin needs to depend on the user interface to use it. In particular, a plugin does not need to provide a GuiExtensionInterface just to report progress.

Function Documentation

report_progress()

void hal::user_feedback::report_progress	(	int	percent,
		const std::string &	message
	)

Report the progress of a long-running operation to the user interface.

A percentage of 100 dismisses the progress display again and must therefore be reported exactly once per operation, which is what ProgressScope is for. Prefer that over calling this directly, and prefer ProgressPrinter over both if the operation can say how far along it is, as that also reaches a user running from the command line.

Parameters

[in]	percent	- The progress in percent, where 100 means done.
[in]	message	- The message to display alongside the progress.

Definition at line 26 of file user_feedback.cpp.

References hal::plugin_manager::get_ui_plugin().

Referenced by hal::user_feedback::ProgressScope::ProgressScope(), hal::user_feedback::ProgressPrinter::report(), hal::user_feedback::ProgressPrinter::set_message(), and hal::user_feedback::ProgressScope::~ProgressScope().