src/DDF/DDF.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     Feb 10 1997     Creation
  21
  22
  23
  24 package DDF
  25
  26         ---Purpose: Provides facilities to manipulate data framework
  27         --          in a Draw-Commands environment.
  28
  29 uses
  30
  31     Standard,
  32     Draw,
  33     TCollection,
  34     TDF
  35
  36 is
  37
  38     -- ----------------------------------------------------------------------
  39     -- Classes
  40     -- ----------------------------------------------------------------------
  41
  42     class Data;
  43
  44     class Browser;
  45
  46     class Transaction;
  47
  48     class TransactionStack
  49         instantiates List from TCollection (Transaction from DDF);
  50
  51     -- ----------------------------------------------------------------------
  52     -- Package methods
  53     -- ----------------------------------------------------------------------
  54
  55
  56     GetDF (Name     : in out CString from Standard;
  57            DF       : in out Data    from TDF;
  58            Complain : in     Boolean from Standard = Standard_True)
  59     returns Boolean;
  60         ---Purpose: Search in draw  directory the framewok  identified
  61         --          by its name <Name>. returns True if found. In that
  62         --          case <DF> is setted.
  63
  64
  65     FindLabel (DF      : in     Data    from TDF;
  66               Entry    : in     CString from Standard;
  67               Label    : in out Label   from TDF;
  68               Complain : in     Boolean from Standard = Standard_True)
  69     returns Boolean;
  70         ---Purpose: Search in <DF>  the label identified by its  entry
  71         --          <Entry>.  returns  <True> if  found. In  that case
  72         --          <Label> is setted.
  73
  74     AddLabel (DF      : in     Data    from TDF;
  75               Entry   : in     CString from Standard;
  76               Label   : in out Label   from TDF)
  77     returns  Boolean;
  78         ---Purpose : Search in <DF> the  label identified by its entry
  79         --         <Entry>.   if label doesn't  exist, create  and add
  80         --         the Label in <DF>. In that case return True.
  81
  82
  83     Find (DF       : in     Data      from TDF;
  84           Entry    : in     CString   from Standard;
  85           ID       : in     GUID      from Standard;
  86           A        : in out Attribute from TDF;
  87           Complain : Boolean from Standard = Standard_True)
  88     returns Boolean;
  89         ---Purpose: Search   in <DF> the  attribute  identified by its
  90         --          <ID> and its <entry>.  returns <True> if found. In
  91         --          that case A is setted.
  92
  93
  94     ReturnLabel(theCommands : in out Interpretor from Draw; L : Label from TDF)
  95     returns Interpretor from Draw;
  96         ---C++: return &
  97
  98     -- ----------------------------------------------------------------------
  99     -- Commands
 100     -- ----------------------------------------------------------------------
 101
 102     AllCommands   (theCommands : in out Interpretor from Draw);
 103
 104
 105     BasicCommands (theCommands : in out Interpretor from Draw);
 106         ---Purpose : Basic commands.
 107
 108     DataCommands (theCommands : in out Interpretor from Draw);
 109         ---Purpose : Data framework commands
 110         --           create, clear & copy.
 111
 112     TransactionCommands (theCommands : in out Interpretor from Draw);
 113         ---Purpose : open commit abort a transaction
 114         --           undo facilities.
 115
 116     BrowserCommands (theCommands : in out Interpretor from Draw);
 117         ---Purpose : Browser commands .
 118
 119 end DDF;
 120
 121
 122