src/Xw/Xw_MarkMap.cdl

   1 -- Created on: 1995-01-17
   2 -- Created by: GG
   3 -- Copyright (c) 1995-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 class MarkMap from Xw inherits Transient
  23
  24         ---Version: 0.0
  25
  26         ---Purpose: This class defines a MarkMap object.
  27
  28         ---Keywords:
  29         ---Warning:
  30         ---References:
  31
  32 uses
  33
  34         MarkMap         from Aspect,
  35         MarkMapEntry    from Aspect,
  36         MarkerStyle     from Aspect
  37
  38 raises
  39
  40         MarkMapDefinitionError  from Aspect,
  41         BadAccess               from Aspect
  42
  43 is
  44
  45         Create
  46         returns mutable MarkMap from Xw
  47         is protected ;
  48         ---Level: Internal
  49
  50         Create ( Connexion : CString from Standard )
  51         returns mutable MarkMap from Xw
  52         ---Level: Public
  53         ---Purpose: Creates a MarkMap with unallocated MarkMapEntry.
  54         --  Warning: Raises if MarkMap creation failed according
  55         --          to the supported hardware
  56         raises MarkMapDefinitionError from Aspect ;
  57
  58         SetEntry ( me : mutable ;
  59                    anEntry : MarkMapEntry from Aspect )
  60         ---Level: Public
  61         ---Purpose: Modifies an entry already defined or Add the Entry
  62         --          in the marker map <me> if it don't exist.
  63         --  Warning: Raises if MarkMap size is exceeded,
  64         --          or MarkMap is not defined properly,
  65         --          or MarkMapEntry Index is out of range according
  66         --          to the supported hardware
  67         raises BadAccess from Aspect is virtual;
  68
  69         SetEntries ( me : mutable ;
  70                      aMarkmap : MarkMap from Aspect )
  71         ---Level: Public
  72         ---Purpose: Modifies all entries from a new Markmap
  73         --  Warning: Raises if MarkMap size is exceeded,
  74         --          or MarkMap is not defined properly,
  75         --          or One of new MarkMapEntry Index is out of range according
  76         --          to the supported hardware
  77         raises BadAccess from Aspect is virtual;
  78
  79         Destroy ( me : mutable ) is virtual;
  80         ---Level: Public
  81         ---Purpose: Destroies the Markmap
  82         ---C++: alias ~
  83
  84         ----------------------------
  85         -- Category: Inquire methods
  86         ----------------------------
  87
  88         FreeMarkers ( me )
  89         returns Integer from Standard
  90         ---Level: Public
  91         ---Purpose: Returns the Number of Free Marks in the Typemap
  92         --          depending of the HardWare
  93         --  Warning: Raises if MarkMap is not defined properly
  94         raises BadAccess from Aspect is static;
  95
  96         ExtendedMarkMap ( me )
  97         returns Address from Standard
  98         is static protected ;
  99         ---Level: Internal
 100         ---Purpose: Returns extended data markermap structure pointer.
 101         ---Category: Inquire methods
 102
 103
 104 fields
 105
 106         MyExtendedDisplay       : Address from Standard ;
 107         MyExtendedMarkMap       : Address from Standard ;
 108
 109 end MarkMap ;