This class is a tool allowing to manage opening/closing
scopes in the ProgressIndicator in convenient and safe way.
Its main features are:
More...
#include <Message_ProgressSentry.hxx>
Public Member Functions |
DEFINE_STANDARD_ALLOC | Message_ProgressSentry (const Handle< Message_ProgressIndicator > &PI, const Standard_CString name, const Standard_Real min, const Standard_Real max, const Standard_Real step, const Standard_Boolean isInf=Standard_False, const Standard_Real newScopeSpan=0.0) |
| Message_ProgressSentry (const Handle< Message_ProgressIndicator > &PI, const Handle< TCollection_HAsciiString > &name, const Standard_Real min, const Standard_Real max, const Standard_Real step, const Standard_Boolean isInf=Standard_False, const Standard_Real newScopeSpan=0.0) |
| Creates an instance of ProgressSentry attaching it to
the specified ProgressIndicator, selects parameters of
the current scale, and opens a new scope with specified
span (equal to step by default)
|
void | Relieve () |
| Moves progress indicator to the end of the current scale
and relieves sentry from its duty. Methods other than Show()
will do nothing after this one is called.
|
| ~Message_ProgressSentry () |
void | Next (const Standard_CString name=0) const |
void | Next (const Standard_Real span, const Standard_CString name=0) const |
void | Next (const Standard_Real span, const Handle< TCollection_HAsciiString > &name) const |
| Closes current scope and opens next one
with either specified or default span
|
Standard_Boolean | More () const |
| Returns False if ProgressIndicator signals UserBreak
|
void | Show () const |
| Forces update of progress indicator display
|
Detailed Description
- Set all parameters for the current scale on the given
ProgressIndicator and open a new scope at one line
- Iterator-like interface to opening next scopes and
check for user break
- Automatic scope closing in destructor
- Safe for NULL ProgressIndicator (just does nothing)
Constructor & Destructor Documentation
Member Function Documentation
The documentation for this class was generated from the following file: