te::qt::widgets::AbstractQtProgressViewer Class Reference

A class that defines the interface of an abstract qt progress viewer. More...

#include <AbstractQtProgressViewer.h>

Inheritance diagram for te::qt::widgets::AbstractQtProgressViewer:

Signals
void	resetProgress ()
void	setProgressMessage (const std::string &message)
void	setProgressRange (int min, int max)
void	setProgressValue (int value)

Public Member Functions
	AbstractQtProgressViewer (QWidget *parent)
	Default constructor. More...
virtual void	addTask (te::common::TaskProgress *t, int id)=0
	Insert a new task in the progress viewer. More...
virtual void	cancelTask (int taskId)=0
	Cancel a task. More...
virtual void	removeTask (int taskId)=0
	Removes a task from progress viewer container. More...
virtual void	setTotalValues (int taskId)=0
	Set task total steps. More...
virtual void	updateMessage (int taskId)=0
	Update the progress message. More...
virtual void	updateValue (int taskId)=0
	Update the progress evaluation. More...
	~AbstractQtProgressViewer ()
	Virtual destructor. More...

Protected Slots
virtual void	onResetProgress ()=0
virtual void	onSetProgressMessage (const std::string &message)=0
virtual void	onSetProgressRange (int min, int max)=0
virtual void	onSetProgressValue (int value)=0

Protected Attributes
int	m_viewerId

Detailed Description

A class that defines the interface of an abstract qt progress viewer.

Definition at line 50 of file AbstractQtProgressViewer.h.

Constructor & Destructor Documentation

AbstractQtProgressViewer()

te::qt::widgets::AbstractQtProgressViewer::AbstractQtProgressViewer

(

QWidget *

parent

)

Default constructor.

~AbstractQtProgressViewer()

te::qt::widgets::AbstractQtProgressViewer::~AbstractQtProgressViewer

(

)

Virtual destructor.

Member Function Documentation

addTask()

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

pure virtual

Insert a new task in the progress viewer.

Parameters

t	Task pointer.
id	Task identifier.

Note

The Progress Viewer will NOT take the ownership of TaskProgress (t).

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, and te::qt::widgets::ProgressViewerTaskWidget.

cancelTask()

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

pure virtual

Cancel a task.

Parameters

taskId

Task identifier.

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, and te::qt::widgets::ProgressViewerTaskWidget.

onResetProgress

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

protectedpure virtualslot

onSetProgressMessage

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

protectedpure virtualslot

onSetProgressRange

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

protectedpure virtualslot

onSetProgressValue

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

protectedpure virtualslot

removeTask()

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

pure virtual

Removes a task from progress viewer container.

Parameters

taskId

Task identifier.

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, and te::qt::widgets::ProgressViewerTaskWidget.

resetProgress

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

signal

setProgressMessage

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

signal

setProgressRange

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

signal

setProgressValue

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

signal

setTotalValues()

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

pure virtual

Set task total steps.

Parameters

taskId

Task identifier.

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, and te::qt::widgets::ProgressViewerTaskWidget.

updateMessage()

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

pure virtual

Update the progress message.

Parameters

taskId

Task identifier.

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerBar, and te::qt::widgets::ProgressViewerTaskWidget.

updateValue()

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

pure virtual

Update the progress evaluation.

Parameters

taskId

Task identifier.

Implements te::common::AbstractProgressViewer.

Implemented in te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerBar, and te::qt::widgets::ProgressViewerTaskWidget.

Member Data Documentation

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/AbstractQtProgressViewer.h