tools/DFBrowserPaneXDE/DFBrowserPaneXDE_AttributePaneCreator.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 DFBrowserPaneXDE_ATTRIBUTEPANECREATOR_H
  17 #define DFBrowserPaneXDE_ATTRIBUTEPANECREATOR_H
  18
  19 #include <inspector/DFBrowserPane_AttributePaneCreatorAPI.hxx>
  20
  21 #include <Standard.hxx>
  22 #include <Standard_Macro.hxx>
  23
  24 class DFBrowserPane_AttributePaneAPI;
  25
  26 //! \class DFBrowserPaneXDE_AttributePaneCreator
  27 //! \brief This class can creates attribute pane for XDE attribute name.
  28 //! It creates the following panes:
  29 //! - custom panes for XCAFDoc attributes own panes
  30 //! - extended panes (modified short information) for several types of attribute (use AttributeCommonPane)
  31 //! - common panes described in DFBrowserPane library
  32 class DFBrowserPaneXDE_AttributePaneCreator : public DFBrowserPane_AttributePaneCreatorAPI
  33 {
  34 public:
  35
  36   //! Constructor
  37   Standard_EXPORT DFBrowserPaneXDE_AttributePaneCreator (DFBrowserPane_AttributePaneCreatorAPI* theStandardPaneCreator);
  38
  39   //! Destructor
  40   virtual ~DFBrowserPaneXDE_AttributePaneCreator() Standard_OVERRIDE {}
  41
  42   //! Creates attribute panes for XCAFDoc attributes, extended and common panes from DFBrowserPane library
  43   //! \param theAttributeName a type of attribute
  44   //! \return an attribute pane if it can be created for this type
  45   Standard_EXPORT virtual DFBrowserPane_AttributePaneAPI* CreateAttributePane
  46     (Standard_CString theAttributeName) Standard_OVERRIDE;
  47
  48 protected:
  49
  50   //! Cretates pane for XCAFDoc attribute name
  51   //! \param theAttributeName a type of attribute
  52   //! \return an attribute pane if it can be created for this type
  53   DFBrowserPane_AttributePaneAPI* createXDEPane (Standard_CString theAttributeName);
  54
  55 private:
  56
  57   DFBrowserPane_AttributePaneCreatorAPI* myStandardPaneCreator; //! pane creator for panes from DFBrowserPane library
  58 };
  59
  60 #endif