0031939: Coding - correction of spelling errors in comments [part 4]
[occt.git] / src / IFSelect / IFSelect_IntParam.hxx
1 // Created on: 1992-11-30
2 // Created by: Christian CAILLET
3 // Copyright (c) 1992-1999 Matra Datavision
4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
5 //
6 // This file is part of Open CASCADE Technology software library.
7 //
8 // This library is free software; you can redistribute it and/or modify it under
9 // the terms of the GNU Lesser General Public License version 2.1 as published
10 // by the Free Software Foundation, with special exception defined in the file
11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
12 // distribution for complete text of the license and disclaimer of any warranty.
13 //
14 // Alternatively, this file may be used under the terms of Open CASCADE
15 // commercial license or contractual agreement.
16
17 #ifndef _IFSelect_IntParam_HeaderFile
18 #define _IFSelect_IntParam_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_Type.hxx>
22
23 #include <Standard_Integer.hxx>
24 #include <TCollection_AsciiString.hxx>
25 #include <Standard_Transient.hxx>
26 #include <Standard_CString.hxx>
27
28 class IFSelect_IntParam;
29 DEFINE_STANDARD_HANDLE(IFSelect_IntParam, Standard_Transient)
30
31 //! This class simply allows to access an Integer value through a
32 //! Handle, as a String can be (by using HString).
33 //! Hence, this value can be accessed : read and modified, without
34 //! passing through the specific object which detains it. Thus,
35 //! parameters of a Selection or a Dispatch (according its type)
36 //! can be controlled directly from the ShareOut which contains them
37 //!
38 //! Additionally, an IntParam can be bound to a Static.
39 //! Remember that for a String, binding is immediate, because the
40 //! string value of a Static is a HAsciiString, it then suffices
41 //! to get its Handle.
42 //! For an Integer, an IntParam can designate (by its name) a
43 //! Static : each time its value is required or set, the Static
44 //! is aknowledged
45 class IFSelect_IntParam : public Standard_Transient
46 {
47
48 public:
49
50   //! Creates an IntParam. Initial value is set to zer
51   Standard_EXPORT IFSelect_IntParam();
52   
53   //! Commands this IntParam to be bound to a Static
54   //! Hence, Value will return the value if this Static if it is set
55   //! Else, Value works on the locally stored value
56   //! SetValue also will set the value of the Static
57   //! This works only for a present static of type integer or enum
58   //! Else, it is ignored
59   //!
60   //! If <statname> is empty, disconnects the IntParam from Static
61   Standard_EXPORT void SetStaticName (const Standard_CString statname);
62   
63   //! Returns the name of static parameter to which this IntParam
64   //! is bound, empty if none
65   Standard_EXPORT Standard_CString StaticName() const;
66   
67   //! Reads Integer Value of the IntParam. If a StaticName is
68   //! defined and the Static is set, looks in priority the value
69   //! of the static
70   Standard_EXPORT Standard_Integer Value() const;
71   
72   //! Sets a new Integer Value for the IntParam. If a StaticName is
73   //! defined and the Static is set, also sets the value of the static
74   Standard_EXPORT void SetValue (const Standard_Integer val);
75
76
77   DEFINE_STANDARD_RTTIEXT(IFSelect_IntParam,Standard_Transient)
78
79 private:
80
81   Standard_Integer theval;
82   TCollection_AsciiString thestn;
83
84 };
85
86 #endif // _IFSelect_IntParam_HeaderFile