summaryrefslogtreecommitdiff
path: root/inc/Message_ProgressScale.hxx
blob: 2b717abb781520bea56075e09e4310cfde8b8e88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Message_ProgressScale_HeaderFile
#define _Message_ProgressScale_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
class TCollection_HAsciiString;


//! Internal data structure for scale in ProgressIndicator <br>
class Message_ProgressScale  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Creates scale ranged from 0 to 100 with step 1 <br>
  Standard_EXPORT   Message_ProgressScale();
  
        void SetName(const Standard_CString theName) ;
  //! Sets scale name <br>
        void SetName(const Handle(TCollection_HAsciiString)& theName) ;
  //! Gets scale name <br>
//!          Name may be Null handle if not set <br>
        Handle_TCollection_HAsciiString GetName() const;
  //! Sets minimum value of scale <br>
        void SetMin(const Standard_Real theMin) ;
  //! Gets minimum value of scale <br>
        Standard_Real GetMin() const;
  //! Sets minimum value of scale <br>
        void SetMax(const Standard_Real theMax) ;
  //! Gets minimum value of scale <br>
        Standard_Real GetMax() const;
  //! Set both min and max <br>
        void SetRange(const Standard_Real min,const Standard_Real max) ;
  //! Sets default step <br>
        void SetStep(const Standard_Real theStep) ;
  //! Gets default step <br>
        Standard_Real GetStep() const;
  //! Sets flag for infinite scale <br>
        void SetInfinite(const Standard_Boolean theInfinite = Standard_True) ;
  //! Gets flag for infinite scale <br>
        Standard_Boolean GetInfinite() const;
  //! Set all scale parameters <br>
        void SetScale(const Standard_Real min,const Standard_Real max,const Standard_Real step,const Standard_Boolean theInfinite = Standard_True) ;
  //! Defines span occupied by the scale on the basis scale <br>
        void SetSpan(const Standard_Real first,const Standard_Real last) ;
  
        Standard_Real GetFirst() const;
  //! Return information on span occupied by the scale on the base scale <br>
        Standard_Real GetLast() const;
  
  Standard_EXPORT     Standard_Real LocalToBase(const Standard_Real val) const;
  //! Convert value from this scale to base one and back <br>
  Standard_EXPORT     Standard_Real BaseToLocal(const Standard_Real val) const;





protected:





private:



Handle_TCollection_HAsciiString myName;
Standard_Real myMin;
Standard_Real myMax;
Standard_Real myStep;
Standard_Boolean myInfinite;
Standard_Real myFirst;
Standard_Real myLast;


};


#include <Message_ProgressScale.lxx>



// other Inline functions and methods (like "C++: function call" methods)


#endif