0024837: Visualization - revise design and implementation of connected Interactive...

[occt.git] / src / SelectMgr / SelectMgr_EntityOwner.cdl

diff --git a/src/SelectMgr/SelectMgr_EntityOwner.cdl b/src/SelectMgr/SelectMgr_EntityOwner.cdl
old mode 100755 (executable)
new mode 100644 (file)
index f9948cf..38a5ca2
--- a/src/SelectMgr/SelectMgr_EntityOwner.cdl
+++ b/src/SelectMgr/SelectMgr_EntityOwner.cdl
@@ -1,22 +1,18 @@
 -- Created on: 1995-05-23
 -- Created by: Robert COUBLANC
 -- Copyright (c) 1995-1999 Matra Datavision
--- Copyright (c) 1999-2012 OPEN CASCADE SAS
+-- Copyright (c) 1999-2014 OPEN CASCADE SAS
 --
--- The content of this file is subject to the Open CASCADE Technology Public
--- License Version 6.5 (the "License"). You may not use the content of this file
--- except in compliance with the License. Please obtain a copy of the License
--- at http://www.opencascade.org and read it completely before using this file.
+-- This file is part of Open CASCADE Technology software library.
 --
--- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
--- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
+-- This library is free software; you can redistribute it and/or modify it under
+-- the terms of the GNU Lesser General Public License version 2.1 as published
+-- by the Free Software Foundation, with special exception defined in the file
+-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+-- distribution for complete text of the license and disclaimer of any warranty.
 --
--- The Original Code and all software distributed under the License is
--- distributed on an "AS IS" basis, without warranty of any kind, and the
--- Initial Developer hereby disclaims all such warranties, including without
--- limitation, any warranties of merchantability, fitness for a particular
--- purpose or non-infringement. Please see the License for the specific terms
--- and conditions governing the rights and limitations under the License.
+-- Alternatively, this file may be used under the terms of Open CASCADE
+-- commercial license or contractual agreement.
 
 --Modified by rob October 25 97 store locations...
 --                jun 17 98 : Add virtual methods HasShape, GetShape.
@@ -46,13 +42,19 @@ raises
     NoSuchObject from Standard
 is
 
-    Create (aPriority: Integer = 0) returns mutable EntityOwner from SelectMgr;
+    Create (aPriority: Integer = 0) returns EntityOwner from SelectMgr;
        --- Purpose: Initializes the selection priority aPriority.  
     Create (aSO      : SelectableObject;
             aPriority : Integer=0)
-    returns mutable EntityOwner from SelectMgr;
+    returns EntityOwner from SelectMgr;
        ---Purpose: Constructs a framework with the selectable object
        -- anSO being attributed the selection priority aPriority.
+
+    Create (theOwner : EntityOwner from SelectMgr;
+            aPriority : Integer=0)
+      returns EntityOwner from SelectMgr;
+        ---Purpose: Constructs a framework from existing one
+        -- anSO being attributed the selection priority aPriority.
        
     HasSelectable(me) returns Boolean from Standard;
        ---Purpose: Returns true if there is a selectable object to serve as an owner.
@@ -60,7 +62,7 @@ is
     Selectable(me) returns any SelectableObject from SelectMgr
         ---Purpose: Returns a selectable object detected in the working context.
     raises NoSuchObject from Standard
-    is static;
+    is  virtual;
     
     Set(me:mutable; aSO : SelectableObject) is static;    
         ---Purpose: Sets the selectable object anSO to be used by the
@@ -128,26 +130,36 @@ is
     SetLocation(me:mutable; aLoc : Location from TopLoc) is redefined;
     ResetLocation(me:mutable) is redefined;
     Location(me) returns Location from TopLoc is redefined;
-    ---C++: return const&
-    
-    
 
     --very Internal method (to be used in selection process only...)
 
+    SetSelected(me:mutable;theIsSelected : Boolean from Standard);
+      ---C++: inline
+      ---Purpose:Set the state of the owner.
+      -- @param theIsSelected [in] shows if owner is selected.
+    IsSelected(me) returns Boolean from Standard;
+      ---C++: inline
+      ---Purpose: @return Standard_True if the owner is selected.
+
     State(me:mutable;aStatus:Integer from Standard);
-       ---C++: inline
+    ---C++: inline
+    ---Purpose:Set the state of the owner.
+    -- The method is deprecated. Use SetSelected() instead.
+
     State(me)  returns Integer from Standard;
-       ---C++: inline
+    ---C++: inline
+    -- @return 1 if the owner is selected and 0 otherwise.
+    -- The method is deprecated. Use IsSelected() instead.
 
     IsAutoHilight ( me ) returns Boolean from Standard is virtual; 
     ---Purpose: if owner is not auto hilighted, for group contains many such owners 
     --          will be called one method HilightSelected of SelectableObject 
-     
+
     IsForcedHilight ( me ) returns Boolean from Standard is virtual; 
     ---Purpose: if this method returns TRUE the owner will allways call method
     --          Hilight for SelectableObject when the owner is detected. By default 
     --          it always return FALSE.  
-    
+
     SetZLayer ( me         : mutable;
                 thePrsMgr  : PresentationManager from PrsMgr;
                 theLayerId : Integer from Standard )
@@ -157,6 +169,11 @@ is
 fields
 
     mySelectable        : SOPtr;
-    mystate             : Integer from Standard;
+
+    myIsSelected : Boolean from Standard;
+    ---Purpose: Describes selection state of this owner:
+    -- Standard_False: the owner not selected
+    -- Standard_True: the owner is selected.
+    
 
 end EntityOwner;