/usr/include/oce/Message_ProgressScale.hxx is in liboce-foundation-dev 0.18.2-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 122 123 124 | // 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
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>
#include <Handle_TCollection_HAsciiString.hxx>
#include <Standard_Real.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_CString.hxx>
class TCollection_HAsciiString;
//! Internal data structure for scale in ProgressIndicator
//!
//! Basically it defines three things:
//! - name that can be used for generating user messages
//! - limits and characteristics of the current scale,
//! along with derived coefficients to map it into basic scale [0-1]
//! - methods for conversion of values from current scale
//! to basic one and back
//!
//! NOTE: There is no special protection against bad input data
//! like min > max etc. except cases when it can cause exception
class Message_ProgressScale
{
public:
DEFINE_STANDARD_ALLOC
//! Creates scale ranged from 0 to 100 with step 1
Standard_EXPORT Message_ProgressScale();
void SetName (const Standard_CString theName) ;
//! Sets scale name
void SetName (const Handle(TCollection_HAsciiString)& theName) ;
//! Gets scale name
//! Name may be Null handle if not set
Handle(TCollection_HAsciiString) GetName() const;
//! Sets minimum value of scale
void SetMin (const Standard_Real theMin) ;
//! Gets minimum value of scale
Standard_Real GetMin() const;
//! Sets minimum value of scale
void SetMax (const Standard_Real theMax) ;
//! Gets minimum value of scale
Standard_Real GetMax() const;
//! Set both min and max
void SetRange (const Standard_Real min, const Standard_Real max) ;
//! Sets default step
void SetStep (const Standard_Real theStep) ;
//! Gets default step
Standard_Real GetStep() const;
//! Sets flag for infinite scale
void SetInfinite (const Standard_Boolean theInfinite = Standard_True) ;
//! Gets flag for infinite scale
Standard_Boolean GetInfinite() const;
//! Set all scale parameters
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
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
Standard_Real GetLast() const;
Standard_EXPORT Standard_Real LocalToBase (const Standard_Real val) const;
//! Convert value from this scale to base one and back
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>
#endif // _Message_ProgressScale_HeaderFile
|