1 // Copyright (C) 2007-2015 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 #ifndef SUIT_APPLICATION_H
24 #define SUIT_APPLICATION_H
39 class SUIT_ViewManager;
40 class SUIT_ResourceMgr;
41 class SUIT_ShortcutMgr;
45 #pragma warning ( disable:4251 )
49 * \brief For more information see <a href="http://doc.trolltech.com">QT documentation</a>.
52 An <b>Application</b> is a class which defines application configuration and behaviour.
53 For example Application object defines what Viewers are used in this application, what auxilliary windows
54 are present, how user can dial with them. Also Application object defines an sertain type of data structure by
55 holding of pointer on an instance of SUIT_Study class (which represents Document data structure). In other words
56 Application defines type of sata structure, type of used Viewers, type of main GUI widget (Desktop),
57 and other auxilliary tools.
60 class SUIT_EXPORT SUIT_Application : public QObject
66 virtual ~SUIT_Application();
68 //! Returns main widget (Desktop) of the application (if it exists)
69 virtual SUIT_Desktop* desktop();
71 /*! Returns FALSE if application can not be closed (because of non saved data for example).
72 This method called by SUIT_Session whin closing of application was requested. */
73 virtual bool isPossibleToClose( bool& );
75 /*! Performs some finalization of life cycle of this application.
76 For instance, the application can force its documents(s) to close. */
77 virtual void closeApplication();
79 //! Returns active Study. If Application supports wirking with several studies this method should be redefined
80 virtual SUIT_Study* activeStudy() const;
82 //! Returns Name of application. Using is not defined.
83 virtual QString applicationName() const = 0;
85 virtual QString applicationVersion() const;
87 //! Shows the application's main widget. For non GUI application must be redefined.
90 //! Opens document <theFileName> into active Study. If Study is empty - creates it.
91 virtual bool useFile( const QString& theFileName);
93 //! Creates new empty Study if active Study = 0
94 virtual void createEmptyStudy();
96 /*! Returns number of Studies.
97 * Must be redefined in Applications which support several studies for one Application instance. */
98 virtual int getNbStudies() const;
100 SUIT_ResourceMgr* resourceMgr() const;
102 SUIT_ShortcutMgr* shortcutMgr() const;
104 //! Puts the message to the status bar
105 void putInfo ( const QString&, const int = 0 );
107 //! Invokes application-specific "Open/Save File" dialog and returns the selected file name.
108 virtual QString getFileName( bool open, const QString& initial, const QString& filters,
109 const QString& caption, QWidget* parent ) = 0;
111 //! Invokes application-specific "Select Directory" dialog and returns the selected directory name.
112 virtual QString getDirectory( const QString& initial, const QString& caption, QWidget* parent ) = 0;
115 virtual int viewManagerId ( const SUIT_ViewManager* ) const = 0;
116 virtual void viewManagers( const QString&, QList<SUIT_ViewManager*>& ) const = 0;
117 QAction* action( const int ) const;
120 void applicationClosed( SUIT_Application* );
121 void activated( SUIT_Application* );
123 void infoChanged( QString );
126 virtual void updateCommandsStatus();
127 virtual void onHelpContextModule( const QString&, const QString&, const QString& = QString() );
133 SUIT_Application* startApplication( int, char** ) const;
134 SUIT_Application* startApplication( const QString&, int, char** ) const;
136 virtual void setDesktop( SUIT_Desktop* );
138 //! Creates a new Study instance. Must be redefined in new application according to its Study type.
139 virtual SUIT_Study* createNewStudy();
140 virtual void setActiveStudy( SUIT_Study* );
142 /** @name Create tool functions*/ //@{
143 int createTool( const QString&, const QString& = QString() );
144 int createTool( const int, const int, const int = -1 );
145 int createTool( const int, const QString&, const int = -1 );
146 int createTool( QAction*, const int, const int = -1, const int = -1 );
147 int createTool( QAction*, const QString&, const int = -1, const int = -1 );//@}
149 /** @name Create menu functions*/ //@{
150 int createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1 );
151 int createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
152 int createMenu( const int, const int, const int = -1, const int = -1 );
153 int createMenu( const int, const QString&, const int = -1, const int = -1 );
154 int createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
155 int createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );//@}
157 /** @name Set menu shown functions*/ //@{
158 void setMenuShown( QAction*, const bool );
159 void setMenuShown( const int, const bool );//@}
160 /** @name Set tool shown functions*/ //@{
161 void setToolShown( QAction*, const bool );
162 void setToolShown( const int, const bool );//@}
164 void setActionShown( QAction*, const bool );
165 void setActionShown( const int, const bool );
167 static QAction* separator();
168 int actionId( const QAction* ) const;
170 QList<QAction*> actions() const;
171 QList<int> actionIds() const;
173 int registerAction( const int, QAction* );
174 QAction* createAction( const int, const QString&, const QIcon&, const QString&,
175 const QString&, const int, QObject* = 0,
176 const bool = false, QObject* = 0, const char* = 0,
177 const QString& = QString() );
178 QAction* createAction( const int, const QString&, const QIcon&, const QString&,
179 const QString&, const QKeySequence&, QObject* = 0,
180 const bool = false, QObject* = 0, const char* = 0,
181 const QString& = QString() );
184 virtual void onDesktopActivated();
185 // void onDesktopMoved();
189 SUIT_Desktop* myDesktop;
190 QMap<int, QAction*> myActionMap;
191 SUIT_ShortcutMgr* myShortcutMgr;
193 QLabel* myStatusLabel;
196 //! This function must return a new application instance.
199 //jfa 22.06.2005:typedef SUIT_Application* (*APP_CREATE_FUNC)( int, char** );
200 typedef SUIT_Application* (*APP_CREATE_FUNC)();
203 #define APP_CREATE_NAME "createApplication"
206 #pragma warning ( default:4251 )