include/opencascade/DDataStd_TreeBrowser.hxx

0001 // Created by: DAUTRY Philippe
0002 // Copyright (c) 1997-1999 Matra Datavision
0003 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _DDataStd_TreeBrowser_HeaderFile
0017 #define _DDataStd_TreeBrowser_HeaderFile
0018
0019 #include <Standard.hxx>
0020
0021 #include <TDF_Label.hxx>
0022 #include <Draw_Drawable3D.hxx>
0023 #include <Standard_OStream.hxx>
0024 #include <Draw_Interpretor.hxx>
0025 class Draw_Display;
0026 class TCollection_AsciiString;
0027 class TDataStd_TreeNode;
0028
0029 //! Browses a TreeNode from TDataStd.
0030 //! =================================
0031 class DDataStd_TreeBrowser : public Draw_Drawable3D
0032 {
0033
0034 public:
0035   Standard_EXPORT DDataStd_TreeBrowser(const TDF_Label& root);
0036
0037   Standard_EXPORT void DrawOn(Draw_Display& dis) const override;
0038
0039   Standard_EXPORT occ::handle<Draw_Drawable3D> Copy() const override;
0040
0041   Standard_EXPORT void Dump(Standard_OStream& S) const override;
0042
0043   //! Specific methods
0044   //! ================
0045   Standard_EXPORT void Whatis(Draw_Interpretor& I) const override;
0046
0047   Standard_EXPORT void Label(const TDF_Label& root);
0048
0049   Standard_EXPORT TDF_Label Label() const;
0050
0051   //! Returns a string composed with the TreeNode of
0052   //! <myLabel>.
0053   Standard_EXPORT TCollection_AsciiString OpenRoot() const;
0054
0055   //! Returns a string composed with the sub-TreeNodes of
0056   //! <L>
0057   Standard_EXPORT TCollection_AsciiString OpenNode(const TDF_Label& L) const;
0058
0059   DEFINE_STANDARD_RTTIEXT(DDataStd_TreeBrowser, Draw_Drawable3D)
0060
0061 private:
0062   //! Returns a string composed with the sub-TreeNodes
0063   //! of <aTreeNode>. Used to implement other methods.
0064   Standard_EXPORT void OpenNode(const occ::handle<TDataStd_TreeNode>& aTreeNode,
0065                                 TCollection_AsciiString&              aList) const;
0066
0067   TDF_Label myRoot;
0068 };
0069
0070 #endif // _DDataStd_TreeBrowser_HeaderFile