C3D Toolkit  Kernel - 118060, Vision - 2.15.0.1825
Public Member Functions | List of all members
IfProgressIndicator Struct Referenceabstract
C3D Modeler: The Geometric Modelling Module » Templates and Serializations Library

A run progress indicator. More...

#include <tool_progress_indicator.h>

Public Member Functions

virtual void StartProgress (ptrdiff_t minValue, ptrdiff_t maxValue, const TCHAR *lpszNewText, bool resetTxt, bool aPIcall=false)=0
 Initialization.
 
virtual void SetProgress (ptrdiff_t nCurr, const TCHAR *lpszNewText, bool resetTxt, bool aPIcall=false)=0
 Setting of the current value.
 
virtual void StopProgress (const TCHAR *lpszNewText, bool resetTxt, bool aPIcall=false)=0
 Stop the indicator.
 
virtual const TCHAR * GetStrBuild () const =0
 Get the string from the indicator.
 
virtual void StBarSetMessageText (const TCHAR *msg, bool aPIcall=false)=0
 Set the string to the indicator.
 
virtual bool IsProgressStarted () const =0
 Whether any process with indicator is run.
 

Detailed Description

A run progress indicator.

Interface of the execution progress indicator.

Note
The geometric kernel provides the thread-safe use of the progress indicator. The user is responsible for thread-safety of IfProgressIndicator internal implementation.
The documentation for this struct was generated from the following file: