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...

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 Member Functions
void	customEvent (QEvent *e)
	Used to receive custom progress events. More...

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...

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

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

Default constructor.

Definition at line 38 of file ProgressViewerWidget.cpp.

References te::at::Light, m_MainLayout, m_scroll, m_widget, and m_widgetLayout.

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

virtual

Virtual destructor.

Definition at line 60 of file ProgressViewerWidget.cpp.

Member Function Documentation

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.

Definition at line 64 of file ProgressViewerWidget.cpp.

References te::common::TaskProgress::getMessage(), and te::common::TaskProgress::getTotalSteps().

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.

Definition at line 157 of file ProgressViewerWidget.cpp.

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

virtual

Cancel a task.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Definition at line 84 of file ProgressViewerWidget.cpp.

void te::qt::widgets::ProgressViewerWidget::customEvent ( QEvent * e )

protected

Used to receive custom progress events.

Parameters

e	Event sent to this object.

Definition at line 123 of file ProgressViewerWidget.cpp.

References te::qt::widgets::CreateProgressWidgetItemEvent::m_label, te::qt::widgets::RemoveProgressWidgetItemEvent::m_taskId, te::qt::widgets::CreateProgressWidgetItemEvent::m_taskId, te::qt::widgets::CreateProgressWidgetItemEvent::m_totalSteps, te::qt::widgets::ProgressWidgetItem::setLabel(), te::qt::widgets::RemoveProgressWidgetItemEvent::type(), and te::qt::widgets::CreateProgressWidgetItemEvent::type().

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

virtual

Removes a task from progress viewer container.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Definition at line 72 of file ProgressViewerWidget.cpp.

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

virtual

Set task total steps.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Definition at line 89 of file ProgressViewerWidget.cpp.

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

virtual

Update the progress message.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Definition at line 108 of file ProgressViewerWidget.cpp.

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

virtual

Update the progress evaluation.

Parameters

taskId Task identifier.

Implements te::common::AbstractProgressViewer.

Definition at line 93 of file ProgressViewerWidget.cpp.

Member Data Documentation

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

protected

Custom widget progress item container.

Definition at line 145 of file ProgressViewerWidget.h.

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

protected

GUI Objects used to build the custom widget.

Definition at line 146 of file ProgressViewerWidget.h.

Referenced by ProgressViewerWidget().

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

protected

GUI Objects used to build the custom widget.

Definition at line 148 of file ProgressViewerWidget.h.

Referenced by ProgressViewerWidget().

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

protected

Task container.

Definition at line 144 of file ProgressViewerWidget.h.

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

protected

GUI Objects used to build the custom widget.

Definition at line 149 of file ProgressViewerWidget.h.

Referenced by ProgressViewerWidget().

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

protected

GUI Objects used to build the custom widget.

Definition at line 147 of file ProgressViewerWidget.h.

Referenced by ProgressViewerWidget().

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

C:/TL5_2015_release/terralib5/src/terralib/qt/widgets/progress/ProgressViewerWidget.h
C:/TL5_2015_release/terralib5/src/terralib/qt/widgets/progress/ProgressViewerWidget.cpp

Public Slots

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation