0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / AIS / AIS_LocalStatus.cdl
CommitLineData
b311480e 1-- Created on: 1997-01-20
2-- Created by: Robert COUBLANC
3-- Copyright (c) 1997-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
b7c077b9 17class LocalStatus from AIS inherits TShared from MMgt
7fd59977 18
19 ---Purpose: Stored Info about temporary objects.
20uses
21 ListOfInteger from TColStd,
22 NameOfColor from Quantity
23is
24
25 Create(IsTemporary : Boolean from Standard = Standard_True;
26 Decompose : Boolean from Standard = Standard_False;
27 DisplayMode : Integer from Standard = -1;
28 SelectionMode : Integer from Standard = -1;
29 HilightMode : Integer from Standard = 0;
30 SubIntensity : Boolean from Standard = 0;
31 TheHiCol : NameOfColor from Quantity = Quantity_NOC_WHITE)
6e33d3ce 32 returns LocalStatus from AIS;
7fd59977 33
34
35
36 ---Category: Read
37
38 Decomposed(me) returns Boolean from Standard;
39 ---C++: inline
40 IsTemporary(me) returns Boolean from Standard;
41 ---C++: inline
42 DisplayMode(me) returns Integer from Standard;
43 ---C++: inline
44 SelectionModes(me) returns ListOfInteger from TColStd;
45 ---C++: return const&
46 ---C++: inline
47 IsActivated(me; aSelMode :Integer from Standard)
48 returns Boolean from Standard;
49 HilightMode(me) returns Integer from Standard;
50 ---C++: inline
51 IsSubIntensityOn(me) returns Boolean from Standard;
52 ---C++: inline
53 HilightColor(me) returns NameOfColor from Quantity;
54 ---C++: inline
55
56
57 SetDecomposition (me:mutable; astatus : Boolean from Standard);
58 ---C++: inline
59 SetTemporary (me:mutable; astatus : Boolean from Standard);
60 ---C++: inline
61 SetDisplayMode (me:mutable; aMode : Integer from Standard);
62 ---C++: inline
63 SetFirstDisplay (me:mutable; aStatus : Boolean from Standard) ;
64 ---C++: inline
65 IsFirstDisplay(me) returns Boolean from Standard;
66 ---C++: inline
67
68 AddSelectionMode (me:mutable; aMode : Integer from Standard);
69
70 RemoveSelectionMode(me:mutable; aMode : Integer from Standard);
71
72 ClearSelectionModes(me:mutable);
73
74 IsSelModeIn(me;aMode:Integer from Standard)
75 returns Boolean from Standard;
76
77 SetHilightMode (me:mutable; aMode : Integer from Standard);
78 ---C++: inline
79 SetHilightColor (me:mutable;aHiCol:NameOfColor from Quantity);
80 ---C++: inline
81 SubIntensityOn (me:mutable);
82 ---C++: inline
83 SubIntensityOff (me:mutable);
84 ---C++: inline
85
86
87 SetPreviousState(me:mutable;aStatus : Transient from Standard);
88 ---C++: inline
89 PreviousState(me) returns any Transient from Standard;
90 ---C++: inline
91 ---C++: return const &
92
93fields
94 myDecomposition : Boolean from Standard;
95 myIsTemporary : Boolean from Standard;
96 myDMode : Integer from Standard;
97 myFirstDisplay : Boolean from Standard;
98 myHMode : Integer from Standard;
99 mySModes : ListOfInteger from TColStd;
100 mySubIntensity : Boolean from Standard;
101 myHiCol : NameOfColor from Quantity;
102
103 myPreviousState : Transient from Standard;
104
105end LocalStatus;