Base::EmptySequencer Class Reference
This special sequencer might be useful if you want to suppress any indication of the progress to the user. More...
#include <Sequencer.h>
Public Member Functions | |
| EmptySequencer () | |
| construction More... | |
| ~EmptySequencer () | |
| Destruction. More... | |
 Public Member Functions inherited from Base::SequencerBase | |
| virtual void checkAbort () | |
| Check if the operation is aborted by user. More... | |
| virtual bool isBlocking () const | |
| Returns true if the running sequencer is blocking any user input. More... | |
| bool isLocked () const | |
| Returns true if the sequencer was locked, false otherwise. More... | |
| bool isRunning () const | |
| Returns true if the sequencer is running, otherwise returns false. More... | |
| bool setLocked (bool bLock) | |
| If bLock is true then the sequencer gets locked. More... | |
| bool wasCanceled () const | |
| Returns true if the pending operation was canceled. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Base::SequencerBase | |
| static SequencerBase & Instance () | |
| Returns the last created sequencer instance. More... | |
| Protected Member Functions inherited from Base::SequencerBase | |
| bool next (bool canAbort=false) | |
| Performs the next step and returns true if the operation is not yet finished. More... | |
| virtual void nextStep (bool canAbort) | |
| This method can be reimplemented in sub-classes to give the user a feedback when the next is performed. More... | |
| size_t numberOfSteps () const | |
| Returns the number of steps. More... | |
| virtual void pause () | |
| Breaks the sequencer if needed. More... | |
| int progressInPercent () const | |
| Returns the current state of progress in percent. More... | |
| void rejectCancel () | |
| If you tried to cancel but then decided to continue the operation. More... | |
| virtual void resetData () | |
| Resets internal data. More... | |
| virtual void resume () | |
| Continues with progress. More... | |
| SequencerBase () | |
| construction More... | |
| virtual void setProgress (size_t) | |
| Sets the progress indicator to a certain position. More... | |
| virtual void setText (const char *pszTxt) | |
| Sets a text what the pending operation is doing. More... | |
| bool start (const char *pszStr, size_t steps) | |
| Starts a new operation, returns false if there is already a pending operation, otherwise it returns true. More... | |
| virtual void startStep () | |
| This method can be reimplemented in sub-classes to give the user a feedback when a new sequence starts. More... | |
| bool stop () | |
| Stops the sequencer if all operations are finished. More... | |
| void tryToCancel () | |
| Try to cancel the pending operation(s). More... | |
| virtual ~SequencerBase () | |
| Destruction. More... | |
| Protected Attributes inherited from Base::SequencerBase | |
| size_t nProgress | |
| Stores the current amount of progress. More... | |
| size_t nTotalSteps | |
| Stores the total number of steps. More... | |
Detailed Description
This special sequencer might be useful if you want to suppress any indication of the progress to the user.
Constructor & Destructor Documentation
◆ EmptySequencer()
| EmptySequencer::EmptySequencer | ( | ) |
construction
◆ ~EmptySequencer()
| EmptySequencer::~EmptySequencer | ( | ) |
Destruction.
The documentation for this class was generated from the following files:
- src/Base/Sequencer.h
- src/Base/Sequencer.cpp
