tools/DFBrowser/DFBrowser_Tools.hxx

   1 // Created on: 2017-06-16
   2 // Created by: Natalia ERMOLAEVA
   3 // Copyright (c) 2017 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 #ifndef DFBrowser_Tools_H
  17 #define DFBrowser_Tools_H
  18
  19 #include <inspector/TreeModel_ItemBase.hxx>
  20
  21 #include <Standard.hxx>
  22 #include <Standard_GUID.hxx>
  23 #include <TDocStd_Document.hxx>
  24 #include <TDF_Label.hxx>
  25 #include <TDF_Attribute.hxx>
  26 #include <TopoDS_Shape.hxx>
  27
  28 #include <QAbstractItemModel>
  29 #include <QColor>
  30 #include <QMap>
  31 #include <QModelIndex>
  32 #include <QPixmap>
  33 #include <QString>
  34 #include <QIcon>
  35
  36 class DFBrowserPane_AttributePaneAPI;
  37
  38 //! \namespace DFBrowser_Tools
  39 //! The namespace that gives auxiliary methods for TDF elements manipulation
  40 namespace DFBrowser_Tools
  41 {
  42
  43   //! Returns true if the label is not root, has attribute or at least one sub-label with attribute
  44   //! \param theLabel a label
  45   //! \return boolean result
  46   Standard_EXPORT bool IsEmptyLabel (const TDF_Label& theLabel);
  47
  48   //! Returns the label entry
  49   //! \param isUseShortInfo boolean value if value of name attribute should be included to result
  50   //! \return string value
  51   Standard_EXPORT QString GetLabelInfo (const TDF_Label& theLabel, const bool isUseShortInfo = true);
  52
  53   //! Returns the label icon
  54   Standard_EXPORT QIcon GetLabelIcon (const TDF_Label& theLabel, bool isStandard16x16 = true);
  55 }
  56
  57 #endif