src/ModelHighAPI/ModelHighAPI_Folder.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
  22 #define SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include <ModelHighAPI_Interface.h>
  26
  27 #include <memory>
  28 //--------------------------------------------------------------------------------------
  29 class ModelAPI_Document;
  30 class ModelAPI_Folder;
  31 class ModelHighAPI_Selection;
  32 //--------------------------------------------------------------------------------------
  33 /**\class ModelHighAPI_Folder
  34  * \ingroup CPPHighAPI
  35  * \brief Class for filling ModelAPI_Folder
  36  */
  37 class ModelHighAPI_Folder
  38 {
  39 public:
  40   /// Constructor for a folder
  41   MODELHIGHAPI_EXPORT
  42   explicit ModelHighAPI_Folder(const std::shared_ptr<ModelAPI_Folder> & theFolder);
  43   /// Destructor
  44   MODELHIGHAPI_EXPORT virtual ~ModelHighAPI_Folder();
  45 };
  46
  47 //--------------------------------------------------------------------------------------
  48 /**\ingroup CPPHighAPI
  49  * \brief Create Folder feature
  50  */
  51 MODELHIGHAPI_EXPORT
  52 std::shared_ptr<ModelHighAPI_Folder> addFolder(const std::shared_ptr<ModelAPI_Document>& theDoc);
  53 //--------------------------------------------------------------------------------------
  54 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_FOLDER_H_ */