Salome HOME
Merge remote branch 'origin/Doc_update_ver741' into V7_5_BR
[modules/geom.git] / src / GEOMBase / GEOMBase_Helper.h
index 911d6e4436170dc2131bb1887fa348c8cf8cd474..438c3c26dd3806ad10c591a50440cc5b1a5918f0 100755 (executable)
@@ -1,44 +1,42 @@
-//  GEOM GEOMGUI : GUI for Geometry component
+// Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
 //
-//  Copyright (C) 2004  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
-//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
-// 
-//  This library is free software; you can redistribute it and/or 
-//  modify it under the terms of the GNU Lesser General Public 
-//  License as published by the Free Software Foundation; either 
-//  version 2.1 of the License. 
-// 
-//  This library is distributed in the hope that it will be useful, 
-//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
-//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
-//  Lesser General Public License for more details. 
-// 
-//  You should have received a copy of the GNU Lesser General Public 
-//  License along with this library; if not, write to the Free Software 
-//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
-// 
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
 //
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
 //
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 //
-//  File   : GEOMBase_Helper.h
-//  Author : Sergey ANIKIN
-//  Module : GEOM
-//  $Header$
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
+// GEOM GEOMGUI : GUI for Geometry component
+// File   : GEOMBase_Helper.h
+// Author : Sergey ANIKIN, Open CASCADE S.A.S. (sergey.anikin@opencascade.com)
 
 #ifndef GEOMBASE_HELPER_H
 #define GEOMBASE_HELPER_H
 
 #include "GEOM_GEOMBase.hxx"
+#include "GEOM_GenericObjPtr.h"
 
-#include "GEOM_Displayer.h"
-#include "SALOME_Prs.h"
-#include "SALOME_ListIO.hxx"
+#include <GEOM_Displayer.h>
+#include <SALOME_ListIO.hxx>
 #include <SALOMEconfig.h>
 #include CORBA_CLIENT_HEADER(GEOM_Gen)
 
-#include <qstring.h>
-#include <qmap.h>
+#include <QString>
+#include <QMap>
 
 #include <list>
 
@@ -47,13 +45,13 @@ typedef std::list<GEOM::GEOM_Object_ptr> ObjectList;
 class SalomeApp_Study;
 class SUIT_Desktop;
 class SUIT_ViewWindow;
+class SALOME_Prs;
 class GEOM_Operation;
-class TopoDS_Shape;
 class TColStd_MapOfInteger;
 
 //================================================================
 // Class       : GEOMBase_Helper
-// Description : Helper class for dialog box development, can be used as 
+// Description : Helper class for dialog box development, can be used as
 //               the second base class for dialog boxes. Contains convenient methods
 //               performing common operations (display/erase, selection activation,
 //               publication in a study, transaction management)
@@ -63,6 +61,7 @@ class GEOMBASE_EXPORT GEOMBase_Helper
 public:
   GEOMBase_Helper( SUIT_Desktop* );
   virtual ~GEOMBase_Helper();
+  static SUIT_ViewWindow* getActiveView();
 
 protected:
   static GEOM::GEOM_Gen_ptr getGeomEngine();
@@ -74,25 +73,26 @@ protected:
   void redisplay       ( const ObjectList&, const bool = true, const bool = true );
   void redisplay       ( GEOM::GEOM_Object_ptr, const bool = true, const bool = true );
 
-  virtual void displayPreview ( const bool   activate = false, 
+  virtual void displayPreview ( const bool   display,
+                                const bool   activate = false,
                                 const bool   update = true,
                                 const bool   toRemoveFromEngine = true,
-                                const double lineWidth = -1, 
+                                const double lineWidth = -1,
                                 const int    displayMode = -1,
                                 const int    color  = -1 );
   // This is the easiest way to show preview. It is based on execute() method.
   // It removes temporary GEOM::GEOM_Objects automatically.
 
-  virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj, 
-                                 const bool   append = false, 
-                                 const bool   activate = false, 
+  virtual void displayPreview  ( GEOM::GEOM_Object_ptr obj,
+                                 const bool   append = false,
+                                 const bool   activate = false,
                                  const bool   update = true,
-                                 const double lineWidth = -1, 
+                                 const double lineWidth = -1,
                                  const int    displayMode = -1,
                                  const int    color  = -1 );
-  void displayPreview  ( const SALOME_Prs* prs, 
-                        const bool append = false, 
-                        const bool = true );
+  void displayPreview  ( const SALOME_Prs* prs,
+                         const bool append = false,
+                         const bool = true );
   void erasePreview    ( const bool = true );
 
   void localSelection( const ObjectList&, const int );
@@ -100,12 +100,13 @@ protected:
   void activate( const int );
   void globalSelection( const int = GEOM_ALLOBJECTS, const bool = false  );
   void globalSelection( const TColStd_MapOfInteger&, const bool = false );
+  void globalSelection( const TColStd_MapOfInteger&, const QList<int>& ,const bool = false );
   void updateViewer    ();
 
   void prepareSelection( const ObjectList&, const int );
   void prepareSelection( GEOM::GEOM_Object_ptr, const int );
 
-  void addInStudy      ( GEOM::GEOM_Object_ptr, const char* theName ); 
+  QString addInStudy   ( GEOM::GEOM_Object_ptr, const char* theName );
 
   bool openCommand     ();
   bool abortCommand    ();
@@ -117,9 +118,9 @@ protected:
   SalomeApp_Study* getStudy  () const;
   bool checkViewWindow ();
 
-  bool onAccept( const bool publish = true, const bool useTransaction = true );
+  bool onAccept( const bool publish = true, const bool useTransaction = true, bool erasePreviewFlag = true);
   // This method should be called from "OK" button handler.
-  // <publish> == true means that objects returned by execute() 
+  // <publish> == true means that objects returned by execute()
   // should be published in a study.
 
   void showError();
@@ -135,30 +136,15 @@ protected:
   inline void setPrefix( const QString& prefix ) { myPrefix = prefix; }
   QString getPrefix( GEOM::GEOM_Object_ptr = GEOM::GEOM_Object::_nil() ) const;
 
-  const SALOME_ListIO& selectedIO();
-  // Function returns a list of SALOME_InteractiveObject's from
-  // selection manager in GUI
-
-  int   IObjectCount() ;
-  // Function returns the number of selected objects
-  
-  Handle(SALOME_InteractiveObject) firstIObject() ;
-  // Function returns the first selected object in the list
-  // of selected objects
-
-  Handle(SALOME_InteractiveObject) lastIObject() ;
-  // Function returns the last selected object in the list
-  // of selected objects
-  
   bool selectObjects( ObjectList& objects );
-  // Selects list of objects 
+  // Selects list of objects
 
   ////////////////////////////////////////////////////////////////////////////
   // Virtual methods, to be redefined in dialog classes
   ////////////////////////////////////////////////////////////////////////////
 
   virtual GEOM::GEOM_IOperations_ptr createOperation();
-  // This method should be redefined in dialog boxes so as to return 
+  // This method should be redefined in dialog boxes so as to return
   // proper GEOM_IOperation interface.
   // Returns nil reference by default
 
@@ -166,22 +152,31 @@ protected:
   // Called by onAccept(). Redefine this method to check validity of user input in dialog boxes.
 
   virtual bool execute( ObjectList& objects );
-  // This method is called by onAccept(). 
-  // It should perform the required operation and put all new or modified objects into 
-  // <objects> argument.Should return <false> if some error occurs during its execution. 
+  // This method is called by onAccept().
+  // It should perform the required operation and put all new or modified objects into
+  // <objects> argument.Should return <false> if some error occurs during its execution.
+
+  virtual void restoreSubShapes( SALOMEDS::Study_ptr theStudy, SALOMEDS::SObject_ptr theSObject );
+  // This method is called by addInStudy().
 
   virtual GEOM::GEOM_Object_ptr getFather( GEOM::GEOM_Object_ptr theObj );
   // This method is called by addInStudy(). It should return a father object
   // for <theObj> or a nil reference if <theObj> should be published
   // as a top-level object.
 
-  virtual const char* getNewObjectName() const; 
+  virtual QString getNewObjectName (int CurrObj = -1) const;
+  virtual QString getObjectName(GEOM::GEOM_Object_ptr object) const;
+  virtual bool extractPrefix() const;
   virtual void addSubshapesToStudy();
 
-  GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const char* theName );
-  //This Metod to find SubObject in theFather Object by Name (theName)
+  GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, const QString& theName );
+  GEOM::GEOM_Object_ptr findObjectInFather( GEOM::GEOM_Object_ptr theFather, int theIndex );
+  // These methods are used to find published sub-object (sub-shape) in the parent object (main shape)
 
-  void addSubshapesToFather( QMap<QString, GEOM::GEOM_Object_var>& theMap );
+  GEOM::GeomObjPtr        getSelected( TopAbs_ShapeEnum type );
+  GEOM::GeomObjPtr        getSelected( const QList<TopAbs_ShapeEnum>& types );
+  QList<GEOM::GeomObjPtr> getSelected( TopAbs_ShapeEnum type, int count, bool strict = true );
+  QList<GEOM::GeomObjPtr> getSelected( const QList<TopAbs_ShapeEnum>& types, int count, bool strict = true );
 
   void SetIsPreview(const bool thePreview) {isPreview = thePreview;}
   bool IsPreview() {return isPreview;}
@@ -189,8 +184,21 @@ protected:
   GEOM_Displayer*             getDisplayer();
   SUIT_Desktop*               getDesktop() const;
 
+  virtual void                setIsApplyAndClose( const bool theFlag );
+  virtual bool                isApplyAndClose() const;
+
+  virtual void                setIsOptimizedBrowsing( const bool theFlag );
+  virtual bool                isOptimizedBrowsing() const;
+
+  virtual void                setIsWaitCursorEnabled( const bool theFlag ) {myIsWaitCursorEnabled = theFlag;}
+  virtual bool                isWaitCursorEnabled() const {return myIsWaitCursorEnabled ;}
+  virtual void                setIsDisableBrowsing( const bool theFlag ) { myIsDisableBrowsing = theFlag; }
+  virtual bool                isDisableBrowsing() const { return myIsDisableBrowsing; }
+  virtual void                setIsDisplayResult( const bool theFlag ) {myIsDisplayResult = theFlag; }
+  virtual bool                isDisplayResult() const { return myIsDisplayResult; }
+
 private:
-  char* getEntry              ( GEOM::GEOM_Object_ptr ) const;
+  QString                     getEntry( GEOM::GEOM_Object_ptr ) const;
   void                        clearShapeBuffer( GEOM::GEOM_Object_ptr );
 
 private:
@@ -205,7 +213,12 @@ private:
   bool                        isPreview;
   SALOME_ListIO               mySelected;
   SUIT_Desktop*               myDesktop;
-
+  bool                        myIsApplyAndClose;
+  bool                        myIsOptimizedBrowsing;
+  bool                        myIsWaitCursorEnabled;
+  bool                        myIsDisableBrowsing;  //This flag enable/disable selection
+                                                    //in the Object Browser newly created objects.
+  bool                        myIsDisplayResult;    //This flag display/hide newly created objects.
 };
 
-#endif
+#endif // GEOMBASE_HELPER_H