refs #426: grammatic error

[modules/hydro.git] / src / HYDROGUI / HYDROGUI_Tool.h

diff --git a/src/HYDROGUI/HYDROGUI_Tool.h b/src/HYDROGUI/HYDROGUI_Tool.h
index 5b5908657847dc7dfd2dc109afc665d87140564d..e1565e72f930c724ba82f3510da735d026e23120 100644 (file)
--- a/src/HYDROGUI/HYDROGUI_Tool.h
+++ b/src/HYDROGUI/HYDROGUI_Tool.h
@@ -33,7 +33,12 @@
 #include <TCollection_HAsciiString.hxx>
 #include <TCollection_HExtendedString.hxx>
 
+// IDL includes
+#include <SALOMEconfig.h>
+#include CORBA_SERVER_HEADER(GEOM_Gen)
+
 class SUIT_ViewManager;
+class OCCViewer_ViewFrame;
 
 class HYDROGUI_DataModel;
 class HYDROGUI_Module;
@@ -111,6 +116,14 @@ public:
                                                         SUIT_ViewManager* theViewManager );
 
   /**
+   * \brief Returns TRUE if object can be shown on the viewer.
+   * \param theObject data model object to check
+   * \param theViewerType viewer type
+   */
+  static bool                     IsObjectHasPresentation( const Handle(HYDROData_Entity)& theObject,
+                                                           const QString&                  theViewerType = "" );
+
+/**
    * \brief Get sub-objects to build presentations.
    * \param theModule module
    * \param theSeq sequence of sub-objects
@@ -165,9 +178,11 @@ public:
   /**
    * \brief Get the selected GEOM objects.
    * \param theModule module
+   * \param theTypes the acceptable GEOM object types
    * \return list of GEOM objects entries
    */
-  static QStringList GetSelectedGeomObjects( HYDROGUI_Module* theModule );
+  static QStringList GetSelectedGeomObjects( HYDROGUI_Module* theModule,
+                                             QList<GEOM::shape_type> theTypes );
 
   /**
    * \brief Find the data object with the specified name.
@@ -196,11 +211,13 @@ public:
    * \param theModule module
    * \param thePrefix name prefix
    * \param theUsedNames list of already used names
+   * \param theIsTryToUsePurePrefix if true - the prefix will be returned if the name equal to the prefix is not busy
    * \return generated name
    */
   static QString                  GenerateObjectName( HYDROGUI_Module*   theModule,
                                                       const QString&     thePrefix,
-                                                      const QStringList& theUsedNames = QStringList() );
+                                                      const QStringList& theUsedNames = QStringList(),
+                                                      const bool         theIsTryToUsePurePrefix = false );
 
   /**
    * \brief Get id of the active view.
@@ -238,13 +255,33 @@ public:
    */
   static QList<size_t>            GetOCCViewIdList( HYDROGUI_Module* theModule );
 
+
   /**
-   * \brief Get the list of references (recursively) for the specified image object
-   * \param theImage image data object
+   * \brief Change OCC viewer action visibility.
+   * \param theViewFrame OCC viewer frame
+   * \param theActionId an action index, which state should be changed
+   * \param isShown the action visibility state
+   */
+  static void                     setOCCActionShown( OCCViewer_ViewFrame* theViewFrame,
+                                                     const int theActionId,
+                                                     const bool isShown );
+
+  /**
+   * \brief Change OCC viewer action visibility for all opened views.
+   * \param theActionId an action index, which state should be changed
+   * \param isShown the action visibility state
+   */
+  static void                     setOCCActionShown( HYDROGUI_Module* theModule,
+                                                     const int theActionId,
+                                                     const bool isShown );
+
+  /**
+   * \brief Get the list of references (recursively) for the specified data object
+   * \param theObj data object
    * \param theRefObjects list of reference objects
    * \param theRefNames list of reference object names
    */
-  static void                     GetObjectReferences( const Handle(HYDROData_Image)& theImage,
+  static void                     GetObjectReferences( const Handle(HYDROData_Entity)& theObj,
                                                        HYDROData_SequenceOfObjects& theRefObjects,
                                                        QStringList& theRefNames );
 
@@ -252,13 +289,19 @@ public:
    * \brief Get the list of back-references for the specified object
    * \param theModule module
    * \param theObj data object
-   * \param theBackRefObjects list of back-reference objects
-   * \param theBackRefNames list of back-reference object names
+   * \return list of back-reference objects
    */
-  static void                     GetObjectBackReferences( HYDROGUI_Module* theModule,
-                                                           const Handle(HYDROData_Entity)& theObj,
-                                                           HYDROData_SequenceOfObjects& theBackRefObjects,
-                                                           QStringList& theBackRefNames );
+  static HYDROData_SequenceOfObjects GetObjectBackReferences( HYDROGUI_Module*                theModule,
+                                                              const Handle(HYDROData_Entity)& theObj );
+
+  /**
+   * \brief Get the map of back-references for the specified list of objects
+   * \param theModule module
+   * \param theObjectNames names of objects
+   * \return map of back-reference objects
+   */
+  static QMap<QString,HYDROData_SequenceOfObjects> GetObjectsBackReferences( HYDROGUI_Module*   theModule,
+                                                                             const QStringList& theObjectNames );
 
   /**
    * \brief Get father dock window for widget 
@@ -293,6 +336,13 @@ public:
    */
   static QStringList              FindExistingObjectsNames( const Handle(HYDROData_Document)& theDoc, 
                                                             const ObjectKind theObjectKind );
+
+  /**
+   * \brief Converts coordinate value to string.
+   * \param theNumber coordinate as a number
+   * \return coordinate as a string
+   */
+  static QString                  GetCoordinateString( const double theNumber, bool isInLocale );
 };
 
 #endif