src/AIS/AIS_LocalStatus.cdl

   1 -- Created on: 1997-01-20
   2 -- Created by: Robert COUBLANC
   3 -- Copyright (c) 1997-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23 private class LocalStatus from AIS inherits TShared from MMgt
  24
  25         ---Purpose: Stored Info about temporary objects.
  26 uses
  27     ListOfInteger from TColStd,
  28     NameOfColor   from Quantity
  29 is
  30
  31     Create(IsTemporary   : Boolean from Standard = Standard_True;
  32            Decompose     : Boolean from Standard = Standard_False;
  33            DisplayMode   : Integer from Standard = -1;
  34            SelectionMode : Integer from Standard = -1;
  35            HilightMode   : Integer from Standard = 0;
  36            SubIntensity  : Boolean from Standard = 0;
  37            TheHiCol      : NameOfColor from Quantity = Quantity_NOC_WHITE)
  38      returns mutable LocalStatus from AIS;
  39
  40
  41
  42                     ---Category: Read
  43
  44     Decomposed(me) returns Boolean from Standard;
  45     ---C++: inline
  46     IsTemporary(me) returns Boolean from Standard;
  47     ---C++: inline
  48     DisplayMode(me) returns Integer from Standard;
  49     ---C++: inline
  50     SelectionModes(me) returns ListOfInteger from TColStd;
  51     ---C++: return const&
  52     ---C++: inline
  53     IsActivated(me; aSelMode :Integer from Standard)
  54     returns Boolean from Standard;
  55     HilightMode(me) returns Integer from Standard;
  56     ---C++: inline
  57     IsSubIntensityOn(me) returns Boolean from Standard;
  58     ---C++: inline
  59     HilightColor(me) returns NameOfColor from Quantity;
  60     ---C++: inline
  61
  62
  63     SetDecomposition (me:mutable; astatus : Boolean from Standard);
  64     ---C++: inline
  65     SetTemporary     (me:mutable; astatus : Boolean from Standard);
  66     ---C++: inline
  67     SetDisplayMode   (me:mutable; aMode   : Integer from Standard);
  68     ---C++: inline
  69     SetFirstDisplay  (me:mutable; aStatus :  Boolean  from  Standard) ;
  70     ---C++: inline
  71     IsFirstDisplay(me)  returns  Boolean  from  Standard;
  72     ---C++: inline
  73
  74     AddSelectionMode (me:mutable; aMode   : Integer from Standard);
  75
  76     RemoveSelectionMode(me:mutable; aMode   : Integer from Standard);
  77
  78     ClearSelectionModes(me:mutable);
  79
  80     IsSelModeIn(me;aMode:Integer from Standard)
  81     returns Boolean from Standard;
  82
  83     SetHilightMode   (me:mutable; aMode   : Integer from Standard);
  84     ---C++: inline
  85     SetHilightColor (me:mutable;aHiCol:NameOfColor from Quantity);
  86     ---C++: inline
  87     SubIntensityOn  (me:mutable);
  88     ---C++: inline
  89     SubIntensityOff (me:mutable);
  90     ---C++: inline
  91
  92
  93     SetPreviousState(me:mutable;aStatus : Transient from Standard);
  94     ---C++: inline
  95     PreviousState(me) returns any Transient from Standard;
  96     ---C++: inline
  97     ---C++: return const &
  98
  99 fields
 100     myDecomposition : Boolean       from Standard;
 101     myIsTemporary   : Boolean       from Standard;
 102     myDMode         : Integer       from Standard;
 103     myFirstDisplay  : Boolean       from  Standard;
 104     myHMode         : Integer       from Standard;
 105     mySModes        : ListOfInteger from TColStd;
 106     mySubIntensity  : Boolean       from Standard;
 107     myHiCol         : NameOfColor   from Quantity;
 108
 109     myPreviousState : Transient     from  Standard;
 110
 111 end LocalStatus;