src/SALOME_PYQT/SalomePyQt/SalomePyQt.sip

   1 //=============================================================================
   2 // File      : SalomePyQt.sip
   3 // Created   : 25/04/05
   4 // Author    : Vadim SANDLER
   5 // Project   : SALOME
   6 // Copyright : 2003-2005 CEA/DEN, EDF R&D
   7 // $Header   : $
   8 //=============================================================================
   9
  10 %Module SalomePyQt
  11
  12 %Import qtmod.sip
  13
  14 class SALOME_Selection : QObject
  15 {
  16 %HeaderCode
  17 #include <SalomePyQt.h>
  18 %End
  19
  20 public:
  21   void Clear();
  22   void ClearIObjects();
  23   void ClearFilters();
  24
  25 private:
  26   SALOME_Selection( QObject* /TransferThis/ );
  27
  28 signals:
  29   void currentSelectionChanged();
  30 };
  31
  32 enum MenuName {
  33   File        = 1,
  34   View        = 2,
  35   Edit        = 3,
  36   Preferences = 4,
  37   Tools       = 5,
  38   Window      = 6,
  39   Help        = 7
  40 };
  41
  42 enum WindowType {
  43   WT_ObjectBrowser,
  44   WT_PyConsole,
  45   WT_LogWindow,
  46   WT_User
  47 };
  48
  49 enum PrefType {
  50   PT_Space,
  51   PT_Bool,
  52   PT_Color,
  53   PT_String,
  54   PT_Selector,
  55   PT_DblSpin,
  56   PT_IntSpin,
  57   PT_Double,
  58   PT_Integer,
  59   PT_GroupBox,
  60   PT_Font,
  61   PT_DirList,
  62   PT_File,
  63   PT_User
  64 };
  65
  66 class QtxAction : QAction
  67 {
  68 %TypeHeaderCode
  69 #include <QtxAction.h>
  70 %End
  71
  72 private:
  73   QtxAction(const QtxAction &);
  74 };
  75
  76 class SalomePyQt
  77 {
  78 %HeaderCode
  79 #include <SalomePyQt.h>
  80 %End
  81
  82 public:
  83   static QWidget*          getDesktop();
  84   static QWidget*          getMainFrame();
  85   static QMenuBar*         getMainMenuBar();
  86   static QPopupMenu*       getPopupMenu( const MenuName );
  87   static SALOME_Selection* getSelection() /Factory/;
  88   static int               getStudyId();
  89   static void              putInfo( const QString&, int = 0 );
  90   static const QString     getActiveComponent();
  91   static void              updateObjBrowser( int = 0, bool = true );
  92
  93   static QString           getFileName         ( QWidget*, const QString&, const QStringList&, const QString&, bool );
  94   static QStringList       getOpenFileNames    ( QWidget*, const QString&, const QStringList&, const QString& );
  95   static QString           getExistingDirectory( QWidget*, const QString&, const QString& );
  96
  97   static void              helpContext( const QString&, const QString& );
  98
  99   static bool              dumpView( const QString& );
 100
 101   static int               defaultMenuGroup();
 102
 103   static int               createTool( const QString& );
 104   static int               createTool( const int,  const int,      int = -1 );
 105   static int               createTool( const int,  const QString&, int = -1 );
 106   static int               createTool( QtxAction*, const int,      int = -1, int = -1 );
 107   static int               createTool( QtxAction*, const QString&, int = -1, int = -1 );
 108
 109   static int               createMenu( const QString&, const int,
 110                                        int = -1, int = -1, int = -1 );
 111   static int               createMenu( const QString&, const QString&,
 112                                        int = -1, int = -1, int = -1 );
 113   static int               createMenu( const int,      const int,
 114                                        int = -1,       int = -1 );
 115   static int               createMenu( const int,      const QString&,
 116                                        int = -1,       int = -1 );
 117   static int               createMenu( QtxAction*,     const int,      int = -1,
 118                                        int = -1,       int = -1 );
 119   static int               createMenu( QtxAction*,     const QString&, int = -1,
 120                                        int = -1,       int = -1 );
 121
 122   static QtxAction*        createSeparator();
 123
 124   static QtxAction*        createAction( const int, const QString&,
 125                                          const QString& = QString::null, const QString& = QString::null,
 126                                          const QString& = QString::null, int = 0, bool = false );
 127
 128   static QtxAction*        action( const int );
 129   static int               actionId( const QtxAction* );
 130
 131   static bool              clearMenu( int = 0, int = 0,
 132                                       bool = true  );
 133
 134   static void              addSetting    ( const QString&, const QString&, const double );
 135   static void              addSetting    ( const QString&, const QString&, const int /Constrained/ );
 136   static void              addSetting    ( const QString&, const QString&, const bool, const int );
 137   static void              addSetting    ( const QString&, const QString&, const QString& );
 138   static void              addSetting    ( const QString&, const QString&, const QColor& );
 139   static int               integerSetting( const QString&, const QString&, int = 0 );
 140   static double            doubleSetting ( const QString&, const QString&, double = 0 );
 141   static bool              boolSetting   ( const QString&, const QString&, bool = false );
 142   static QString           stringSetting ( const QString&, const QString&, const QString& = QString("") );
 143   static QColor            colorSetting  ( const QString&, const QString&, const QColor& = QColor() );
 144   static void              removeSetting ( const QString&, const QString& );
 145   static bool              hasSetting    ( const QString&, const QString& );
 146
 147 // obsolete
 148   static void              addStringSetting( const QString&, const QString&, bool = true );
 149   static void              addIntSetting   ( const QString&, const int,      bool = true );
 150   static void              addDoubleSetting( const QString&, const double,   bool = true );
 151   static void              addBoolSetting  ( const QString&, const bool,     bool = true );
 152   static void              removeSettings  ( const QString& );
 153   static QString           getSetting      ( const QString& );
 154
 155   static int               addGlobalPreference( const QString& );
 156   static int               addPreference( const QString& );
 157   static int               addPreference( const QString&, const int, int = -1,
 158                                           const QString& = QString::null,
 159                                           const QString& = QString::null );
 160   static QVariant          preferenceProperty( const int, const QString& );
 161   static void              setPreferenceProperty( const int,
 162                                                   const QString&,
 163                                                   const QVariant& );
 164   static void              addPreferenceProperty( const int,
 165                                                   const QString&,
 166                                                   const int,
 167                                                   const QVariant& );
 168
 169   static void              message( const QString&, bool = true );
 170   static void              clearMessages();
 171 };