Open CASCADE Technology
7.1.0.beta
|
Internal data structure for scale in ProgressIndicator. More...
#include <Message_ProgressScale.hxx>
Public Member Functions | |
Message_ProgressScale () | |
Creates scale ranged from 0 to 100 with step 1. More... | |
void | SetName (const Standard_CString theName) |
void | SetName (const Handle< TCollection_HAsciiString > &theName) |
Sets scale name. More... | |
Handle< TCollection_HAsciiString > | GetName () const |
Gets scale name Name may be Null handle if not set. More... | |
void | SetMin (const Standard_Real theMin) |
Sets minimum value of scale. More... | |
Standard_Real | GetMin () const |
Gets minimum value of scale. More... | |
void | SetMax (const Standard_Real theMax) |
Sets minimum value of scale. More... | |
Standard_Real | GetMax () const |
Gets minimum value of scale. More... | |
void | SetRange (const Standard_Real min, const Standard_Real max) |
Set both min and max. More... | |
void | SetStep (const Standard_Real theStep) |
Sets default step. More... | |
Standard_Real | GetStep () const |
Gets default step. More... | |
void | SetInfinite (const Standard_Boolean theInfinite=Standard_True) |
Sets flag for infinite scale. More... | |
Standard_Boolean | GetInfinite () const |
Gets flag for infinite scale. More... | |
void | SetScale (const Standard_Real min, const Standard_Real max, const Standard_Real step, const Standard_Boolean theInfinite=Standard_True) |
Set all scale parameters. More... | |
void | SetSpan (const Standard_Real first, const Standard_Real last) |
Defines span occupied by the scale on the basis scale. More... | |
Standard_Real | GetFirst () const |
Standard_Real | GetLast () const |
Return information on span occupied by the scale on the base scale. More... | |
Standard_Real | LocalToBase (const Standard_Real val) const |
Standard_Real | BaseToLocal (const Standard_Real val) const |
Convert value from this scale to base one and back. More... | |
Internal data structure for scale in ProgressIndicator.
Basically it defines three things:
NOTE: There is no special protection against bad input data like min > max etc. except cases when it can cause exception
Message_ProgressScale::Message_ProgressScale | ( | ) |
Creates scale ranged from 0 to 100 with step 1.
Standard_Real Message_ProgressScale::BaseToLocal | ( | const Standard_Real | val | ) | const |
Convert value from this scale to base one and back.
Standard_Real Message_ProgressScale::GetFirst | ( | ) | const |
Standard_Boolean Message_ProgressScale::GetInfinite | ( | ) | const |
Gets flag for infinite scale.
Standard_Real Message_ProgressScale::GetLast | ( | ) | const |
Return information on span occupied by the scale on the base scale.
Standard_Real Message_ProgressScale::GetMax | ( | ) | const |
Gets minimum value of scale.
Standard_Real Message_ProgressScale::GetMin | ( | ) | const |
Gets minimum value of scale.
Handle< TCollection_HAsciiString > Message_ProgressScale::GetName | ( | ) | const |
Gets scale name Name may be Null handle if not set.
Standard_Real Message_ProgressScale::GetStep | ( | ) | const |
Gets default step.
Standard_Real Message_ProgressScale::LocalToBase | ( | const Standard_Real | val | ) | const |
void Message_ProgressScale::SetInfinite | ( | const Standard_Boolean | theInfinite = Standard_True | ) |
Sets flag for infinite scale.
void Message_ProgressScale::SetMax | ( | const Standard_Real | theMax | ) |
Sets minimum value of scale.
void Message_ProgressScale::SetMin | ( | const Standard_Real | theMin | ) |
Sets minimum value of scale.
void Message_ProgressScale::SetName | ( | const Standard_CString | theName | ) |
void Message_ProgressScale::SetName | ( | const Handle< TCollection_HAsciiString > & | theName | ) |
Sets scale name.
void Message_ProgressScale::SetRange | ( | const Standard_Real | min, |
const Standard_Real | max | ||
) |
Set both min and max.
void Message_ProgressScale::SetScale | ( | const Standard_Real | min, |
const Standard_Real | max, | ||
const Standard_Real | step, | ||
const Standard_Boolean | theInfinite = Standard_True |
||
) |
Set all scale parameters.
void Message_ProgressScale::SetSpan | ( | const Standard_Real | first, |
const Standard_Real | last | ||
) |
Defines span occupied by the scale on the basis scale.
void Message_ProgressScale::SetStep | ( | const Standard_Real | theStep | ) |
Sets default step.