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