Salome HOME
Join modifications from branch OCC_development_for_3_2_0a2
[modules/gui.git] / 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 {
43   WT_ObjectBrowser,
44   WT_PyConsole,
45   WT_LogWindow,
46   WT_User
47 };
48
49 class QtxAction : QAction
50 {
51 %TypeHeaderCode
52 #include <QtxAction.h>
53 %End
54
55 private:
56   QtxAction(const QtxAction &);
57 };
58
59 class SalomePyQt
60 {
61 %HeaderCode
62 #include <SalomePyQt.h>
63 %End
64
65 public:
66   static QWidget*          getDesktop();
67   static QWidget*          getMainFrame();
68   static QMenuBar*         getMainMenuBar();
69   static QPopupMenu*       getPopupMenu( const MenuName );
70   static SALOME_Selection* getSelection() /Factory/;
71   static int               getStudyId();
72   static void              putInfo( const QString&, int = 0 );
73   static const QString     getActiveComponent();
74   static void              updateObjBrowser( int = 0, bool = true );
75
76   static QString           getFileName         ( QWidget*, const QString&, const QStringList&, const QString&, bool );
77   static QStringList       getOpenFileNames    ( QWidget*, const QString&, const QStringList&, const QString& );
78   static QString           getExistingDirectory( QWidget*, const QString&, const QString& );
79
80   static void              helpContext( const QString&, const QString& );
81
82   static bool              dumpView( const QString& );
83
84   static int               defaultMenuGroup();
85
86   static int               createTool( const QString& );
87   static int               createTool( const int,  const int,      int = -1 );
88   static int               createTool( const int,  const QString&, int = -1 );
89   static int               createTool( QtxAction*, const int,      int = -1, int = -1 );
90   static int               createTool( QtxAction*, const QString&, int = -1, int = -1 );
91
92   static int               createMenu( const QString&, const int,
93                                        int = -1, int = -1, int = -1 );
94   static int               createMenu( const QString&, const QString&, 
95                                        int = -1, int = -1, int = -1 );
96   static int               createMenu( const int,      const int,
97                                        int = -1,       int = -1 );
98   static int               createMenu( const int,      const QString&, 
99                                        int = -1,       int = -1 );
100   static int               createMenu( QtxAction*,     const int,      int = -1, 
101                                        int = -1,       int = -1 );
102   static int               createMenu( QtxAction*,     const QString&, int = -1, 
103                                        int = -1,       int = -1 );
104
105   static QtxAction*        createSeparator();
106
107   static QtxAction*        createAction( const int, const QString&, 
108                                          const QString& = QString::null, const QString& = QString::null, 
109                                          const QString& = QString::null, int = 0, bool = false );
110
111   static QtxAction*        action( const int );
112   static int               actionId( const QtxAction* );
113
114   static bool              clearMenu( int = 0, int = 0,
115                                       bool = true  );
116
117   static void              addSetting    ( const QString&, const QString&, const double );
118   static void              addSetting    ( const QString&, const QString&, const int /Constrained/ );
119   static void              addSetting    ( const QString&, const QString&, const QString& );
120   static void              addSetting    ( const QString&, const QString&, const QColor& );
121   static int               integerSetting( const QString&, const QString&, int = 0 );
122   static double            doubleSetting ( const QString&, const QString&, int = 0 );
123   static bool              boolSetting   ( const QString&, const QString&, bool = false );
124   static QString           stringSetting ( const QString&, const QString&, const QString& = QString("") );
125   static QColor            colorSetting  ( const QString&, const QString&, const QColor& = QColor() );
126   static void              removeSetting ( const QString&, const QString& );
127
128 // obsolete
129   static void              addStringSetting( const QString&, const QString&, bool = true );
130   static void              addIntSetting   ( const QString&, const int,      bool = true );
131   static void              addDoubleSetting( const QString&, const double,   bool = true );
132   static void              removeSettings  ( const QString& );
133   static QString           getSetting      ( const QString& );
134 };