src/DDF/DDF_Browser.cdl

   1 -- Created by: DAUTRY Philippe
   2 -- Copyright (c) 1997-1999 Matra Datavision
   3 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20 --              ---------------
  21
  22 ---Version:     0.0
  23 --Version       Date            Purpose
  24 --              0.0     Oct  3 1997     Creation
  25
  26
  27 class Browser from DDF inherits Drawable3D from Draw
  28
  29         ---Purpose: Browses a data framework.
  30
  31 uses
  32
  33     Data                from TDF,
  34     Label               from TDF,
  35     AttributeIndexedMap from TDF,
  36     Interpretor         from Draw,
  37     Display             from Draw,
  38     AsciiString         from TCollection
  39
  40 -- raises
  41
  42 is
  43
  44     Create  (aDF : Data from TDF)
  45     returns mutable Browser from DDF;
  46
  47
  48     DrawOn (me; dis : in out Display);
  49
  50
  51     Copy (me)
  52     returns mutable Drawable3D from Draw
  53     is redefined;
  54
  55     Dump (me; S : in out OStream)
  56     is redefined;
  57
  58     Whatis (me; I : in out Interpretor from Draw)
  59     is redefined;
  60
  61     -- Specific methods -------------------------------------------------------
  62
  63     Data (me : mutable; aDF : Data from TDF);
  64
  65     Data (me)
  66     returns Data from TDF;
  67
  68     OpenRoot(me)
  69         returns AsciiString from TCollection;
  70         ---Purpose: Returns a string composed with the sub-label
  71         --          entries of <myDF>.
  72
  73     OpenLabel(me; aLab : Label from TDF)
  74         returns AsciiString from TCollection;
  75         ---Purpose: Returns a string composed with the sub-label
  76         --          entries of <aLab>.
  77
  78     OpenAttributeList(me : mutable;
  79                       aLab : Label from TDF)
  80         returns AsciiString from TCollection;
  81         ---Purpose: Returns a string composed with the attribute index
  82         --          (found in <myAttMap>) of <aLab>.
  83
  84     OpenAttribute(me : mutable;
  85                   anIndex : Integer from Standard = 0)
  86         returns AsciiString from TCollection;
  87         ---Purpose: Returns a string composed with the list of
  88         --          referenced attribute index of the attribute
  89         --          <anIndex>. For exemple, it is usefull for
  90         --          TDataStd_Group. It uses a mecanism based on a
  91         --          DDF_AttributeBrowser.
  92
  93     Information(me)
  94         returns AsciiString from TCollection;
  95         ---Purpose: Returns information about <me> to be displayed in
  96         --          information window.
  97
  98     Information(me; aLab : Label from TDF)
  99         returns AsciiString from TCollection;
 100         ---Purpose: Returns information about <aLab> to be displayed
 101         --          in information window.
 102
 103     Information(me; anIndex : Integer from Standard = 0)
 104         returns AsciiString from TCollection;
 105         ---Purpose: Returns information about attribute <anIndex> to
 106         --          be displayed in information window.
 107
 108
 109 fields
 110
 111     myDF     : Data from TDF;
 112     myAttMap : AttributeIndexedMap from TDF;
 113
 114 end Browser;