src/Xw/Xw_WidthMap.cdl

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