src/HYDROGUI/HYDROGUI_Tool.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROGUI_TOOL_H
  24 #define HYDROGUI_TOOL_H
  25
  26 #include <HYDROData_Object.h>
  27
  28 #include <GraphicsView_Defs.h>
  29
  30 #include <TCollection_AsciiString.hxx>
  31 #include <TCollection_ExtendedString.hxx>
  32 #include <TCollection_HAsciiString.hxx>
  33 #include <TCollection_HExtendedString.hxx>
  34
  35 class SUIT_ViewManager;
  36
  37 class HYDROGUI_DataModel;
  38 class HYDROGUI_Module;
  39 class HYDROGUI_Prs;
  40
  41 /**
  42  * \class HYDROGUI_Tool
  43  * \brief This class contains several useful methods.
  44  */
  45 class HYDROGUI_Tool
  46 {
  47 public:
  48   /**
  49    * \brief Convert \a TCollection_AsciiString to \a QString
  50    */
  51   static QString                                  ToQString( const TCollection_AsciiString& );
  52
  53   /**
  54    * \brief Convert \a TCollection_ExtendedString to \a QString
  55    */
  56   static QString                                  ToQString( const TCollection_ExtendedString& );
  57
  58   /**
  59    * \brief Convert \a Handle_TCollection_HAsciiString to \a QString
  60    */
  61   static QString                                  ToQString( const Handle(TCollection_HAsciiString)& );
  62
  63   /**
  64    * \brief Convert \a Handle_TCollection_HExtendedString to \a QString
  65    */
  66   static QString                                  ToQString( const Handle(TCollection_HExtendedString)& );
  67
  68   /**
  69    * \brief Convert \a QString to \a TCollection_AsciiString
  70    */
  71   static TCollection_AsciiString                  ToAsciiString( const QString& );
  72
  73   /**
  74    * \brief Convert \a QString to \a TCollection_ExtendedString
  75    */
  76   static TCollection_ExtendedString               ToExtString( const QString& );
  77
  78   /**
  79    * \brief Convert \a QString to \a Handle_TCollection_HAsciiString
  80    */
  81   static Handle(TCollection_HAsciiString)         ToHAsciiString( const QString& );
  82
  83   /**
  84    * \brief Convert \a QString to \a Handle_TCollection_HExtendedString
  85    */
  86   static Handle(TCollection_HExtendedString)      ToHExtString( const QString& );
  87
  88   /**
  89    * \brief Set the specified view manager to be active on the desktop.
  90    * \param theModule module
  91    * \param theViewManager view manager
  92    */
  93   static void                     SetActiveViewManager( HYDROGUI_Module* theModule,
  94                                                         SUIT_ViewManager* theViewManager );
  95
  96   /**
  97    * \brief Get sub-objects to build presentations.
  98    * \param theModel data model
  99    * \param theViewerId viewer id
 100    * \param theSeq sequence of sub-objects
 101    */
 102   static void                     GetPrsSubObjects( const HYDROGUI_DataModel* theModel,
 103                                                     const int theViewerId,
 104                                                     HYDROData_SequenceOfObjects& theSeq );
 105
 106   /**
 107    * \brief Get presentation built for specified data object.
 108    * \param theObj data object
 109    * \param theObjects list of existing presentations
 110    * \return presentation
 111    */
 112   static HYDROGUI_Prs*            GetPresentation( const Handle(HYDROData_Object)& theObj,
 113                                                    const GraphicsView_ObjectList& theObjects );
 114 };
 115
 116 #endif