pcl::ProgressBarStatus Class Reference

A status monitoring callback that shows a modal progress dialog. More...

#include <ProgressBarStatus.h>

Inheritance diagram for pcl::ProgressBarStatus:

Public Member Functions
	ProgressBarStatus (const String &title, Control &parent=Control::Null())
	~ProgressBarStatus () override
int	Completed (const StatusMonitor &monitor) const override
void	InfoUpdated (const StatusMonitor &monitor) const override
int	Initialized (const StatusMonitor &monitor) const override
int	Updated (const StatusMonitor &monitor) const override
Public Member Functions inherited from pcl::StatusCallback
	StatusCallback ()=default
	StatusCallback (const StatusCallback &)=default
	StatusCallback (StatusCallback &&)=default
virtual	~StatusCallback ()
StatusCallback &	operator= (const StatusCallback &)=default
StatusCallback &	operator= (StatusCallback &&)=default

Detailed Description

ProgressBarStatus is a StatusCallback derived class that opens a modal ProgressDialog to provide visual feedback about a running process, without freezing the graphical user interface dugin potentially long tasks. It allows the user to interrupt the process by activating a standard Cancel button on the progress dialog. This class supports both bounded and unbounded status monitors.

See also

StatusCallback, StatusMonitor, StandardStatus, SpinStatus, MuteStatus

Definition at line 85 of file ProgressBarStatus.h.

Constructor & Destructor Documentation

ProgressBarStatus()

pcl::ProgressBarStatus::ProgressBarStatus	(	const String &	title,
		Control &	parent = Control::Null()
	)

Constructs a ProgressBarStatus object.

Parameters

title	The window title for the modal progress bar dialog box.
parent	The parent control of the modal progress bar dialog box. The default value is Control::Null(), which creates a child top-level window of the current workspace.

~ProgressBarStatus()

pcl::ProgressBarStatus::~ProgressBarStatus ( )

override

Destroys a ProgressBarStatus object.

Member Function Documentation

Completed()

int pcl::ProgressBarStatus::Completed ( const StatusMonitor &  monitor ) const

overridevirtual

Function called by a status monitor object to signal that the current process has finished.

Implements pcl::StatusCallback.

InfoUpdated()

void pcl::ProgressBarStatus::InfoUpdated ( const StatusMonitor &  monitor ) const

overridevirtual

Function called by a status monitor object when the progress information for the current process has been changed.

Implements pcl::StatusCallback.

Initialized()

int pcl::ProgressBarStatus::Initialized ( const StatusMonitor &  monitor ) const

overridevirtual

This function is called by a status monitor object when a new monitored process is about to start.

Implements pcl::StatusCallback.

Updated()

int pcl::ProgressBarStatus::Updated ( const StatusMonitor &  monitor ) const

overridevirtual

Function called by a status monitor object to signal an update of the progress count for the current process.

Implements pcl::StatusCallback.

---

The documentation for this class was generated from the following file:

• ProgressBarStatus.h