Draw_ProgressIndicator Class Reference

Implements ProgressIndicator (interface provided by Message)
for DRAW, with possibility to output to TCL window
and/or trace file

#include <Draw_ProgressIndicator.hxx>

Inheritance diagram for Draw_ProgressIndicator:
Inheritance graph
[legend]

Public Member Functions

 Draw_ProgressIndicator (const Draw_Interpretor &di, const Standard_Integer updateTime=0)
 Creates a progress indicator and remembers pointer to
Draw_Interpretor
The updateTime, if given, defines time interval between
updates of the indicator (in seconds)

void Destroy ()
 Destructor; calls Reset()

 ~Draw_ProgressIndicator ()
void SetTextMode (const Standard_Boolean theTextMode)
 Sets text output mode (on/off)

Standard_Boolean GetTextMode () const
 Gets text output mode (on/off)

void SetGraphMode (const Standard_Boolean theGraphMode)
 Sets graphical output mode (on/off)

Standard_Boolean GetGraphMode () const
 Gets graphical output mode (on/off)

virtual void Reset ()
 Clears/erases opened TCL windows if any
and sets myBreak to False

virtual Standard_Boolean Show (const Standard_Boolean force=Standard_True)
 Defines method Show of Progress Indicator

virtual Standard_Boolean UserBreak ()
 Redefines method UserBreak of Progress Indicator

Static Public Member Functions

static Standard_BooleanDefaultTextMode ()
static Standard_BooleanDefaultGraphMode ()
 Get/Set default values for output modes

static Standard_IntegerStopIndicator ()
 Internal method for implementation of UserBreak mechanism


Constructor & Destructor Documentation

Draw_ProgressIndicator::Draw_ProgressIndicator ( const Draw_Interpretor di,
const Standard_Integer  updateTime = 0 
)
Draw_ProgressIndicator::~Draw_ProgressIndicator (  )  [inline]

Member Function Documentation

static Standard_Boolean& Draw_ProgressIndicator::DefaultGraphMode (  )  [static]
static Standard_Boolean& Draw_ProgressIndicator::DefaultTextMode (  )  [static]
void Draw_ProgressIndicator::Destroy (  ) 
Standard_Boolean Draw_ProgressIndicator::GetGraphMode (  )  const
Standard_Boolean Draw_ProgressIndicator::GetTextMode (  )  const
virtual void Draw_ProgressIndicator::Reset (  )  [virtual]

Reimplemented from Message_ProgressIndicator.

void Draw_ProgressIndicator::SetGraphMode ( const Standard_Boolean  theGraphMode  ) 
void Draw_ProgressIndicator::SetTextMode ( const Standard_Boolean  theTextMode  ) 
virtual Standard_Boolean Draw_ProgressIndicator::Show ( const Standard_Boolean  force = Standard_True  )  [virtual]
static Standard_Integer& Draw_ProgressIndicator::StopIndicator (  )  [static]
virtual Standard_Boolean Draw_ProgressIndicator::UserBreak (  )  [virtual]

Reimplemented from Message_ProgressIndicator.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Thu Mar 3 10:54:06 2011 for Open CASCADE Technology by  doxygen 1.6.3