1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 // File : SalomePyQt.h
24 // Author : Vadim SANDLER, Open CASCADE S.A.S. (vadim.sandler@opencascade.com)
35 #include <LightApp_Application.h>
36 #ifndef GUI_DISABLE_CORBA
37 #include <SalomeApp_Application.h>
39 #include <LightApp_Preferences.h>
40 #ifndef DISABLE_PLOT2DVIEWER
41 #include <Plot2d_ViewFrame.h>
44 class LightApp_SelectionMgr;
51 #ifndef DISABLE_PLOT2DVIEWER
55 class SALOME_Selection : public QObject
61 static SALOME_Selection* GetSelection( LightApp_Application* );
68 void currentSelectionChanged();
71 void onSelMgrDestroyed();
74 LightApp_SelectionMgr* mySelMgr;
75 SALOME_Selection( QObject* );
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
96 WT_User = LightApp_Application::WT_User
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,
121 Horizontal = 0, //!< Horizontal orientation
122 Vertical = 1 //!< Vertical orientation
125 //! Action of splitting corresponding to QtxWorkstack::SplitType enumeration
127 MoveWidget = 0, //!< move specified widget to the new area, other views stay in the previous area
128 LeaveWidget = 1, //!< specified widget stays in the old area, all other views are moved to the new area
129 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
132 #ifndef DISABLE_PLOT2DVIEWER
133 //! Type of titles in Plot3d View
136 MainTitle = Plot2d_ViewFrame::MainTitle,
137 XTitle = Plot2d_ViewFrame::XTitle,
138 YTitle = Plot2d_ViewFrame::YTitle,
139 Y2Title = Plot2d_ViewFrame::Y2Title,
140 XAxis = Plot2d_ViewFrame::XAxis,
141 YAxis = Plot2d_ViewFrame::YAxis,
142 Y2Axis = Plot2d_ViewFrame::Y2Axis
148 ShownState, //!< Object is shown in viewer
149 HiddenState, //!< Object is hidden in viewer
150 UnpresentableState //!< Unpresentable object
153 #ifndef DISABLE_PLOT2DVIEWER
155 yLeft = QwtPlot::yLeft,
156 yRight = QwtPlot::yRight,
157 xBottom = QwtPlot::xBottom,
158 xTop = QwtPlot::xTop,
165 static QWidget* getDesktop();
166 static QWidget* getMainFrame();
167 static QMenuBar* getMainMenuBar();
168 static QMenu* getPopupMenu( const MenuName );
169 static QMenu* getPopupMenu( const QString& );
170 static QTreeView* getObjectBrowser();
171 static SALOME_Selection* getSelection();
172 static int getStudyId();
173 static void putInfo( const QString&, const int = 0 );
174 static const QString getActiveComponent();
175 static PyObject* getActivePythonModule();
176 static bool activateModule( const QString& );
177 static void updateObjBrowser( const int = 0, bool = true );
179 static bool isModified();
180 static void setModified( bool );
182 static QString getFileName ( QWidget*, const QString&, const QStringList&, const QString&, bool );
183 static QStringList getOpenFileNames ( QWidget*, const QString&, const QStringList&, const QString& );
184 static QString getExistingDirectory( QWidget*, const QString&, const QString& );
186 static void createRoot();
187 static QString createObject( const QString& parent = QString() );
188 static QString createObject( const QString&, const QString&, const QString&, const QString& = QString() );
190 static void removeObject( const QString&);
191 static void removeChildren( const QString& = QString() );
192 static QStringList getChildren( const QString& = QString(), const bool = false );
193 static void setName( const QString&, const QString& );
194 static void setIcon( const QString&, const QString& );
195 static void setToolTip( const QString&, const QString& );
196 static QString getName( const QString& );
197 static QString getToolTip( const QString& );
199 static void setVisibilityState( const QString&, VisibilityState );
200 static VisibilityState getVisibilityState( const QString& );
202 static void setObjectPosition( const QString&, int );
203 static int getObjectPosition( const QString& );
206 static void setColor( const QString&, const QColor& );
207 static QColor getColor( const QString& );
209 static void setReference( const QString&, const QString& );
210 static QString getReference( const QString& );
212 static QIcon loadIcon( const QString&, const QString& );
214 static void helpContext( const QString&, const QString& );
216 static bool dumpView( const QString&, const int = 0 );
218 static int defaultMenuGroup();
220 static int createTool( const QString&, const QString& = QString() );
221 static int createTool( const int, const int, const int = -1 );
222 static int createTool( const int, const QString&, const int = -1 );
223 static int createTool( QAction*, const int, const int = -1, const int = -1 );
224 static int createTool( QAction*, const QString&, const int = -1, const int = -1 );
226 static int createMenu( const QString&, const int = -1,
227 const int = -1, const int = -1, const int = -1 );
228 static int createMenu( const QString&, const QString& = QString(),
229 const int = -1, const int = -1, const int = -1 );
230 static int createMenu( const int, const int = -1,
231 const int = -1, const int = -1 );
232 static int createMenu( const int, const QString& = QString(),
233 const int = -1, const int = -1 );
234 static int createMenu( QAction*, const int, const int = -1,
235 const int = -1, const int = -1 );
236 static int createMenu( QAction*, const QString&, const int = -1,
237 const int = -1, const int = -1 );
239 static QAction* createSeparator();
241 static QAction* createAction( const int, const QString&,
242 const QString& = QString(), const QString& = QString(),
243 const QString& = QString(), const int = 0, const bool = false );
245 static QtxActionGroup* createActionGroup( const int, const bool = true );
247 static QAction* action( const int );
248 static int actionId( const QAction* );
250 static QString constant ( const QString& );
251 static void setConstant ( const QString&, const QString& );
252 static void addSetting ( const QString&, const QString&, const double );
253 static void addSetting ( const QString&, const QString&, const int );
254 static void addSetting ( const QString&, const QString&, const bool, const int );
255 static void addSetting ( const QString&, const QString&, const QString& );
256 static void addSetting ( const QString&, const QString&, const QColor& );
257 static void addSetting ( const QString&, const QString&, const QByteArray& );
258 static int integerSetting( const QString&, const QString&, const int = 0 );
259 static double doubleSetting ( const QString&, const QString&, const double = 0 );
260 static bool boolSetting ( const QString&, const QString&, const bool = 0 );
261 static QString stringSetting ( const QString&, const QString&, const QString& = QString(""), const bool = true );
262 static QColor colorSetting ( const QString&, const QString&, const QColor& = QColor() );
263 static QByteArray byteArraySetting( const QString&, const QString&, const QByteArray& = QByteArray() );
264 static void removeSetting ( const QString&, const QString& );
265 static bool hasSetting ( const QString&, const QString& );
266 static QStringList parameters ( const QString& );
267 static QStringList parameters ( const QStringList& );
269 static int addGlobalPreference( const QString& );
270 static int addPreference( const QString& );
271 static int addPreference( const QString&,
272 const int, const int = PT_Auto,
273 const QString& = QString(),
274 const QString& = QString() );
275 static QVariant preferenceProperty( const int, const QString& );
276 static void setPreferenceProperty( const int, const QString&, const QVariant& );
277 static void addPreferenceProperty( const int, const QString&, const int, const QVariant& );
279 static void message( const QString&, bool = true );
280 static void clearMessages();
282 static QList<int> getViews();
283 static int getActiveView();
284 static QString getViewType( const int );
285 static bool setViewTitle( const int, const QString& );
286 static QString getViewTitle( const int );
287 static bool setViewSize( const int, const int, const int = 0 );
288 static QList<int> findViews( const QString& );
289 static bool activateView( const int );
290 static bool activateViewManagerAndView( const int );
291 static QWidget* getViewWidget( const int );
292 static int createView( const QString&, bool visible = true, const int width = 0, const int height = 0 );
293 static int createView( const QString&, QWidget* );
294 static bool closeView( const int );
295 static int cloneView( const int );
296 static void setViewVisible( const int id, bool visible = true );
297 static bool isViewVisible( const int );
298 static void setViewClosable( const int, const bool );
299 static bool isViewClosable( const int );
301 static bool groupAllViews();
302 static bool splitView( const int, const Orientation, const Action );
303 static bool moveView( const int, const int, const bool );
304 static QList<int> neighbourViews( const int );
306 #ifndef DISABLE_PLOT2DVIEWER
307 static void displayCurve(const int, Plot2d_Curve*);
308 static void eraseCurve(const int, Plot2d_Curve*);
309 static void eraseCurve(Plot2d_Curve*);
310 static void updateCurves( const int );
311 static QString getPlot2dTitle(const int, ObjectType = MainTitle);
312 static void setPlot2dTitle(const int, const QString&, ObjectType = MainTitle, bool = true);
313 static QList<double> getPlot2dFitRangeByCurves(const int);
314 static QList<double> getPlot2dFitRangeCurrent(const int);
315 static void setPlot2dFitRange(const int, const double XMin, const double XMax, const double YMin, const double YMax);
318 // static void initializeParaViewGUI();
319 static void processEvents();
321 // the following methods are obsolete
322 static void addStringSetting( const QString&, const QString&, bool = true );
323 static void addIntSetting ( const QString&, const int, bool = true );
324 static void addBoolSetting ( const QString&, const bool, bool = true );
325 static void addDoubleSetting( const QString&, const double, bool = true );
326 static void removeSettings ( const QString& );
327 static QString getSetting ( const QString& );
329 static void removeChild( const QString& = QString() );
331 static void startPyLog(const QString&);
332 static void stopPyLog();
336 #endif // SALOME_PYQT_H