0025266: Debug statements in the source are getting flushed on to the console
[occt.git] / src / IFSelect / IFSelect_IntParam.cdl
CommitLineData
b311480e 1-- Created on: 1992-11-30
2-- Created by: Christian CAILLET
3-- Copyright (c) 1992-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class IntParam from IFSelect inherits TShared
18
19 ---Purpose : This class simply allows to access an Integer value through a
20 -- Handle, as a String can be (by using HString).
21 -- Hence, this value can be accessed : read and modified, without
22 -- passing through the specific object which detains it. Thus,
23 -- parameters of a Selection or a Dispatch (according its type)
24 -- can be controlled directly from the ShareOut which contains them
25 --
26 -- Additionnaly, an IntParam can be bound to a Static.
27 -- Remember that for a String, binding is immediate, because the
28 -- string value of a Static is a HAsciiString, it then suffices
29 -- to get its Handle.
30 -- For an Integer, an IntParam can designate (by its name) a
31 -- Static : each time its value is required or set, the Static
32 -- is aknowledged
33
34uses Integer, CString, AsciiString
35
36is
37
6e33d3ce 38 Create returns IntParam;
7fd59977 39 ---Purpose : Creates an IntParam. Initial value is set to zer
40
41 SetStaticName (me : mutable; statname : CString);
42 ---Purpose : Commands this IntParam to be bound to a Static
43 -- Hence, Value will return the value if this Static if it is set
44 -- Else, Value works on the locally stored value
45 -- SetValue also will set the value of the Static
46 -- This works only for a present static of type integer or enum
47 -- Else, it is ignored
48 --
49 -- If <statname> is empty, disconnects the IntParam from Static
50
51 StaticName (me) returns CString;
52 ---Purpose : Returns the name of static parameter to which this IntParam
53 -- is bound, empty if none
54
55 Value (me) returns Integer is static;
56 ---Purpose : Reads Integer Value of the IntParam. If a StaticName is
57 -- defined and the Static is set, looks in priority the value
58 -- of the static
59
60 SetValue (me : mutable; val : Integer) is static;
61 ---Purpose : Sets a new Integer Value for the IntParam. If a StaticName is
62 -- defined and the Static is set, also sets the value of the static
63
64fields
65
66 theval : Integer;
67 thestn : AsciiString;
68
69end IntParam;