#include <hal_core/plugin_system/user_feedback.h>

Collaboration diagram for hal::user_feedback::ProgressScope:

Public Member Functions
	ProgressScope (const std::string &message)

	~ProgressScope ()

	ProgressScope (const ProgressScope &)=delete

ProgressScope &	operator= (const ProgressScope &)=delete

Detailed Description

Brackets a long-running operation in the progress display of the user interface.

Shows the display on construction and dismisses it on destruction, so that it is dismissed no matter how the operation was invoked and no matter how it returned. Scopes may be nested, in which case only the outermost one takes effect: an operation invoked from the user interface thereby keeps the display up while its caller is still post-processing the results.

Definition at line 91 of file user_feedback.h.

Constructor & Destructor Documentation

◆ ProgressScope() [1/2]

hal::user_feedback::ProgressScope::ProgressScope ( const std::string & message )

explicit

Construct a progress scope and show the progress display at zero percent.

Parameters

[in] message - The message to display alongside the progress.

Definition at line 52 of file user_feedback.cpp.

References hal::user_feedback::report_progress().

◆ ~ProgressScope()

hal::user_feedback::ProgressScope::~ProgressScope ( )

Definition at line 60 of file user_feedback.cpp.

References hal::user_feedback::report_progress().

◆ ProgressScope() [2/2]

hal::user_feedback::ProgressScope::ProgressScope ( const ProgressScope & )

delete

Member Function Documentation

◆ operator=()

ProgressScope& hal::user_feedback::ProgressScope::operator= ( const ProgressScope & )