te::qt::widgets::ProgressWidgetItem Class Reference

Custom widget used to represent a single task. More...

#include <ProgressWidgetItem.h>

Inheritance diagram for te::qt::widgets::ProgressWidgetItem:

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

Signals
void	resetProgress ()
void	setProgressMessage (const std::string &message)
void	setProgressRange (int min, int max)
void	setProgressValue (int value)
void	taskCanceled (int id)
	Inform that a task was canceled.

Public Member Functions
	ProgressWidgetItem (QWidget *parent, int taskId, int totalSteps, QString label)
	Default constructor.
virtual void	reset ()
	Reset the progress bar.
virtual void	setLabel (const std::string &message)
	Set the progress label information.
void	setTotalValues (int values)
	Set task total steps.
virtual void	setValue (int step)
	Set the current value in progress bar.
	~ProgressWidgetItem ()
	Virtual destructor.

Protected Slots
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.
int	m_currentStep
	Attribute used to define the current steps of all task.
QFrame *	m_frame
	GUI Objects used to build the custom widget.
QGridLayout *	m_frameGridLayout
	GUI Objects used to build the custom widget.
QLabel *	m_label
	GUI Objects used to build the custom widget.
QGridLayout *	m_mainGridLayout
	GUI Objects used to build the custom widget.
QProgressBar *	m_progressBar
	GUI Objects used to build the custom widget.
int	m_propStep
	Attribute used to define the proportional step (0-100).
int	m_taskId
	Task Identifier.
int	m_totalSteps
	Attribute used to define the total steps of all tasks.

Detailed Description

Custom widget used to represent a single task.

See also

ProgressViewerWidget

Definition at line 57 of file ProgressWidgetItem.h.

Constructor & Destructor Documentation

ProgressWidgetItem()

te::qt::widgets::ProgressWidgetItem::ProgressWidgetItem	(	QWidget *	parent,
		int	taskId,
		int	totalSteps,
		QString	label
	)

Default constructor.

~ProgressWidgetItem()

te::qt::widgets::ProgressWidgetItem::~ProgressWidgetItem

(

)

Virtual destructor.

Member Function Documentation

cancel

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

virtualslot

Get the button clicked and cancel ALL tasks.

onResetProgress

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

protectedvirtualslot

onSetProgressMessage

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

protectedvirtualslot

onSetProgressRange

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

protectedvirtualslot

onSetProgressValue

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

protectedvirtualslot

reset()

virtual void te::qt::widgets::ProgressWidgetItem::reset ( )

virtual

Reset the progress bar.

resetProgress

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

signal

setLabel()

virtual void te::qt::widgets::ProgressWidgetItem::setLabel ( const std::string &  message )

virtual

Set the progress label information.

Parameters

message

String with the label information.

setProgressMessage

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

signal

setProgressRange

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

signal

setProgressValue

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

signal

setTotalValues()

void te::qt::widgets::ProgressWidgetItem::setTotalValues

(

int

values

)

Set task total steps.

setValue()

virtual void te::qt::widgets::ProgressWidgetItem::setValue ( int  step )

virtual

Set the current value in progress bar.

Parameters

step	Step value as integer.

taskCanceled

void te::qt::widgets::ProgressWidgetItem::taskCanceled ( int  id )

signal

Inform that a task was canceled.

Parameters

id

taskId.

Member Data Documentation

m_button

QToolButton* te::qt::widgets::ProgressWidgetItem::m_button

protected

GUI Objects used to build the custom widget.

Definition at line 131 of file ProgressWidgetItem.h.

m_currentStep

int te::qt::widgets::ProgressWidgetItem::m_currentStep

protected

Attribute used to define the current steps of all task.

Definition at line 127 of file ProgressWidgetItem.h.

m_frame

QFrame* te::qt::widgets::ProgressWidgetItem::m_frame

protected

GUI Objects used to build the custom widget.

Definition at line 132 of file ProgressWidgetItem.h.

m_frameGridLayout

QGridLayout* te::qt::widgets::ProgressWidgetItem::m_frameGridLayout

protected

GUI Objects used to build the custom widget.

Definition at line 134 of file ProgressWidgetItem.h.

m_label

QLabel* te::qt::widgets::ProgressWidgetItem::m_label

protected

GUI Objects used to build the custom widget.

Definition at line 129 of file ProgressWidgetItem.h.

m_mainGridLayout

QGridLayout* te::qt::widgets::ProgressWidgetItem::m_mainGridLayout

protected

GUI Objects used to build the custom widget.

Definition at line 133 of file ProgressWidgetItem.h.

m_progressBar

QProgressBar* te::qt::widgets::ProgressWidgetItem::m_progressBar

protected

GUI Objects used to build the custom widget.

Definition at line 130 of file ProgressWidgetItem.h.

m_propStep

int te::qt::widgets::ProgressWidgetItem::m_propStep

protected

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

Definition at line 128 of file ProgressWidgetItem.h.

m_taskId

int te::qt::widgets::ProgressWidgetItem::m_taskId

protected

Task Identifier.

Definition at line 125 of file ProgressWidgetItem.h.

m_totalSteps

int te::qt::widgets::ProgressWidgetItem::m_totalSteps

protected

Attribute used to define the total steps of all tasks.

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