src/DDF/DDF_Browser.cdl

   1 -- Created by: DAUTRY Philippe
   2 -- Copyright (c) 1997-1999 Matra Datavision
   3 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   4 --
   5 -- This file is part of Open CASCADE Technology software library.
   6 --
   7 -- This library is free software; you can redistribute it and/or modify it under
   8 -- the terms of the GNU Lesser General Public License version 2.1 as published
   9 -- by the Free Software Foundation, with special exception defined in the file
  10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  11 -- distribution for complete text of the license and disclaimer of any warranty.
  12 --
  13 -- Alternatively, this file may be used under the terms of Open CASCADE
  14 -- commercial license or contractual agreement.
  15
  16 --              ---------------
  17
  18 ---Version:     0.0
  19 --Version       Date            Purpose
  20 --              0.0     Oct  3 1997     Creation
  21
  22
  23 class Browser from DDF inherits Drawable3D from Draw
  24
  25         ---Purpose: Browses a data framework.
  26
  27 uses
  28
  29     Data                from TDF,
  30     Label               from TDF,
  31     AttributeIndexedMap from TDF,
  32     Interpretor         from Draw,
  33     Display             from Draw,
  34     AsciiString         from TCollection
  35
  36 -- raises
  37
  38 is
  39
  40     Create  (aDF : Data from TDF)
  41     returns mutable Browser from DDF;
  42
  43
  44     DrawOn (me; dis : in out Display);
  45
  46
  47     Copy (me)
  48     returns mutable Drawable3D from Draw
  49     is redefined;
  50
  51     Dump (me; S : in out OStream)
  52     is redefined;
  53
  54     Whatis (me; I : in out Interpretor from Draw)
  55     is redefined;
  56
  57     -- Specific methods -------------------------------------------------------
  58
  59     Data (me : mutable; aDF : Data from TDF);
  60
  61     Data (me)
  62     returns Data from TDF;
  63
  64     OpenRoot(me)
  65         returns AsciiString from TCollection;
  66         ---Purpose: Returns a string composed with the sub-label
  67         --          entries of <myDF>.
  68
  69     OpenLabel(me; aLab : Label from TDF)
  70         returns AsciiString from TCollection;
  71         ---Purpose: Returns a string composed with the sub-label
  72         --          entries of <aLab>.
  73
  74     OpenAttributeList(me : mutable;
  75                       aLab : Label from TDF)
  76         returns AsciiString from TCollection;
  77         ---Purpose: Returns a string composed with the attribute index
  78         --          (found in <myAttMap>) of <aLab>.
  79
  80     OpenAttribute(me : mutable;
  81                   anIndex : Integer from Standard = 0)
  82         returns AsciiString from TCollection;
  83         ---Purpose: Returns a string composed with the list of
  84         --          referenced attribute index of the attribute
  85         --          <anIndex>. For exemple, it is usefull for
  86         --          TDataStd_Group. It uses a mecanism based on a
  87         --          DDF_AttributeBrowser.
  88
  89     Information(me)
  90         returns AsciiString from TCollection;
  91         ---Purpose: Returns information about <me> to be displayed in
  92         --          information window.
  93
  94     Information(me; aLab : Label from TDF)
  95         returns AsciiString from TCollection;
  96         ---Purpose: Returns information about <aLab> to be displayed
  97         --          in information window.
  98
  99     Information(me; anIndex : Integer from Standard = 0)
 100         returns AsciiString from TCollection;
 101         ---Purpose: Returns information about attribute <anIndex> to
 102         --          be displayed in information window.
 103
 104
 105 fields
 106
 107     myDF     : Data from TDF;
 108     myAttMap : AttributeIndexedMap from TDF;
 109
 110 end Browser;