src/SALOME_PYQT/SalomePyQt/SalomePyQt.h

   1 // Copyright (C) 2007-2019  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, or (at your option) any later version.
  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 // File   : SalomePyQt.h
  24 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
  25 //
  26 #ifndef SALOME_PYQT_H
  27 #define SALOME_PYQT_H
  28
  29 #include <Python.h>
  30
  31 #include <QObject>
  32 #include <QString>
  33 #include <QColor>
  34
  35 #include <LightApp_Application.h>
  36 #ifndef GUI_DISABLE_CORBA
  37 #include <SalomeApp_Application.h>
  38 #endif
  39 #include <LightApp_Preferences.h>
  40 #ifndef DISABLE_PLOT2DVIEWER
  41 #include <Plot2d_ViewFrame.h>
  42 #endif
  43
  44 class LightApp_SelectionMgr;
  45 class QMenuBar;
  46 class QMenu;
  47 class QWidget;
  48 class QAction;
  49 class QTreeView;
  50 class QtxActionGroup;
  51 #ifndef DISABLE_PLOT2DVIEWER
  52 class Plot2d_Curve;
  53 #endif
  54
  55 class SALOME_Selection : public QObject
  56 {
  57   Q_OBJECT
  58
  59 public:
  60   ~SALOME_Selection();
  61   static SALOME_Selection* GetSelection( LightApp_Application* );
  62
  63   void Clear();
  64   void ClearIObjects();
  65   void ClearFilters();
  66
  67 signals:
  68   void currentSelectionChanged();
  69
  70 private slots:
  71   void onSelMgrDestroyed();
  72
  73 private:
  74   LightApp_SelectionMgr* mySelMgr;
  75   SALOME_Selection( QObject* );
  76 };
  77
  78 enum MenuName {
  79   File        = 1,
  80   View        = 2,
  81   Edit        = 3,
  82   Preferences = 4,
  83   Tools       = 5,
  84   Window      = 6,
  85   Help        = 7
  86 };
  87
  88 enum {
  89   WT_ObjectBrowser = LightApp_Application::WT_ObjectBrowser,
  90   WT_PyConsole     = LightApp_Application::WT_PyConsole,
  91   WT_LogWindow     = LightApp_Application::WT_LogWindow,
  92 #ifndef GUI_DISABLE_CORBA
  93   WT_NoteBook      = SalomeApp_Application::WT_NoteBook,
  94   WT_User          = SalomeApp_Application::WT_User
  95 #else
  96   WT_User          = LightApp_Application::WT_User
  97 #endif
  98 };
  99
 100 enum {
 101   PT_Auto     = LightApp_Preferences::Auto,
 102   PT_Space    = LightApp_Preferences::Space,
 103   PT_Bool     = LightApp_Preferences::Bool,
 104   PT_Color    = LightApp_Preferences::Color,
 105   PT_String   = LightApp_Preferences::String,
 106   PT_Selector = LightApp_Preferences::Selector,
 107   PT_DblSpin  = LightApp_Preferences::DblSpin,
 108   PT_IntSpin  = LightApp_Preferences::IntSpin,
 109   PT_Double   = LightApp_Preferences::Double,
 110   PT_Integer  = LightApp_Preferences::Integer,
 111   PT_GroupBox = LightApp_Preferences::GroupBox,
 112   PT_Tab      = LightApp_Preferences::Tab,
 113   PT_Frame    = LightApp_Preferences::Frame,
 114   PT_Font     = LightApp_Preferences::Font,
 115   PT_DirList  = LightApp_Preferences::DirList,
 116   PT_File     = LightApp_Preferences::File,
 117   PT_Slider       = LightApp_Preferences::Slider,
 118   PT_Shortcut     = LightApp_Preferences::Shortcut,
 119   PT_ShortcutTree = LightApp_Preferences::ShortcutTree,
 120   PT_BiColor      = LightApp_Preferences::BiColor,
 121   PT_Background   = LightApp_Preferences::Background,
 122   PT_UserDefined  = LightApp_Preferences::UserDefined,
 123 };
 124
 125 class UserDefinedContent: public QWidget
 126 {
 127   Q_OBJECT
 128
 129 public:
 130   explicit UserDefinedContent();
 131
 132   virtual void store();
 133   virtual void retrieve();
 134 };
 135
 136 //! Orientation
 137 enum Orientation {
 138   Horizontal = 0, //!< Horizontal orientation
 139   Vertical   = 1  //!< Vertical orientation
 140 };
 141
 142 //! Action of splitting corresponding to QtxWorkstack::SplitType enumeration
 143 enum Action {
 144   MoveWidget   = 0, //!< move specified widget to the new area, other views stay in the previous area
 145   LeaveWidget  = 1, //!< specified widget stays in the old area, all other views are moved to the new area
 146   SplitAt      = 2  //!< the view area is splitted in such a way, that specified view and all views which follow it, are moved to the new area
 147 };
 148
 149 #ifndef DISABLE_PLOT2DVIEWER
 150 //! Type of titles in Plot3d View
 151 enum ObjectType
 152 {
 153   MainTitle = Plot2d_ViewFrame::MainTitle,
 154   XTitle = Plot2d_ViewFrame::XTitle,
 155   YTitle = Plot2d_ViewFrame::YTitle,
 156   Y2Title = Plot2d_ViewFrame::Y2Title,
 157   XAxis = Plot2d_ViewFrame::XAxis,
 158   YAxis = Plot2d_ViewFrame::YAxis,
 159   Y2Axis = Plot2d_ViewFrame::Y2Axis
 160 };
 161 #endif
 162
 163 enum VisibilityState
 164 {
 165   ShownState,             //!< Object is shown in viewer
 166   HiddenState,            //!< Object is hidden in viewer
 167   UnpresentableState      //!< Unpresentable object
 168 };
 169
 170 #ifndef DISABLE_PLOT2DVIEWER
 171 enum Axis {
 172   yLeft    = QwtPlot::yLeft,
 173   yRight   = QwtPlot::yRight,
 174   xBottom  = QwtPlot::xBottom,
 175   xTop     = QwtPlot::xTop,
 176 };
 177 #endif
 178
 179 class SalomePyQt
 180 {
 181 public:
 182   static QWidget*          getDesktop();
 183   static QWidget*          getMainFrame();
 184   static QMenuBar*         getMainMenuBar();
 185   static QMenu*            getPopupMenu( const MenuName );
 186   static QMenu*            getPopupMenu( const QString& );
 187   static QTreeView*        getObjectBrowser();
 188   static void              enableSelector();
 189   static void              disableSelector();
 190   static SALOME_Selection* getSelection();
 191   static QStringList       getComponents();
 192   static void              setSelection( const QStringList& );
 193   static const QString     getActiveComponent();
 194   static PyObject*         getActivePythonModule();
 195   static bool              activateModule( const QString& );
 196   static void              updateObjBrowser();
 197
 198   static void              putInfo( const QString&, const int = 0 );
 199   static int               showNotification( const QString&, const QString&, const int = -1 );
 200   static void              hideNotification( const QString& );
 201   static void              hideNotification( const int );
 202
 203   static bool              isModified();
 204   static void              setModified( bool );
 205
 206   static QString           getFileName         ( QWidget*, const QString&, const QStringList&, const QString&, bool );
 207   static QStringList       getOpenFileNames    ( QWidget*, const QString&, const QStringList&, const QString& );
 208   static QString           getExistingDirectory( QWidget*, const QString&, const QString& );
 209
 210   static void              createRoot();
 211   static QString           createObject( const QString& parent = QString() );
 212   static QString           createObject( const QString&, const QString&, const QString&, const QString& = QString() );
 213
 214   static void              removeObject( const QString&);
 215   static void              removeChildren( const QString& = QString() );
 216   static QStringList       getChildren( const QString& = QString(), const bool = false );
 217   static void              setName( const QString&, const QString& );
 218   static void              setIcon( const QString&, const QString& );
 219   static void              setToolTip( const QString&, const QString& );
 220   static QString           getName( const QString& );
 221   static QString           getToolTip( const QString& );
 222
 223   static void              setVisibilityState( const QString&, VisibilityState );
 224   static VisibilityState   getVisibilityState( const QString& );
 225
 226   static void              setObjectPosition( const QString&, int );
 227   static int               getObjectPosition( const QString& );
 228
 229
 230   static void              setColor( const QString&, const QColor& );
 231   static QColor            getColor( const QString& );
 232
 233   static void              setReference( const QString&, const QString& );
 234   static QString           getReference( const QString& );
 235
 236   static QIcon             loadIcon( const QString&, const QString& );
 237
 238   static void              helpContext( const QString&, const QString& );
 239
 240   static bool              dumpView( const QString&, const int = 0 );
 241
 242   static int               defaultMenuGroup();
 243
 244   static int               createTool( const QString&, const QString& = QString() );
 245   static int               createTool( const int,  const int,      const int = -1 );
 246   static int               createTool( const int,  const QString&, const int = -1 );
 247   static int               createTool( QAction*, const int,      const int = -1, const int = -1 );
 248   static int               createTool( QAction*, const QString&, const int = -1, const int = -1 );
 249   static void              clearTool( const QString& );
 250
 251   static int               createMenu( const QString&, const int = -1,
 252                                        const int = -1, const int = -1, const int = -1 );
 253   static int               createMenu( const QString&, const QString& = QString(),
 254                                        const int = -1, const int = -1, const int = -1 );
 255   static int               createMenu( const int,      const int = -1,
 256                                        const int = -1, const int = -1 );
 257   static int               createMenu( const int,      const QString& = QString(),
 258                                        const int = -1, const int = -1 );
 259   static int               createMenu( QAction*,     const int,      const int = -1,
 260                                        const int = -1, const int = -1 );
 261   static int               createMenu( QAction*,     const QString&, const int = -1,
 262                                        const int = -1, const int = -1 );
 263
 264   static QAction*          createSeparator();
 265
 266   static QAction*          createAction( const int, const QString&,
 267                                          const QString& = QString(), const QString& = QString(),
 268                                          const QString& = QString(), const int = 0, const bool = false );
 269
 270   static QtxActionGroup*   createActionGroup( const int, const bool = true );
 271
 272   static QAction*          action( const int );
 273   static int               actionId( const QAction* );
 274
 275   static QString           constant      ( const QString& );
 276   static void              setConstant   ( const QString&, const QString& );
 277   static void              addSetting    ( const QString&, const QString&, const double );
 278   static void              addSetting    ( const QString&, const QString&, const int );
 279   static void              addSetting    ( const QString&, const QString&, const bool, const int );
 280   static void              addSetting    ( const QString&, const QString&, const QString& );
 281   static void              addSetting    ( const QString&, const QString&, const QColor& );
 282   static void              addSetting    ( const QString&, const QString&, const QByteArray& );
 283   static void              addSetting    ( const QString&, const QString&, const QFont& );
 284   static int               integerSetting( const QString&, const QString&, const int = 0 );
 285   static double            doubleSetting ( const QString&, const QString&, const double = 0 );
 286   static bool              boolSetting   ( const QString&, const QString&, const bool = 0 );
 287   static QString           stringSetting ( const QString&, const QString&, const QString& = QString(""), const bool = true );
 288   static QColor            colorSetting  ( const QString&, const QString&, const QColor& = QColor() );
 289   static QByteArray        byteArraySetting( const QString&, const QString&, const QByteArray& = QByteArray() );
 290   static QFont             fontSetting( const QString&, const QString&, const QFont& = QFont() );
 291   static void              removeSetting ( const QString&, const QString& );
 292   static bool              hasSetting    ( const QString&, const QString& );
 293   static QStringList       parameters    ( const QString& );
 294   static QStringList       parameters    ( const QStringList& );
 295
 296   static int               addGlobalPreference( const QString& );
 297   static int               addPreference( const QString& );
 298   static int               addPreference( const QString&,
 299                                           const int, const int = PT_Auto,
 300                                           const QString& = QString(),
 301                                           const QString& = QString() );
 302   static QVariant          preferenceProperty( const int, const QString& );
 303   static void              setPreferenceProperty( const int, const QString&, const QVariant& );
 304   static void              setPreferencePropertyWg( const int, const QString&, UserDefinedContent* );
 305   static void              addPreferenceProperty( const int, const QString&, const int, const QVariant& );
 306
 307   static void              message( const QString&, bool = true );
 308   static void              clearMessages();
 309
 310   static QList<int>        getViews();
 311   static int               getActiveView();
 312   static QString           getViewType( const int );
 313   static bool              setViewTitle( const int, const QString& );
 314   static QString           getViewTitle( const int );
 315   static bool              setViewSize( const int, const int, const int = 0 );
 316   static bool              setViewRotationPoint( const double, const double, const double, const int = 0 );
 317   static QList<int>        findViews( const QString& );
 318   static bool              activateView( const int );
 319   static bool              activateViewManagerAndView( const int );
 320   static QWidget*          getViewWidget( const int );
 321   static int               createView( const QString&, bool visible = true, const int width = 0, const int height = 0, bool detached = false );
 322   static int               createView( const QString&, QWidget* );
 323   static bool              closeView( const int );
 324   static int               cloneView( const int );
 325   static void              setViewVisible( const int id, bool visible = true );
 326   static bool              isViewVisible( const int );
 327   static void              setViewClosable( const int, const bool );
 328   static bool              isViewClosable( const int );
 329
 330   static bool              groupAllViews();
 331   static bool              splitView( const int, const Orientation, const Action );
 332   static bool              moveView( const int, const int, const bool );
 333   static QList<int>        neighbourViews( const int );
 334
 335 #ifndef DISABLE_PLOT2DVIEWER
 336   static void              displayCurve(const int, Plot2d_Curve*);
 337   static void              eraseCurve(const int, Plot2d_Curve*);
 338   static void              eraseCurve(Plot2d_Curve*);
 339   static void              updateCurves( const int );
 340   static QString           getPlot2dTitle(const int, ObjectType = MainTitle);
 341   static void              setPlot2dTitle(const int, const QString&, ObjectType = MainTitle, bool = true);
 342   static QList<double>     getPlot2dFitRangeByCurves(const int);
 343   static QList<double>     getPlot2dFitRangeCurrent(const int);
 344   static void              setPlot2dFitRange(const int, const double XMin, const double XMax, const double YMin, const double YMax);
 345 #endif
 346
 347 //  static void              initializeParaViewGUI();
 348   static void              processEvents();
 349
 350   // the following methods are obsolete
 351   static void              addStringSetting( const QString&, const QString&, bool = true );
 352   static void              addIntSetting   ( const QString&, const int,      bool = true );
 353   static void              addBoolSetting  ( const QString&, const bool,     bool = true );
 354   static void              addDoubleSetting( const QString&, const double,   bool = true );
 355   static void              removeSettings  ( const QString& );
 356   static QString           getSetting      ( const QString& );
 357
 358   static void              removeChild( const QString& = QString() );
 359
 360   static void              startPyLog(const QString&);
 361   static void              stopPyLog();
 362
 363 };
 364
 365 #endif // SALOME_PYQT_H