A progress viewer for a unique task. More...

#include <ProgressViewerTaskWidget.h>

Inheritance diagram for te::qt::widgets::ProgressViewerTaskWidget:

Signals
void	resetProgress ()

void	setProgressMessage (const std::string &message)

void	setProgressRange (int min, int max)

void	setProgressValue (int value)

void	taskCancelled ()
	< Signal emitted when the task is cancelled More...

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

void	cancelTask (int taskId)
	Cancel a task. More...

	ProgressViewerTaskWidget (QWidget *parent, bool hideToolBar, std::string message="", std::string iconName="")
	Default constructor. More...

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

void	setMessage (const std::string &message)

void	setTask (te::common::TaskProgress *task)

void	setTotalValues (int taskId)
	Set task total steps. More...

void	updateMessage (int taskId)
	Update the progress message. More...

void	updateValue (int taskId)
	Update the progress evaluation. More...

virtual	~ProgressViewerTaskWidget ()
	Virtual destructor. More...

Protected Slots
virtual void	cancel ()
	Get the button clicked and cancel ALL tasks. More...

virtual void	onResetProgress ()

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

virtual void	onSetProgressRange (int min, int max)

virtual void	onSetProgressValue (int value)

Protected Attributes
QToolButton *	m_button
	GUI Objects used to build the custom widget. More...

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

QGridLayout *	m_frameGridLayout
	GUI Objects used to build the custom widget. More...

QLabel *	m_label
	GUI Objects used to build the custom widget. More...

QGridLayout *	m_mainGridLayout
	GUI Objects used to build the custom widget. More...

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

QProgressBar *	m_progressBar
	GUI Objects used to build the custom widget. More...

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

te::common::TaskProgress *	m_task
	Task object. More...

int	m_taskId
	Task Identifier. More...

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

int	m_viewerId

Detailed Description

A progress viewer for a unique task.

Definition at line 58 of file ProgressViewerTaskWidget.h.

Constructor & Destructor Documentation

◆ ProgressViewerTaskWidget()

te::qt::widgets::ProgressViewerTaskWidget::ProgressViewerTaskWidget	(	QWidget *	parent,
		bool	hideToolBar,
		std::string	message = `""`,
		std::string	iconName = `""`
	)

Default constructor.

◆ ~ProgressViewerTaskWidget()

virtual te::qt::widgets::ProgressViewerTaskWidget::~ProgressViewerTaskWidget ( )

virtual

Virtual destructor.

Member Function Documentation

◆ addTask()

void te::qt::widgets::ProgressViewerTaskWidget::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::ProgressViewerTaskWidget::cancel ( )

protectedvirtualslot

Get the button clicked and cancel ALL tasks.

◆ cancelTask()

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

virtual

Cancel a task.

Parameters

taskId Task identifier.

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

◆ onResetProgress

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

protectedvirtualslot

◆ onSetProgressMessage

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

protectedvirtualslot

◆ onSetProgressRange

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

protectedvirtualslot

◆ onSetProgressValue

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

protectedvirtualslot

◆ removeTask()

void te::qt::widgets::ProgressViewerTaskWidget::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

◆ setMessage()

void te::qt::widgets::ProgressViewerTaskWidget::setMessage ( const std::string & message )

◆ 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

◆ setTask()

void te::qt::widgets::ProgressViewerTaskWidget::setTask ( te::common::TaskProgress * task )

◆ setTotalValues()

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

virtual

Set task total steps.

Parameters

taskId Task identifier.

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

◆ taskCancelled

void te::qt::widgets::ProgressViewerTaskWidget::taskCancelled ( )

signal

< Signal emitted when the task is cancelled

◆ updateMessage()

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

virtual

Update the progress message.

Parameters

taskId Task identifier.

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

◆ updateValue()

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

virtual

Update the progress evaluation.

Parameters

taskId Task identifier.

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

Member Data Documentation

◆ m_button

QToolButton* te::qt::widgets::ProgressViewerTaskWidget::m_button

protected

GUI Objects used to build the custom widget.

Definition at line 144 of file ProgressViewerTaskWidget.h.

◆ m_currentStep

int te::qt::widgets::ProgressViewerTaskWidget::m_currentStep

protected

Attribute used to define the current steps of all task.

Definition at line 139 of file ProgressViewerTaskWidget.h.

◆ m_frameGridLayout

QGridLayout* te::qt::widgets::ProgressViewerTaskWidget::m_frameGridLayout

protected

GUI Objects used to build the custom widget.

Definition at line 146 of file ProgressViewerTaskWidget.h.

◆ m_label

QLabel* te::qt::widgets::ProgressViewerTaskWidget::m_label

protected

GUI Objects used to build the custom widget.

Definition at line 147 of file ProgressViewerTaskWidget.h.

◆ m_mainGridLayout

QGridLayout* te::qt::widgets::ProgressViewerTaskWidget::m_mainGridLayout

protected

GUI Objects used to build the custom widget.

Definition at line 145 of file ProgressViewerTaskWidget.h.

◆ m_message

std::string te::qt::widgets::ProgressViewerTaskWidget::m_message

protected

Attribute used to define dialog message.

Definition at line 141 of file ProgressViewerTaskWidget.h.

◆ m_progressBar

QProgressBar* te::qt::widgets::ProgressViewerTaskWidget::m_progressBar

protected

GUI Objects used to build the custom widget.

Definition at line 143 of file ProgressViewerTaskWidget.h.

◆ m_propStep

int te::qt::widgets::ProgressViewerTaskWidget::m_propStep

protected

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

Definition at line 140 of file ProgressViewerTaskWidget.h.

◆ m_task

te::common::TaskProgress* te::qt::widgets::ProgressViewerTaskWidget::m_task

protected

Task object.

Definition at line 142 of file ProgressViewerTaskWidget.h.

◆ m_taskId

int te::qt::widgets::ProgressViewerTaskWidget::m_taskId

protected

Task Identifier.

Definition at line 137 of file ProgressViewerTaskWidget.h.

◆ m_totalSteps

int te::qt::widgets::ProgressViewerTaskWidget::m_totalSteps

protected

Attribute used to define the total steps of all tasks.

Definition at line 138 of file ProgressViewerTaskWidget.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/ProgressViewerTaskWidget.h

Signals

Public Member Functions

Protected Slots

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgressViewerTaskWidget()

◆ ~ProgressViewerTaskWidget()

Member Function Documentation

◆ addTask()

◆ cancel

◆ cancelTask()

◆ onResetProgress

◆ onSetProgressMessage

◆ onSetProgressRange

◆ onSetProgressValue

◆ removeTask()

◆ resetProgress

◆ setMessage()

◆ setProgressMessage

◆ setProgressRange

◆ setProgressValue

◆ setTask()

◆ setTotalValues()

◆ taskCancelled

◆ updateMessage()

◆ updateValue()

Member Data Documentation

◆ m_button

◆ m_currentStep

◆ m_frameGridLayout

◆ m_label

◆ m_mainGridLayout

◆ m_message

◆ m_progressBar

◆ m_propStep

◆ m_task

◆ m_taskId

◆ m_totalSteps

◆ m_viewerId