| TerraLib 4.1

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
TeProgressBase Class Reference

A generic Progress Interface. More...

`#include <TeProgressBase.h>`

Inheritance diagram for TeProgressBase:

List of all members.

## Public Member Functions

| TeProgressBase ()
| Constructor.
virtual | ~TeProgressBase ()
| Destructor.
virtual void | setTotalSteps (int n)=0
| Sets the total number of steps to n.
virtual void | setProgress (int n)=0
| Sets the current amount of progress made to n.
virtual void | reset ()=0
| Resets the progress interface.
virtual void | cancel ()=0
| Resets the progress dialog.
virtual void | setMessage (const string &text)=0
| Sets the label's text.
virtual string | getMessage ()
| Returns the label's text.
virtual bool | wasCancelled ()=0
| Returns true whether the process was cancelled.
virtual void | setCaption (const string &cap)=0
| Sets the caption associated to the progress interface.

## Detailed Description

A generic Progress Interface.

## Constructor & Destructor Documentation

TeProgressBase::TeProgressBase | ( |  | ) | `[inline]`

Constructor.

virtual TeProgressBase::~TeProgressBase | ( |  | ) | `[inline, virtual]`

Destructor.

## Member Function Documentation

virtual void TeProgressBase::cancel | ( |  | ) | `[pure virtual]`

Resets the progress dialog.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual string TeProgressBase::getMessage | ( |  | ) | `[inline, virtual]`

Returns the label's text.

Reimplemented in TeQtProgress, and TeStdIOProgress.

virtual void TeProgressBase::reset | ( |  | ) | `[pure virtual]`

Resets the progress interface.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual void TeProgressBase::setCaption | ( | const string & | cap | ) | `[pure virtual]`

Sets the caption associated to the progress interface.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual void TeProgressBase::setMessage | ( | const string & | text | ) | `[pure virtual]`

Sets the label's text.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual void TeProgressBase::setProgress | ( | int | n | ) | `[pure virtual]`

Sets the current amount of progress made to n.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual void TeProgressBase::setTotalSteps | ( | int | n | ) | `[pure virtual]`

Sets the total number of steps to n.

Implemented in TeQtProgress, and TeStdIOProgress.

virtual bool TeProgressBase::wasCancelled | ( |  | ) | `[pure virtual]`

Returns true whether the process was cancelled.

Implemented in TeQtProgress, and TeStdIOProgress.

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

- E:/Projetos_Primeiro_Semestre_2012/TerraView/terralib/src/terralib/kernel/TeProgressBase.h

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines