src/SALOME_PYQT/SalomePyQt/SalomePyQt.h

   1 // Copyright (C) 2007-2014  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 #include <Plot2d_ViewFrame.h>
  41
  42 class LightApp_SelectionMgr;
  43 class QMenuBar;
  44 class QMenu;
  45 class QWidget;
  46 class QAction;
  47 class QTreeView;
  48 class QtxActionGroup;
  49 class Plot2d_Curve;
  50
  51 class SALOME_Selection : public QObject
  52 {
  53   Q_OBJECT
  54
  55 public:
  56   ~SALOME_Selection();
  57   static SALOME_Selection* GetSelection( LightApp_Application* );
  58
  59   void Clear();
  60   void ClearIObjects();
  61   void ClearFilters();
  62
  63 signals:
  64   void currentSelectionChanged();
  65
  66 private slots:
  67   void onSelMgrDestroyed();
  68
  69 private:
  70   LightApp_SelectionMgr* mySelMgr;
  71   SALOME_Selection( QObject* );
  72 };
  73
  74 enum MenuName {
  75   File        = 1,
  76   View        = 2,
  77   Edit        = 3,
  78   Preferences = 4,
  79   Tools       = 5,
  80   Window      = 6,
  81   Help        = 7
  82 };
  83
  84 enum {
  85   WT_ObjectBrowser = LightApp_Application::WT_ObjectBrowser,
  86 #ifndef GUI_DISABLE_CORBA
  87   WT_NoteBook      = SalomeApp_Application::WT_NoteBook,
  88 #endif
  89   WT_PyConsole     = LightApp_Application::WT_PyConsole,
  90   WT_LogWindow     = LightApp_Application::WT_LogWindow,
  91 #ifndef GUI_DISABLE_CORBA
  92   WT_User          = SalomeApp_Application::WT_User
  93 #else
  94   WT_User          = LightApp_Application::WT_User
  95 #endif
  96 };
  97
  98 enum {
  99   PT_Auto     = LightApp_Preferences::Auto,
 100   PT_Space    = LightApp_Preferences::Space,
 101   PT_Bool     = LightApp_Preferences::Bool,
 102   PT_Color    = LightApp_Preferences::Color,
 103   PT_String   = LightApp_Preferences::String,
 104   PT_Selector = LightApp_Preferences::Selector,
 105   PT_DblSpin  = LightApp_Preferences::DblSpin,
 106   PT_IntSpin  = LightApp_Preferences::IntSpin,
 107   PT_Double   = LightApp_Preferences::Double,
 108   PT_Integer  = LightApp_Preferences::Integer,
 109   PT_GroupBox = LightApp_Preferences::GroupBox,
 110   PT_Tab      = LightApp_Preferences::Tab,
 111   PT_Frame    = LightApp_Preferences::Frame,
 112   PT_Font     = LightApp_Preferences::Font,
 113   PT_DirList  = LightApp_Preferences::DirList,
 114   PT_File     = LightApp_Preferences::File,
 115 };
 116
 117 //! Orientation
 118 enum Orientation {
 119   Horizontal = 0, //!< Horizontal orientation
 120   Vertical   = 1  //!< Vertical orientation
 121 };
 122
 123 //! Action of splitting corresponding to QtxWorkstack::SplitType enumeration
 124 enum Action {
 125   MoveWidget   = 0, //!< move specified widget to the new area, other views stay in the previous area
 126   LeaveWidget  = 1, //!< specified widget stays in the old area, all other views are moved to the new area
 127   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
 128 };
 129
 130 //! Type of titles in Plot3d View
 131 enum ObjectType
 132 {
 133   MainTitle = Plot2d_ViewFrame::MainTitle,
 134   XTitle = Plot2d_ViewFrame::XTitle,
 135   YTitle = Plot2d_ViewFrame::YTitle,
 136   Y2Title = Plot2d_ViewFrame::Y2Title,
 137   XAxis = Plot2d_ViewFrame::XAxis,
 138   YAxis = Plot2d_ViewFrame::YAxis,
 139   Y2Axis = Plot2d_ViewFrame::Y2Axis
 140 };
 141
 142 enum VisibilityState
 143 {
 144   ShownState,             //!< Object is shown in viewer
 145   HiddenState,            //!< Object is hidden in viewer
 146   UnpresentableState      //!< Unpresentable object
 147 };
 148
 149 enum Axis {
 150   yLeft    = QwtPlot::yLeft,
 151   yRight   = QwtPlot::yRight,
 152   xBottom  = QwtPlot::xBottom,
 153   xTop     = QwtPlot::xTop,
 154 };
 155
 156 class SalomePyQt
 157 {
 158 public:
 159   static QWidget*          getDesktop();
 160   static QWidget*          getMainFrame();
 161   static QMenuBar*         getMainMenuBar();
 162   static QMenu*            getPopupMenu( const MenuName );
 163   static QMenu*            getPopupMenu( const QString& );
 164   static QTreeView*        getObjectBrowser();
 165   static SALOME_Selection* getSelection();
 166   static int               getStudyId();
 167   static void              putInfo( const QString&, const int = 0 );
 168   static const QString     getActiveComponent();
 169   static PyObject*         getActivePythonModule();
 170   static bool              activateModule( const QString& );
 171   static void              updateObjBrowser( const int = 0, bool = true );
 172
 173   static bool              isModified();
 174   static void              setModified( bool );
 175
 176   static QString           getFileName         ( QWidget*, const QString&, const QStringList&, const QString&, bool );
 177   static QStringList       getOpenFileNames    ( QWidget*, const QString&, const QStringList&, const QString& );
 178   static QString           getExistingDirectory( QWidget*, const QString&, const QString& );
 179
 180   static QString           createObject( const QString& parent = QString() );
 181   static QString           createObject( const QString&, const QString&, const QString&, const QString& = QString() );
 182
 183   static void              removeObject( const QString&);
 184   static void              removeChildren( const QString& = QString() );
 185   static QStringList       getChildren( const QString& = QString(), const bool = false );
 186   static void              setName( const QString&, const QString& );
 187   static void              setIcon( const QString&, const QString& );
 188   static void              setToolTip( const QString&, const QString& );
 189   static QString           getName( const QString& );
 190   static QString           getToolTip( const QString& );
 191
 192   static void              setVisibilityState( const QString&, VisibilityState );
 193   static VisibilityState   getVisibilityState( const QString& );
 194
 195   static void              setObjectPosition( const QString&, int );
 196   static int               getObjectPosition( const QString& );
 197
 198
 199   static void              setColor( const QString&, const QColor& );
 200   static QColor            getColor( const QString& );
 201
 202   static void              setReference( const QString&, const QString& );
 203   static QString           getReference( const QString& );
 204
 205   static QIcon             loadIcon( const QString&, const QString& );
 206
 207   static void              helpContext( const QString&, const QString& );
 208
 209   static bool              dumpView( const QString&, const int = 0 );
 210
 211   static int               defaultMenuGroup();
 212
 213   static int               createTool( const QString& );
 214   static int               createTool( const int,  const int,      const int = -1 );
 215   static int               createTool( const int,  const QString&, const int = -1 );
 216   static int               createTool( QAction*, const int,      const int = -1, const int = -1 );
 217   static int               createTool( QAction*, const QString&, const int = -1, const int = -1 );
 218
 219   static int               createMenu( const QString&, const int = -1,
 220                                        const int = -1, const int = -1, const int = -1 );
 221   static int               createMenu( const QString&, const QString& = QString(),
 222                                        const int = -1, const int = -1, const int = -1 );
 223   static int               createMenu( const int,      const int = -1,
 224                                        const int = -1, const int = -1 );
 225   static int               createMenu( const int,      const QString& = QString(),
 226                                        const int = -1, const int = -1 );
 227   static int               createMenu( QAction*,     const int,      const int = -1,
 228                                        const int = -1, const int = -1 );
 229   static int               createMenu( QAction*,     const QString&, const int = -1,
 230                                        const int = -1, const int = -1 );
 231
 232   static QAction*          createSeparator();
 233
 234   static QAction*          createAction( const int, const QString&,
 235                                          const QString& = QString(), const QString& = QString(),
 236                                          const QString& = QString(), const int = 0, const bool = false );
 237
 238   static QtxActionGroup*   createActionGroup( const int, const bool = true );
 239
 240   static QAction*          action( const int );
 241   static int               actionId( const QAction* );
 242
 243   static void              addSetting    ( const QString&, const QString&, const double );
 244   static void              addSetting    ( const QString&, const QString&, const int );
 245   static void              addSetting    ( const QString&, const QString&, const bool, const int );
 246   static void              addSetting    ( const QString&, const QString&, const QString& );
 247   static void              addSetting    ( const QString&, const QString&, const QColor& );
 248   static int               integerSetting( const QString&, const QString&, const int = 0 );
 249   static double            doubleSetting ( const QString&, const QString&, const double = 0 );
 250   static bool              boolSetting   ( const QString&, const QString&, const bool = 0 );
 251   static QString           stringSetting ( const QString&, const QString&, const QString& = QString("") );
 252   static QColor            colorSetting  ( const QString&, const QString&, const QColor& = QColor() );
 253   static void              removeSetting ( const QString&, const QString& );
 254   static bool              hasSetting    ( const QString&, const QString& );
 255
 256   static int               addGlobalPreference( const QString& );
 257   static int               addPreference( const QString& );
 258   static int               addPreference( const QString&,
 259                                           const int, const int = PT_Auto,
 260                                           const QString& = QString(),
 261                                           const QString& = QString() );
 262   static QVariant          preferenceProperty( const int, const QString& );
 263   static void              setPreferenceProperty( const int, const QString&, const QVariant& );
 264   static void              addPreferenceProperty( const int, const QString&, const int, const QVariant& );
 265
 266   static void              message( const QString&, bool = true );
 267   static void              clearMessages();
 268
 269   static QList<int>        getViews();
 270   static int               getActiveView();
 271   static QString           getViewType( const int );
 272   static bool              setViewTitle( const int, const QString& );
 273   static QString           getViewTitle( const int );
 274   static QList<int>        findViews( const QString& );
 275   static bool              activateView( const int );
 276   static int               createView( const QString&, bool visible = true, const int width = 0, const int height = 0 );
 277   static int               createView( const QString&, QWidget* );
 278   static bool              closeView( const int );
 279   static int               cloneView( const int );
 280   static void              setViewVisible( const int id, bool visible = true );
 281   static bool              isViewVisible( const int );
 282   static void              setViewClosable( const int, const bool );
 283   static bool              isViewClosable( const int );
 284
 285   static bool              groupAllViews();
 286   static bool              splitView( const int, const Orientation, const Action );
 287   static bool              moveView( const int, const int, const bool );
 288   static QList<int>        neighbourViews( const int );
 289
 290   static void              displayCurve(const int, Plot2d_Curve*);
 291   static void              eraseCurve(const int, Plot2d_Curve*);
 292   static void              eraseCurve(Plot2d_Curve*);
 293   static void              updateCurves( const int );
 294   static QString           getPlot2dTitle(const int, ObjectType = MainTitle);
 295   static void              setPlot2dTitle(const int, const QString&, ObjectType = MainTitle, bool = true);
 296   static QList<double>     getPlot2dFitRangeByCurves(const int);
 297   static QList<double>     getPlot2dFitRangeCurrent(const int);
 298   static void              setPlot2dFitRange(const int, const double XMin, const double XMax, const double YMin, const double YMax);
 299
 300   // the following methods are obsolete
 301   static void              addStringSetting( const QString&, const QString&, bool = true );
 302   static void              addIntSetting   ( const QString&, const int,      bool = true );
 303   static void              addBoolSetting  ( const QString&, const bool,     bool = true );
 304   static void              addDoubleSetting( const QString&, const double,   bool = true );
 305   static void              removeSettings  ( const QString& );
 306   static QString           getSetting      ( const QString& );
 307
 308   static void              removeChild( const QString& = QString() );
 309 };
 310
 311 #endif // SALOME_PYQT_H