A class that defines the interface of a qt widget to group a set of ProgressWidgetItem. More...

#include <ProgressViewerWidget.h>

Inheritance diagram for te::qt::widgets::ProgressViewerWidget:

Public Slots
void	cancel (int id)
	This slot is connect to all cancel buttons of each progress items. More...

Signals
void	addProgressItem (int taskId, int totalSteps, QString Label)

void	removeProgressItem (int taskId)

void	resetProgress ()

void	setProgressMessage (const std::string &message)

void	setProgressRange (int min, int max)

void	setProgressValue (int value)

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

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

	ProgressViewerWidget (QWidget *parent)
	Default constructor. More...

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

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

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

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

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

Protected Slots
void	onAddProgressItem (int taskId, int totalSteps, QString Label)

void	onRemoveProgressItem (int taskId)

virtual void	onResetProgress ()

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

virtual void	onSetProgressRange (int min, int max)

virtual void	onSetProgressValue (int value)

Protected Attributes
std::map< int, ProgressWidgetItem * >	m_items
	Custom widget progress item container. More...

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

QScrollArea *	m_scroll
	GUI Objects used to build the custom widget. More...

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

int	m_viewerId

QWidget *	m_widget
	GUI Objects used to build the custom widget. More...

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

Detailed Description

A class that defines the interface of a qt widget to group a set of ProgressWidgetItem.

This viewer is made using ProgressWidgetItem. Feed back will be generated over a custom widget. Multiples tasks will be displayed using individual progress widgets

The proportional value is informed by each task.

See also: AbstractProgressViewer, QtProgressBar

Note: In this viewer, tasks can be deleted.

Definition at line 69 of file ProgressViewerWidget.h.

Constructor & Destructor Documentation

◆ ProgressViewerWidget()

te::qt::widgets::ProgressViewerWidget::ProgressViewerWidget ( QWidget * parent )

Default constructor.

◆ ~ProgressViewerWidget()

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

virtual

Virtual destructor.

Member Function Documentation

◆ addProgressItem

void te::qt::widgets::ProgressViewerWidget::addProgressItem	(	int	taskId,
		int	totalSteps,
		QString	Label
	)

signal

◆ addTask()

virtual void te::qt::widgets::ProgressViewerWidget::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::common::AbstractProgressViewer.

◆ cancel

void te::qt::widgets::ProgressViewerWidget::cancel ( int id )

slot

This slot is connect to all cancel buttons of each progress items.

Parameters

id	value used to inform what task was canceled.

◆ cancelTask()

virtual void te::qt::widgets::ProgressViewerWidget::cancelTask ( int taskId )

virtual

Cancel a task.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

◆ onAddProgressItem

void te::qt::widgets::ProgressViewerWidget::onAddProgressItem	(	int	taskId,
		int	totalSteps,
		QString	Label
	)

protectedslot

◆ onRemoveProgressItem

void te::qt::widgets::ProgressViewerWidget::onRemoveProgressItem ( int taskId )

protectedslot

◆ onResetProgress

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

protectedvirtualslot

◆ onSetProgressMessage

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

protectedvirtualslot

◆ onSetProgressRange

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

protectedvirtualslot

◆ onSetProgressValue

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

protectedvirtualslot

◆ removeProgressItem

void te::qt::widgets::ProgressViewerWidget::removeProgressItem ( int taskId )

signal

◆ removeTask()

virtual void te::qt::widgets::ProgressViewerWidget::removeTask ( int taskId )

virtual

Removes a task from progress viewer container.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

◆ resetProgress

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

signal

◆ setProgressMessage

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

signal

◆ setProgressRange

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

signal

◆ setProgressValue

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

signal

◆ setTotalValues()

virtual void te::qt::widgets::ProgressViewerWidget::setTotalValues ( int taskId )

virtual

Set task total steps.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

◆ updateMessage()

virtual void te::qt::widgets::ProgressViewerWidget::updateMessage ( int taskId )

virtual

Update the progress message.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

◆ updateValue()

virtual void te::qt::widgets::ProgressViewerWidget::updateValue ( int taskId )

virtual

Update the progress evaluation.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Member Data Documentation

◆ m_items

std::map<int, ProgressWidgetItem*> te::qt::widgets::ProgressViewerWidget::m_items

protected

Custom widget progress item container.

Definition at line 164 of file ProgressViewerWidget.h.

◆ m_MainLayout

QGridLayout* te::qt::widgets::ProgressViewerWidget::m_MainLayout

protected

GUI Objects used to build the custom widget.

Definition at line 165 of file ProgressViewerWidget.h.

◆ m_scroll

QScrollArea* te::qt::widgets::ProgressViewerWidget::m_scroll

protected

GUI Objects used to build the custom widget.

Definition at line 167 of file ProgressViewerWidget.h.

◆ m_tasks

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

protected

Task container.

Definition at line 163 of file ProgressViewerWidget.h.

◆ m_viewerId

int te::common::AbstractProgressViewer::m_viewerId

protectedinherited

Definition at line 105 of file AbstractProgressViewer.h.

◆ m_widget

QWidget* te::qt::widgets::ProgressViewerWidget::m_widget

protected

GUI Objects used to build the custom widget.

Definition at line 168 of file ProgressViewerWidget.h.

◆ m_widgetLayout

QGridLayout* te::qt::widgets::ProgressViewerWidget::m_widgetLayout

protected

GUI Objects used to build the custom widget.

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

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProgressViewerWidget()

◆ ~ProgressViewerWidget()

Member Function Documentation

◆ addProgressItem

◆ addTask()

◆ cancel

◆ cancelTask()

◆ onAddProgressItem

◆ onRemoveProgressItem

◆ onResetProgress

◆ onSetProgressMessage

◆ onSetProgressRange

◆ onSetProgressValue

◆ removeProgressItem

◆ removeTask()

◆ resetProgress

◆ setProgressMessage

◆ setProgressRange

◆ setProgressValue

◆ setTotalValues()

◆ updateMessage()

◆ updateValue()

Member Data Documentation

◆ m_items

◆ m_MainLayout

◆ m_scroll

◆ m_tasks

◆ m_viewerId

◆ m_widget

◆ m_widgetLayout