#include <ProgressDisplay.h>
Public Member Functions | |
| virtual | ~ProgressDisplay () |
| void | setMessage (const std::string &message, const std::string &filename="") |
| sets the message to given string | |
| void | taskFinished () |
| call when a task has finished and the status message should be cleared | |
| bool | updateDisplay () |
| updates the display, return true, if update was successful, false if cancel was pressed | |
| bool | updateDisplay (const std::string &message) |
| bool | updateDisplayValue () |
| void | setMaximum (int newMaximum) |
| sets the new maximum value of the progress value | |
| bool | wasCancelled () |
| return true, if process should be canceled by user e.g. | |
Protected Member Functions | |
| ProgressDisplay (int maximum=0) | |
| constructor | |
| virtual void | updateProgressDisplay ()=0 |
| Template method, updates the display. | |
Protected Attributes | |
| bool | m_canceled |
| std::string | m_message |
| std::string | m_filename |
| int | m_maximum |
| int | m_progress |
Detailed Description
Definition at line 41 of file ProgressDisplay.h.
Constructor & Destructor Documentation
◆ ProgressDisplay()
|
inlineexplicitprotected |
constructor
Definition at line 45 of file ProgressDisplay.h.
◆ ~ProgressDisplay()
|
inlinevirtual |
Definition at line 48 of file ProgressDisplay.h.
Member Function Documentation
◆ setMaximum()
sets the new maximum value of the progress value
Definition at line 64 of file ProgressDisplay.cpp.
References m_maximum, m_progress, and threshold().
◆ setMessage()
| void AppBase::ProgressDisplay::setMessage | ( | const std::string & | message, |
| const std::string & | filename = "" |
||
| ) |
sets the message to given string
Definition at line 31 of file ProgressDisplay.cpp.
References m_filename, m_message, threshold(), and updateProgressDisplay().
Referenced by HuginBase::Nona::TiffMultiLayerRemapper< ImageType, AlphaImageType >::finalizeOutputFile(), HuginBase::ImageCache::getImage(), HuginBase::ImageCache::getSmallImage(), HuginBase::Nona::MultiImageRemapper< ImageType, AlphaType >::prepareOutputFile(), HuginBase::Nona::TiffMultiLayerRemapper< ImageType, AlphaImageType >::prepareOutputFile(), HuginBase::Nona::MultiImageRemapper< ImageType, AlphaType >::saveRemapped(), HuginBase::Nona::WeightedStitcher< ImageType, AlphaType >::stitch(), HuginBase::Nona::SimpleStitcher< ImageType, AlphaType >::stitch(), HuginBase::Nona::WeightedStitcher< ImageType, AlphaType >::stitch(), HuginBase::Nona::SimpleStitcher< ImageType, AlphaType >::stitch(), HuginBase::Nona::ReduceStitcher< ImageType, AlphaType >::stitch(), taskFinished(), and updateDisplay().
◆ taskFinished()
| void AppBase::ProgressDisplay::taskFinished | ( | ) |
call when a task has finished and the status message should be cleared
Definition at line 38 of file ProgressDisplay.cpp.
References setMessage().
Referenced by HuginBase::Nona::MultiImageRemapper< ImageType, AlphaType >::finalizeOutputFile(), HuginBase::Nona::TiffMultiLayerRemapper< ImageType, AlphaImageType >::finalizeOutputFile(), HuginBase::ImageCache::getImage(), HuginBase::ImageCache::getSmallImage(), HuginBase::Nona::MultiImageRemapper< ImageType, AlphaType >::stitch(), and HuginBase::Nona::SimpleStitcher< ImageType, AlphaType >::stitch().
◆ updateDisplay() [1/2]
| bool AppBase::ProgressDisplay::updateDisplay | ( | ) |
updates the display, return true, if update was successful, false if cancel was pressed
Definition at line 43 of file ProgressDisplay.cpp.
References m_canceled.
◆ updateDisplay() [2/2]
Definition at line 48 of file ProgressDisplay.cpp.
References m_canceled, setMessage(), and threshold().
◆ updateDisplayValue()
| bool AppBase::ProgressDisplay::updateDisplayValue | ( | ) |
Definition at line 54 of file ProgressDisplay.cpp.
References m_canceled, m_maximum, m_progress, and updateProgressDisplay().
◆ updateProgressDisplay()
Template method, updates the display.
You should override this method with your code of updating the display.
Implemented in ProgressReporterDialog, LensCalFrame, MainFrame, PreviewFrame, ToolboxFrame, AppBase::DummyProgressDisplay, and AppBase::StreamProgressDisplay.
Referenced by setMessage(), and updateDisplayValue().
◆ wasCancelled()
| bool AppBase::ProgressDisplay::wasCancelled | ( | ) |
return true, if process should be canceled by user e.g.
user pressed cancel button
Definition at line 73 of file ProgressDisplay.cpp.
References m_canceled.
Member Data Documentation
◆ m_canceled
|
protected |
Definition at line 70 of file ProgressDisplay.h.
Referenced by updateDisplay(), updateDisplay(), ProgressReporterDialog::updateDisplay(), updateDisplayValue(), ProgressReporterDialog::updateProgressDisplay(), and wasCancelled().
◆ m_filename
|
protected |
Definition at line 72 of file ProgressDisplay.h.
Referenced by setMessage(), LensCalFrame::updateProgressDisplay(), PreviewFrame::updateProgressDisplay(), ToolboxFrame::updateProgressDisplay(), and AppBase::StreamProgressDisplay::updateProgressDisplay().
◆ m_maximum
|
protected |
Definition at line 73 of file ProgressDisplay.h.
Referenced by setMaximum(), and updateDisplayValue().
◆ m_message
|
protected |
Definition at line 71 of file ProgressDisplay.h.
Referenced by setMessage(), LensCalFrame::updateProgressDisplay(), MainFrame::updateProgressDisplay(), PreviewFrame::updateProgressDisplay(), ToolboxFrame::updateProgressDisplay(), and AppBase::StreamProgressDisplay::updateProgressDisplay().
◆ m_progress
|
protected |
Definition at line 74 of file ProgressDisplay.h.
Referenced by setMaximum(), updateDisplayValue(), and ProgressReporterDialog::updateProgressDisplay().
The documentation for this class was generated from the following files:
- hugin_base/appbase/ProgressDisplay.h
- hugin_base/appbase/ProgressDisplay.cpp
