PAL13946 Improvment of SalomePyQt interface

1)
+  QActionGroup*          createActionGroup(const int id, const bool exclusive);
2) replace QtxAction by QAction in order to enable passing QActionGroup* as argument

diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx
index 15ee7c264881986af28e8d79d8f2a8f29ec06af6..626f4cb437e452306889987fa9d74c8ebdc1a192 100644 (file)
--- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx
+++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.cxx
@@ -26,6 +26,7 @@
 #include <qpopupmenu.h>
 #include <qimage.h>
 #include <qstringlist.h>
+#include <qaction.h>
 
 #include "SALOME_Event.hxx"
 
@@ -38,11 +39,25 @@
 #include "SalomeApp_Study.h"
 #include "LightApp_SelectionMgr.h"
 #include "OB_Browser.h"
-#include "QtxAction.h"
+//#include "QtxAction.h"
 #include "LogWindow.h"
 
 using namespace std;
 
+
+/*!
+ * Macro declaring Execute() method calling a method of SALOME_PYQT_Module
+ */
+#define EXEC_PYQT_MODULE_CALL(meth_call)                                  \
+virtual void Execute() {                                                  \
+  if ( SalomeApp_Application* anApp = getApplication() ) {                \
+    SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();     \
+    if ( !module )                                                        \
+      module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );\
+    if ( module )                                                         \
+      myResult = (TResult)module->meth_call;                              \
+  }}
+
 /*!
   \return active application object [ static ]
 */
@@ -1113,9 +1128,9 @@ public:
     : myCase( 1 ), myId( id ), myTbId( tBar ), myIndex( idx ) {}
   CrTool( const int id, const QString& tBar, const int idx )
     : myCase( 2 ), myId( id ), myTbName( tBar ), myIndex( idx ) {}
-  CrTool( QtxAction* action, const int tbId, const int id, const int idx )
+  CrTool( QAction* action, const int tbId, const int id, const int idx )
     : myCase( 3 ), myAction( action ), myTbId( tbId ), myId( id ), myIndex( idx ) {}
-  CrTool( QtxAction* action, const QString& tBar, const int id, const int idx )
+  CrTool( QAction* action, const QString& tBar, const int id, const int idx )
     : myCase( 4 ), myAction( action ), myTbName( tBar ), myId( id ), myIndex( idx ) {}
 
   int execute( SALOME_PYQT_Module* module ) const
@@ -1140,7 +1155,7 @@ private:
    int        myCase;
    QString    myTbName;
    int        myTbId;
-   QtxAction* myAction;
+   QAction* myAction;
    int        myId;
    int        myIndex;
 };
@@ -1182,13 +1197,13 @@ int SalomePyQt::createTool( const int id, const QString& tBar, const int idx )
 }
 /*! add action with id and index to the existing tollbar
 */
-int SalomePyQt::createTool( QtxAction* a, const int tBar, const int id, const int idx )
+int SalomePyQt::createTool( QAction* a, const int tBar, const int id, const int idx )
 {
   return ProcessEvent( new TCreateToolEvent( CrTool( a, tBar, id, idx ) ) );
 }
 /*! add action with id and index to the existing tollbar
 */
-int SalomePyQt::createTool( QtxAction* a, const QString& tBar, const int id, const int idx )
+int SalomePyQt::createTool( QAction* a, const QString& tBar, const int id, const int idx )
 {
   return ProcessEvent( new TCreateToolEvent( CrTool( a, tBar, id, idx ) ) );
 }
@@ -1215,9 +1230,9 @@ public:
     : myCase( 2 ), myId( id ), myMenuId( menu ), myGroup( group ), myIndex( idx ) {}
   CrMenu( const int id, const QString& menu, const int group, const int idx ) 
     : myCase( 3 ), myId( id ), myMenuName( menu ), myGroup( group ), myIndex( idx ) {}
-  CrMenu( QtxAction* action, const int menu, const int id, const int group, const int idx ) 
+  CrMenu( QAction* action, const int menu, const int id, const int group, const int idx ) 
     : myCase( 4 ), myAction( action ), myMenuId( menu ), myId( id ), myGroup( group ), myIndex( idx ) {}
-  CrMenu( QtxAction* action, const QString& menu, const int id, const int group, const int idx ) 
+  CrMenu( QAction* action, const QString& menu, const int id, const int group, const int idx ) 
     : myCase( 5 ), myAction( action ), myMenuName( menu ), myId( id ), myGroup( group ), myIndex( idx ) {}
 
   int execute( SALOME_PYQT_Module* module ) const
@@ -1246,7 +1261,7 @@ private:
    int        myMenuId;
    QString    mySubMenuName;
    int        myGroup;
-   QtxAction* myAction;
+   QAction* myAction;
    int        myId;
    int        myIndex;
 };
@@ -1286,12 +1301,12 @@ int SalomePyQt::createMenu( const int id, const QString& menu, const int group,
   return ProcessEvent( new TCreateMenuEvent( CrMenu( id, menu, group, idx ) ) );
 }
 
-int SalomePyQt::createMenu( QtxAction* a, const int menu, const int id, const int group, const int idx )
+int SalomePyQt::createMenu( QAction* a, const int menu, const int id, const int group, const int idx )
 {
   return ProcessEvent( new TCreateMenuEvent( CrMenu( a, menu, id, group, idx ) ) );
 }
 
-int SalomePyQt::createMenu( QtxAction* a, const QString& menu, const int id, const int group, const int idx )
+int SalomePyQt::createMenu( QAction* a, const QString& menu, const int id, const int group, const int idx )
 {
   return ProcessEvent( new TCreateMenuEvent( CrMenu( a, menu, id, group, idx ) ) );
 }
@@ -1302,21 +1317,13 @@ int SalomePyQt::createMenu( QtxAction* a, const QString& menu, const int id, con
 */
 class TCreateSepEvent: public SALOME_Event {
 public:
-  typedef QtxAction* TResult;
+  typedef QAction* TResult;
   TResult myResult;
   TCreateSepEvent() 
     : myResult( 0 ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-        myResult = (QtxAction*)module->createSeparator();
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(createSeparator());
 };
-QtxAction* SalomePyQt::createSeparator()
+QAction* SalomePyQt::createSeparator()
 {
   return ProcessEvent( new TCreateSepEvent() );
 }
@@ -1334,7 +1341,7 @@ QtxAction* SalomePyQt::createSeparator()
 */
 class TCreateActionEvent: public SALOME_Event {
 public:
-  typedef QtxAction* TResult;
+  typedef QAction* TResult;
   TResult myResult;
   int     myId;
   QString myMenuText;
@@ -1347,45 +1354,49 @@ public:
                      const QString& statusText, const QString& icon, const int key, const bool toggle ) 
     : myResult( 0 ), myId( id ), myMenuText( menuText ), myTipText( tipText ),
       myStatusText( statusText ), myIcon( icon ), myKey( key ), myToggle( toggle ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-        myResult = (QtxAction*)module->createAction( myId, myTipText, myIcon, myMenuText, myStatusText, myKey, myToggle );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(createAction( myId, myTipText, myIcon, myMenuText, myStatusText, myKey, myToggle ));
 };
-QtxAction* SalomePyQt::createAction( const int id,           const QString& menuText, 
+QAction* SalomePyQt::createAction( const int id,           const QString& menuText, 
                                     const QString& tipText, const QString& statusText, 
                                     const QString& icon,    const int key, const bool toggle )
 {
   return ProcessEvent( new TCreateActionEvent( id, menuText, tipText, statusText, icon, key, toggle ) );
 }
 
+/*!
+  SalomePyQt::createActionGroup
+  Create an action group which can be then used in the menu or toolbar:
+  - id         : the unique id action to be registered to;
+  - toggle     : if true the action group does exclusive toggling
+*/
+struct TcreateActionGroupEvent: public SALOME_Event {
+  typedef QActionGroup* TResult;
+  TResult myResult;
+  int     myId;
+  bool    myExclusive;
+  TcreateActionGroupEvent(const int id, const bool exclusive):myId(id),myExclusive(exclusive) {}
+  EXEC_PYQT_MODULE_CALL( createActionGroup( myId, myExclusive ));
+};
+
+QActionGroup* SalomePyQt::createActionGroup(const int id, const bool exclusive)
+{
+  return ProcessEvent( new TcreateActionGroupEvent(id, exclusive));
+}
+
 /*!
   SalomePyQt::action
   Get an action by its id. Returns 0 if the action with such id was not registered.
 */
 class TActionEvent: public SALOME_Event {
 public:
-  typedef QtxAction* TResult;
+  typedef QAction* TResult;
   TResult myResult;
   int     myId;
   TActionEvent( const int id )
     : myResult( 0 ), myId( id ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-        myResult = (QtxAction*)module->action( myId );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(action( myId ));
 };
-QtxAction* SalomePyQt::action( const int id )
+QAction* SalomePyQt::action( const int id )
 {
   return ProcessEvent( new TActionEvent( id ) );
 }
@@ -1398,20 +1409,12 @@ class TActionIdEvent: public SALOME_Event {
 public:
   typedef  int TResult;
   TResult  myResult;
-  const QtxAction* myAction;
-  TActionIdEvent( const QtxAction* action )
+  const QAction* myAction;
+  TActionIdEvent( const QAction* action )
     : myResult( -1 ), myAction( action ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-        myResult = module->actionId( myAction );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(actionId( myAction ));
 };
-int SalomePyQt::actionId( const QtxAction* a )
+int SalomePyQt::actionId( const QAction* a )
 {
   return ProcessEvent( new TActionIdEvent( a ) );
 }
@@ -1429,15 +1432,7 @@ public:
   bool     myRemoveActions;
   TClearMenuEvent( const int id, const int menu, const bool removeActions )
     : myResult( false ), myId( id ), myMenu( menu ), myRemoveActions( removeActions ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-        myResult = module->clearMenu( myId, myMenu, myRemoveActions );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(clearMenu( myId, myMenu, myRemoveActions ));
 };
 bool SalomePyQt::clearMenu( const int id, const int menu, const bool removeActions )
 {
@@ -1455,15 +1450,7 @@ public:
   QString myLabel;
   TAddGlobalPrefEvent( const QString& label )
     : myResult( -1 ), myLabel( label ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-       myResult = module->addGlobalPreference( myLabel );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(addGlobalPreference( myLabel ));
 };
 int SalomePyQt::addGlobalPreference( const QString& label )
 {
@@ -1481,15 +1468,7 @@ public:
   QString myLabel;
   TAddPrefEvent( const QString& label )
     : myResult( -1 ), myLabel( label ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-       myResult = module->addPreference( myLabel );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(addPreference( myLabel ));
 };
 int SalomePyQt::addPreference( const QString& label )
 {
@@ -1516,15 +1495,7 @@ public:
     : myResult( -1 ),
       myLabel( label ), myPId( pId ), myType( type ), 
       mySection( section ), myParam ( param ) {}
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-       myResult = module->addPreference( myLabel, myPId, myType, mySection, myParam );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(addPreference( myLabel, myPId, myType, mySection, myParam ));
 };
 int SalomePyQt::addPreference( const QString& label, const int pId, const int type,
                               const QString& section, const QString& param )
@@ -1547,15 +1518,7 @@ public:
   { 
     myResult = QVariant();
   }
-  virtual void Execute() {
-    if ( SalomeApp_Application* anApp = getApplication() ) {
-      SALOME_PYQT_Module* module = SALOME_PYQT_Module::getInitModule();
-      if ( !module )
-        module = dynamic_cast<SALOME_PYQT_Module*>( anApp->activeModule() );
-      if ( module )
-       myResult = module->preferenceProperty( myId, myProp );
-    }
-  }
+  EXEC_PYQT_MODULE_CALL(preferenceProperty( myId, myProp ));
 };
 QVariant SalomePyQt::preferenceProperty( const int id, const QString& prop )
 {

diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h
index d160c193caab818567983583b48dbe3567c252bc..a4c8c5cdca40529348118f49b571ee4a147a194f 100644 (file)
--- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h
+++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.h
@@ -32,7 +32,8 @@ class SalomeApp_Application;
 class QMenuBar;
 class QPopupMenu;
 class QWidget;
-class QtxAction;
+class QAction;
+class QActionGroup;
 
 class SALOME_Selection : public QObject
 {
@@ -117,8 +118,8 @@ public:
   static int               createTool( const QString& );
   static int               createTool( const int,  const int,      const int = -1 );
   static int               createTool( const int,  const QString&, const int = -1 );
-  static int               createTool( QtxAction*, const int,      const int = -1, const int = -1 );
-  static int               createTool( QtxAction*, const QString&, const int = -1, const int = -1 );
+  static int               createTool( QAction*, const int,      const int = -1, const int = -1 );
+  static int               createTool( QAction*, const QString&, const int = -1, const int = -1 );
 
   static int               createMenu( const QString&, const int = -1,
                                       const int = -1, const int = -1, const int = -1 );
@@ -128,19 +129,21 @@ public:
                                       const int = -1, const int = -1 );
   static int               createMenu( const int,      const QString& = QString::null, 
                                       const int = -1, const int = -1 );
-  static int               createMenu( QtxAction*,     const int,      const int = -1, 
+  static int               createMenu( QAction*,     const int,      const int = -1, 
                                       const int = -1, const int = -1 );
-  static int               createMenu( QtxAction*,     const QString&, const int = -1, 
+  static int               createMenu( QAction*,     const QString&, const int = -1, 
                                       const int = -1, const int = -1 );
 
-  static QtxAction*        createSeparator();
+  static QAction*          createSeparator();
 
-  static QtxAction*        createAction( const int, const QString&,
-                                        const QString& = QString::null, const QString& = QString::null, 
-                                        const QString& = QString::null, const int = 0, const bool = false );
+  static QAction*          createAction( const int, const QString&,
+                                         const QString& = QString::null, const QString& = QString::null, 
+                                         const QString& = QString::null, const int = 0, const bool = false );
 
-  static QtxAction*        action( const int );
-  static int               actionId( const QtxAction* );
+  static QActionGroup*     createActionGroup(const int, const bool = true);
+
+  static QAction*          action( const int );
+  static int               actionId( const QAction* );
 
   static bool              clearMenu( const int = 0, const int = 0,
                                      const bool = true );

diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.sip b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.sip
index f73f7b0ea0e5db98789cf3b46c528ec5d06b4d24..4677afa0ca7097cebfda236e7482d24751a05c2c 100644 (file)
--- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt.sip
+++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt.sip
@@ -103,8 +103,8 @@ public:
   static int               createTool( const QString& );
   static int               createTool( const int,  const int,      int = -1 );
   static int               createTool( const int,  const QString&, int = -1 );
-  static int               createTool( QtxAction*, const int,      int = -1, int = -1 );
-  static int               createTool( QtxAction*, const QString&, int = -1, int = -1 );
+  static int               createTool( QAction*, const int,      int = -1, int = -1 );
+  static int               createTool( QAction*, const QString&, int = -1, int = -1 );
 
   static int               createMenu( const QString&, const int,
                                       int = -1, int = -1, int = -1 );
@@ -114,19 +114,21 @@ public:
                                       int = -1,       int = -1 );
   static int               createMenu( const int,      const QString&, 
                                       int = -1,       int = -1 );
-  static int               createMenu( QtxAction*,     const int,      int = -1, 
+  static int               createMenu( QAction*,     const int,      int = -1, 
                                       int = -1,       int = -1 );
-  static int               createMenu( QtxAction*,     const QString&, int = -1, 
+  static int               createMenu( QAction*,     const QString&, int = -1, 
                                       int = -1,       int = -1 );
 
-  static QtxAction*        createSeparator();
+  static QAction*          createSeparator();
 
-  static QtxAction*        createAction( const int, const QString&, 
+  static QAction*          createAction( const int, const QString&, 
                                         const QString& = QString::null, const QString& = QString::null, 
                                         const QString& = QString::null, int = 0, bool = false );
 
-  static QtxAction*        action( const int );
-  static int               actionId( const QtxAction* );
+  static QActionGroup*     createActionGroup(const int, const bool = true);
+
+  static QAction*          action( const int );
+  static int               actionId( const QAction* );
 
   static bool              clearMenu( int = 0, int = 0,
                                      bool = true  );

diff --git a/src/SALOME_PYQT/SalomePyQt/SalomePyQt_v4.sip b/src/SALOME_PYQT/SalomePyQt/SalomePyQt_v4.sip
index 91419367b8993c6b7fb94f0238d5fe60477f0ebc..3d41d2f0dc7963142e172151f0411cd7048ba540 100644 (file)
--- a/src/SALOME_PYQT/SalomePyQt/SalomePyQt_v4.sip
+++ b/src/SALOME_PYQT/SalomePyQt/SalomePyQt_v4.sip
@@ -110,8 +110,8 @@ public:
   static int               createTool( const QString& ) /ReleaseGIL/ ;
   static int               createTool( const int,  const int,      const int = -1 ) /ReleaseGIL/ ;
   static int               createTool( const int,  const QString&, const int = -1 ) /ReleaseGIL/ ;
-  static int               createTool( QtxAction*, const int,      const int = -1, const int = -1 ) /ReleaseGIL/ ;
-  static int               createTool( QtxAction*, const QString&, const int = -1, const int = -1 ) /ReleaseGIL/ ;
+  static int               createTool( QAction*, const int,      const int = -1, const int = -1 ) /ReleaseGIL/ ;
+  static int               createTool( QAction*, const QString&, const int = -1, const int = -1 ) /ReleaseGIL/ ;
 
   static int               createMenu( const QString&, const int,
                                       const int = -1, const int = -1, const int = -1 ) /ReleaseGIL/ ;
@@ -121,18 +121,20 @@ public:
                                       const int = -1, const int = -1 ) /ReleaseGIL/ ;
   static int               createMenu( const int,      const QString&, 
                                       const int = -1, const int = -1 ) /ReleaseGIL/ ;
-  static int               createMenu( QtxAction*,     const int,      const int = -1, 
+  static int               createMenu( QAction*,     const int,      const int = -1, 
                                       const int = -1, const int = -1 ) /ReleaseGIL/ ;
-  static int               createMenu( QtxAction*,     const QString&, const int = -1, 
+  static int               createMenu( QAction*,     const QString&, const int = -1, 
                                       const int = -1, const int = -1 ) /ReleaseGIL/ ;
-  static QtxAction*        createSeparator() /ReleaseGIL/ ;
+  static QAction*          createSeparator() /ReleaseGIL/ ;
 
-  static QtxAction*        createAction( const int, const QString&, 
+  static QAction*          createAction( const int, const QString&, 
                                         const QString& = QString::null, const QString& = QString::null, 
                                         const QString& = QString::null, const int = 0, const bool = false ) /ReleaseGIL/ ;
 
-  static QtxAction*        action( const int ) /ReleaseGIL/ ;
-  static int               actionId( const QtxAction* ) /ReleaseGIL/ ;
+  static QActionGroup*     createActionGroup(const int, const bool = true) /ReleaseGIL/ ;
+
+  static QAction*          action( const int ) /ReleaseGIL/ ;
+  static int               actionId( const QAction* ) /ReleaseGIL/ ;
 
   static bool              clearMenu( const int = 0, const int = 0,
                                      const bool = true ) /ReleaseGIL/ ;