---
name: "tlp_PluginProgress"
section: "3tulip"
platform: "linux"
package: "tulip-doc"
version: "3.1.2-2.3"
release: "Debian 6.0 (Squeeze)"
platforms: ["linux"]
url: "https://new.carta.tech/tlp_PluginProgress"
---

# tlp\_PluginProgress(3tulip)

## NAME

tlp::PluginProgress -

## SYNOPSIS

`#include <PluginProgress.h>`

### Public Member Functions

**PluginProgress** ()\
 virtual **~PluginProgress** ()\
 **ProgressState** **progress** (int step, int max\_step)\
 void **cancel** ()\
 void **stop** ()\
 bool **isPreviewMode** () const \
 void **setPreviewMode** (bool)\
 virtual void **showPreview** (bool)\
 **ProgressState** **state** () const \
 std::string **getError** ()\
 void **setError** (std::string error)\
 virtual void **setComment** (std::string msg)\
 virtual void **progress\_handler** (int step, int max\_step)\

## Constructor & Destructor Documentation

### tlp::PluginProgress::PluginProgress ()

### virtual tlp::PluginProgress::~PluginProgress ()` [virtual]`

## Member Function Documentation

### void tlp::PluginProgress::cancel ()

### std::string tlp::PluginProgress::getError ()` [inline]`

### bool tlp::PluginProgress::isPreviewMode () const

### ProgressState tlp::PluginProgress::progress (int step, int max\_step)

### virtual void tlp::PluginProgress::progress\_handler (int step, int max\_step)` [virtual]`

### virtual void tlp::PluginProgress::setComment (std::string msg)` [inline, virtual]`

### void tlp::PluginProgress::setError (std::string error)` [inline]`

### void tlp::PluginProgress::setPreviewMode (bool)

### virtual void tlp::PluginProgress::showPreview (bool)` [virtual]`

### ProgressState tlp::PluginProgress::state () const

### void tlp::PluginProgress::stop ()

## Author

Generated automatically by Doxygen for Tulip Graph Library from the source code.