A progress dialog. More...

#include <ProgressViewerDialog.h>

Inheritance diagram for te::qt::widgets::ProgressViewerDialog:

Signals
void	resetProgress ()

void	setProgressMessage (const std::string &message)

void	setProgressRange (int min, int max)

void	setProgressValue (int value)

Public Member Functions
void	addTask (te::common::TaskProgress *t, int id)
	Insert a new taks to progress viewer container.

void	cancelTask (int taskId)
	Cancel a task.

	ProgressViewerDialog (QWidget *parent, QString title="")
	Default constructor.

void	removeTask (int taskId)
	Removes a task from progress viewer container.

void	setTitle (QString title)
	Set title to dialog.

void	setTotalValues (int taskId)
	Set task total steps.

void	updateMessage (int taskId)
	Update the progress message.

void	updateValue (int taskId)
	Update the progress evaluation.

	~ProgressViewerDialog ()
	Virtual destructor.

Protected Slots
virtual void	cancel ()

virtual void	onResetProgress ()

virtual void	onSetProgressMessage (const std::string &message)

virtual void	onSetProgressRange (int min, int max)

virtual void	onSetProgressValue (int value)

Protected Attributes
int	m_currentStep
	Attribute used to define the current steps of all task.

QProgressDialog *	m_dlgProgress
	GUI Objects used as progress bar dialog.

std::string	m_message
	Attribute used to define dialog message.

std::mutex	m_mutex

int	m_propStep
	Attribute used to define the proportional step (0-100).

bool	m_reset

std::map< int, te::common::TaskProgress * >	m_tasks
	Task container.

int	m_totalSteps
	Attribute used to define the total steps of all tasks.

int	m_viewerId

Detailed Description

A progress dialog.

This widget is a dialog with progress information and a cancel button.

This viewer is made using Qt Progress Dialog. Feed back will be generated over a dialog window. Multiples tasks will be displayed using ONLY one progress.

The proportional value is calculated using TOTALSTEPS / CURRENTSTEPS, where:

TOTALSTEPS: Sum of all total steps of all tasks
CURRENTSTEPS: Sum of all current steps of all tasks

The progress message is defined by the task message, if it has more than on task the message will be "MULTI TASKS".

Definition at line 73 of file ProgressViewerDialog.h.

Constructor & Destructor Documentation

◆ ProgressViewerDialog()

te::qt::widgets::ProgressViewerDialog::ProgressViewerDialog	(	QWidget *	parent,
		QString	title = `""`
	)

Default constructor.

◆ ~ProgressViewerDialog()

te::qt::widgets::ProgressViewerDialog::~ProgressViewerDialog ( )

Virtual destructor.

Member Function Documentation

◆ addTask()

void te::qt::widgets::ProgressViewerDialog::addTask	(	te::common::TaskProgress *	t,
		int	id
	)

virtual

Insert a new taks to progress viewer container.

Parameters

t	Task pointer.
id	Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

◆ cancel

virtual void te::qt::widgets::ProgressViewerDialog::cancel ( )

protectedvirtualslot

◆ cancelTask()

void te::qt::widgets::ProgressViewerDialog::cancelTask ( int taskId )

virtual

Cancel a task.

Parameters

taskId Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

◆ onResetProgress

virtual void te::qt::widgets::ProgressViewerDialog::onResetProgress ( )

protectedvirtualslot

◆ onSetProgressMessage

virtual void te::qt::widgets::ProgressViewerDialog::onSetProgressMessage ( const std::string & message )

protectedvirtualslot

◆ onSetProgressRange

virtual void te::qt::widgets::ProgressViewerDialog::onSetProgressRange	(	int	min,
		int	max
	)

protectedvirtualslot

◆ onSetProgressValue

virtual void te::qt::widgets::ProgressViewerDialog::onSetProgressValue ( int value )

protectedvirtualslot

◆ removeTask()

void te::qt::widgets::ProgressViewerDialog::removeTask ( int taskId )

virtual

Removes a task from progress viewer container.

Parameters

taskId Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

◆ resetProgress

void te::qt::widgets::AbstractQtProgressViewer::resetProgress ( )

signalinherited

◆ setProgressMessage

void te::qt::widgets::AbstractQtProgressViewer::setProgressMessage ( const std::string & message )

signalinherited

◆ setProgressRange

void te::qt::widgets::AbstractQtProgressViewer::setProgressRange	(	int	min,
		int	max
	)

signalinherited

◆ setProgressValue

void te::qt::widgets::AbstractQtProgressViewer::setProgressValue ( int value )

signalinherited

◆ setTitle()

void te::qt::widgets::ProgressViewerDialog::setTitle ( QString title )

Set title to dialog.

Parameters

title A QString title.

◆ setTotalValues()

void te::qt::widgets::ProgressViewerDialog::setTotalValues ( int taskId )

virtual

Set task total steps.

Parameters

taskId Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

◆ updateMessage()

void te::qt::widgets::ProgressViewerDialog::updateMessage ( int taskId )

virtual

Update the progress message.

Parameters

taskId Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

◆ updateValue()

void te::qt::widgets::ProgressViewerDialog::updateValue ( int taskId )

virtual

Update the progress evaluation.

Parameters

taskId Task identifier.

Implements te::qt::widgets::AbstractQtProgressViewer.

Member Data Documentation

◆ m_currentStep

int te::qt::widgets::ProgressViewerDialog::m_currentStep

protected

Attribute used to define the current steps of all task.

Definition at line 150 of file ProgressViewerDialog.h.

◆ m_dlgProgress

QProgressDialog* te::qt::widgets::ProgressViewerDialog::m_dlgProgress

protected

GUI Objects used as progress bar dialog.

Definition at line 154 of file ProgressViewerDialog.h.

◆ m_message

std::string te::qt::widgets::ProgressViewerDialog::m_message

protected

Attribute used to define dialog message.

Definition at line 152 of file ProgressViewerDialog.h.

◆ m_mutex

std::mutex te::qt::widgets::ProgressViewerDialog::m_mutex

protected

Definition at line 158 of file ProgressViewerDialog.h.

◆ m_propStep

int te::qt::widgets::ProgressViewerDialog::m_propStep

protected

Attribute used to define the proportional step (0-100).

Definition at line 151 of file ProgressViewerDialog.h.

◆ m_reset

bool te::qt::widgets::ProgressViewerDialog::m_reset

protected

Definition at line 156 of file ProgressViewerDialog.h.

◆ m_tasks

std::map<int, te::common::TaskProgress*> te::qt::widgets::ProgressViewerDialog::m_tasks

protected

Task container.

Definition at line 153 of file ProgressViewerDialog.h.

◆ m_totalSteps

int te::qt::widgets::ProgressViewerDialog::m_totalSteps

protected

Attribute used to define the total steps of all tasks.

Definition at line 149 of file ProgressViewerDialog.h.

◆ m_viewerId

int te::common::AbstractProgressViewer::m_viewerId

protectedinherited

Definition at line 105 of file AbstractProgressViewer.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/qt/widgets/progress/ProgressViewerDialog.h

Signals

Public Member Functions

Protected Slots

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgressViewerDialog()

◆ ~ProgressViewerDialog()

Member Function Documentation

◆ addTask()

◆ cancel

◆ cancelTask()

◆ onResetProgress

◆ onSetProgressMessage

◆ onSetProgressRange

◆ onSetProgressValue

◆ removeTask()

◆ resetProgress

◆ setProgressMessage

◆ setProgressRange

◆ setProgressValue

◆ setTitle()

◆ setTotalValues()

◆ updateMessage()

◆ updateValue()

Member Data Documentation

◆ m_currentStep

◆ m_dlgProgress

◆ m_message

◆ m_mutex

◆ m_propStep

◆ m_reset

◆ m_tasks

◆ m_totalSteps

◆ m_viewerId