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,
117 PT_Slider = LightApp_Preferences::Slider,
118 PT_Shortcut = LightApp_Preferences::Shortcut,
119 PT_ShortcutTree = LightApp_Preferences::ShortcutTree,
120 PT_BiColor = LightApp_Preferences::BiColor,
121 PT_Background = LightApp_Preferences::Background,
122 PT_UserDefined = LightApp_Preferences::UserDefined,
125 class UserDefinedContent: public QWidget
130 explicit UserDefinedContent();
132 virtual void store();
133 virtual void retrieve();
138 Horizontal = 0, //!< Horizontal orientation
139 Vertical = 1 //!< Vertical orientation
142 //! Action of splitting corresponding to QtxWorkstack::SplitType enumeration
144 MoveWidget = 0, //!< move specified widget to the new area, other views stay in the previous area
145 LeaveWidget = 1, //!< specified widget stays in the old area, all other views are moved to the new area
146 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
149 #ifndef DISABLE_PLOT2DVIEWER
150 //! Type of titles in Plot3d View
153 MainTitle = Plot2d_ViewFrame::MainTitle,
154 XTitle = Plot2d_ViewFrame::XTitle,
155 YTitle = Plot2d_ViewFrame::YTitle,
156 Y2Title = Plot2d_ViewFrame::Y2Title,
157 XAxis = Plot2d_ViewFrame::XAxis,
158 YAxis = Plot2d_ViewFrame::YAxis,
159 Y2Axis = Plot2d_ViewFrame::Y2Axis
165 ShownState, //!< Object is shown in viewer
166 HiddenState, //!< Object is hidden in viewer
167 UnpresentableState //!< Unpresentable object
170 #ifndef DISABLE_PLOT2DVIEWER
172 yLeft = QwtPlot::yLeft,
173 yRight = QwtPlot::yRight,
174 xBottom = QwtPlot::xBottom,
175 xTop = QwtPlot::xTop,
182 static QWidget* getDesktop();
183 static QWidget* getMainFrame();
184 static QMenuBar* getMainMenuBar();
185 static QMenu* getPopupMenu( const MenuName );
186 static QMenu* getPopupMenu( const QString& );
187 static QTreeView* getObjectBrowser();
188 static void enableSelector();
189 static void disableSelector();
190 static SALOME_Selection* getSelection();
191 static void setSelection( const QStringList& );
192 static int getStudyId();
193 static void putInfo( const QString&, const int = 0 );
194 static const QString getActiveComponent();
195 static PyObject* getActivePythonModule();
196 static bool activateModule( const QString& );
197 static void updateObjBrowser( const int = 0, bool = true );
199 static bool isModified();
200 static void setModified( bool );
202 static QString getFileName ( QWidget*, const QString&, const QStringList&, const QString&, bool );
203 static QStringList getOpenFileNames ( QWidget*, const QString&, const QStringList&, const QString& );
204 static QString getExistingDirectory( QWidget*, const QString&, const QString& );
206 static void createRoot();
207 static QString createObject( const QString& parent = QString() );
208 static QString createObject( const QString&, const QString&, const QString&, const QString& = QString() );
210 static void removeObject( const QString&);
211 static void removeChildren( const QString& = QString() );
212 static QStringList getChildren( const QString& = QString(), const bool = false );
213 static void setName( const QString&, const QString& );
214 static void setIcon( const QString&, const QString& );
215 static void setToolTip( const QString&, const QString& );
216 static QString getName( const QString& );
217 static QString getToolTip( const QString& );
219 static void setVisibilityState( const QString&, VisibilityState );
220 static VisibilityState getVisibilityState( const QString& );
222 static void setObjectPosition( const QString&, int );
223 static int getObjectPosition( const QString& );
226 static void setColor( const QString&, const QColor& );
227 static QColor getColor( const QString& );
229 static void setReference( const QString&, const QString& );
230 static QString getReference( const QString& );
232 static QIcon loadIcon( const QString&, const QString& );
234 static void helpContext( const QString&, const QString& );
236 static bool dumpView( const QString&, const int = 0 );
238 static int defaultMenuGroup();
240 static int createTool( const QString&, const QString& = QString() );
241 static int createTool( const int, const int, const int = -1 );
242 static int createTool( const int, const QString&, const int = -1 );
243 static int createTool( QAction*, const int, const int = -1, const int = -1 );
244 static int createTool( QAction*, const QString&, const int = -1, const int = -1 );
246 static int createMenu( const QString&, const int = -1,
247 const int = -1, const int = -1, const int = -1 );
248 static int createMenu( const QString&, const QString& = QString(),
249 const int = -1, const int = -1, const int = -1 );
250 static int createMenu( const int, const int = -1,
251 const int = -1, const int = -1 );
252 static int createMenu( const int, const QString& = QString(),
253 const int = -1, const int = -1 );
254 static int createMenu( QAction*, const int, const int = -1,
255 const int = -1, const int = -1 );
256 static int createMenu( QAction*, const QString&, const int = -1,
257 const int = -1, const int = -1 );
259 static QAction* createSeparator();
261 static QAction* createAction( const int, const QString&,
262 const QString& = QString(), const QString& = QString(),
263 const QString& = QString(), const int = 0, const bool = false );
265 static QtxActionGroup* createActionGroup( const int, const bool = true );
267 static QAction* action( const int );
268 static int actionId( const QAction* );
270 static QString constant ( const QString& );
271 static void setConstant ( const QString&, const QString& );
272 static void addSetting ( const QString&, const QString&, const double );
273 static void addSetting ( const QString&, const QString&, const int );
274 static void addSetting ( const QString&, const QString&, const bool, const int );
275 static void addSetting ( const QString&, const QString&, const QString& );
276 static void addSetting ( const QString&, const QString&, const QColor& );
277 static void addSetting ( const QString&, const QString&, const QByteArray& );
278 static int integerSetting( const QString&, const QString&, const int = 0 );
279 static double doubleSetting ( const QString&, const QString&, const double = 0 );
280 static bool boolSetting ( const QString&, const QString&, const bool = 0 );
281 static QString stringSetting ( const QString&, const QString&, const QString& = QString(""), const bool = true );
282 static QColor colorSetting ( const QString&, const QString&, const QColor& = QColor() );
283 static QByteArray byteArraySetting( const QString&, const QString&, const QByteArray& = QByteArray() );
284 static void removeSetting ( const QString&, const QString& );
285 static bool hasSetting ( const QString&, const QString& );
286 static QStringList parameters ( const QString& );
287 static QStringList parameters ( const QStringList& );
289 static int addGlobalPreference( const QString& );
290 static int addPreference( const QString& );
291 static int addPreference( const QString&,
292 const int, const int = PT_Auto,
293 const QString& = QString(),
294 const QString& = QString() );
295 static QVariant preferenceProperty( const int, const QString& );
296 static void setPreferenceProperty( const int, const QString&, const QVariant& );
297 static void setPreferencePropertyWg( const int, const QString&, UserDefinedContent* );
298 static void addPreferenceProperty( const int, const QString&, const int, const QVariant& );
300 static void message( const QString&, bool = true );
301 static void clearMessages();
303 static QList<int> getViews();
304 static int getActiveView();
305 static QString getViewType( const int );
306 static bool setViewTitle( const int, const QString& );
307 static QString getViewTitle( const int );
308 static bool setViewSize( const int, const int, const int = 0 );
309 static QList<int> findViews( const QString& );
310 static bool activateView( const int );
311 static bool activateViewManagerAndView( const int );
312 static QWidget* getViewWidget( const int );
313 static int createView( const QString&, bool visible = true, const int width = 0, const int height = 0, bool detached = false );
314 static int createView( const QString&, QWidget* );
315 static bool closeView( const int );
316 static int cloneView( const int );
317 static void setViewVisible( const int id, bool visible = true );
318 static bool isViewVisible( const int );
319 static void setViewClosable( const int, const bool );
320 static bool isViewClosable( const int );
322 static bool groupAllViews();
323 static bool splitView( const int, const Orientation, const Action );
324 static bool moveView( const int, const int, const bool );
325 static QList<int> neighbourViews( const int );
327 #ifndef DISABLE_PLOT2DVIEWER
328 static void displayCurve(const int, Plot2d_Curve*);
329 static void eraseCurve(const int, Plot2d_Curve*);
330 static void eraseCurve(Plot2d_Curve*);
331 static void updateCurves( const int );
332 static QString getPlot2dTitle(const int, ObjectType = MainTitle);
333 static void setPlot2dTitle(const int, const QString&, ObjectType = MainTitle, bool = true);
334 static QList<double> getPlot2dFitRangeByCurves(const int);
335 static QList<double> getPlot2dFitRangeCurrent(const int);
336 static void setPlot2dFitRange(const int, const double XMin, const double XMax, const double YMin, const double YMax);
339 // static void initializeParaViewGUI();
340 static void processEvents();
342 // the following methods are obsolete
343 static void addStringSetting( const QString&, const QString&, bool = true );
344 static void addIntSetting ( const QString&, const int, bool = true );
345 static void addBoolSetting ( const QString&, const bool, bool = true );
346 static void addDoubleSetting( const QString&, const double, bool = true );
347 static void removeSettings ( const QString& );
348 static QString getSetting ( const QString& );
350 static void removeChild( const QString& = QString() );
352 static void startPyLog(const QString&);
353 static void stopPyLog();
357 #endif // SALOME_PYQT_H