1 // Copyright (C) 2007-2012 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.
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
38 class SUIT_ViewManager;
39 class SUIT_ResourceMgr;
40 class SUIT_ShortcutMgr;
44 #pragma warning ( disable:4251 )
48 * \brief For more information see <a href="http://doc.trolltech.com">QT documentation</a>.
51 An <b>Application</b> is a class which defines application configuration and behaviour.
52 For example Application object defines what Viewers are used in this application, what auxilliary windows
53 are present, how user can dial with them. Also Application object defines an sertain type of data structure by
54 holding of pointer on an instance of SUIT_Study class (which represents Document data structure). In other words
55 Application defines type of sata structure, type of used Viewers, type of main GUI widget (Desktop),
56 and other auxilliary tools.
59 class SUIT_EXPORT SUIT_Application : public QObject
65 virtual ~SUIT_Application();
67 //! Returns main widget (Desktop) of the application (if it exists)
68 virtual SUIT_Desktop* desktop();
70 /*! Returns FALSE if application can not be closed (because of non saved data for example).
71 This method called by SUIT_Session whin closing of application was requested. */
72 virtual bool isPossibleToClose( bool& );
74 /*! Performs some finalization of life cycle of this application.
75 For instance, the application can force its documents(s) to close. */
76 virtual void closeApplication();
78 //! Returns active Study. If Application supports wirking with several studies this method should be redefined
79 virtual SUIT_Study* activeStudy() const;
81 //! Returns Name of application. Using is not defined.
82 virtual QString applicationName() const = 0;
84 virtual QString applicationVersion() const;
86 //! Shows the application's main widget. For non GUI application must be redefined.
89 //! Opens document <theFileName> into active Study. If Study is empty - creates it.
90 virtual bool useFile( const QString& theFileName);
92 //! Creates new empty Study if active Study = 0
93 virtual void createEmptyStudy();
95 /*! Returns number of Studies.
96 * Must be redefined in Applications which support several studies for one Application instance. */
97 virtual int getNbStudies() const;
99 SUIT_ResourceMgr* resourceMgr() const;
101 SUIT_ShortcutMgr* shortcutMgr() const;
103 //! Puts the message to the status bar
104 void putInfo ( const QString&, const int = 0 );
106 //! Invokes application-specific "Open/Save File" dialog and returns the selected file name.
107 virtual QString getFileName( bool open, const QString& initial, const QString& filters,
108 const QString& caption, QWidget* parent ) = 0;
110 //! Invokes application-specific "Select Directory" dialog and returns the selected directory name.
111 virtual QString getDirectory( const QString& initial, const QString& caption, QWidget* parent ) = 0;
114 virtual int viewManagerId ( const SUIT_ViewManager* ) const = 0;
115 virtual void viewManagers( const QString&, QList<SUIT_ViewManager*>& ) const = 0;
116 QAction* action( const int ) const;
119 void applicationClosed( SUIT_Application* );
120 void activated( SUIT_Application* );
121 void infoChanged( QString );
124 virtual void updateCommandsStatus();
125 virtual void onHelpContextModule( const QString&, const QString&, const QString& = QString() );
131 SUIT_Application* startApplication( int, char** ) const;
132 SUIT_Application* startApplication( const QString&, int, char** ) const;
134 virtual void setDesktop( SUIT_Desktop* );
136 //! Creates a new Study instance. Must be redefined in new application according to its Study type.
137 virtual SUIT_Study* createNewStudy();
138 virtual void setActiveStudy( SUIT_Study* );
140 /** @name Create tool functions*/ //@{
141 int createTool( const QString& );
142 int createTool( const int, const int, const int = -1 );
143 int createTool( const int, const QString&, const int = -1 );
144 int createTool( QAction*, const int, const int = -1, const int = -1 );
145 int createTool( QAction*, const QString&, const int = -1, const int = -1 );//@}
147 /** @name Create menu functions*/ //@{
148 int createMenu( const QString&, const int, const int = -1, const int = -1, const int = -1 );
149 int createMenu( const QString&, const QString&, const int = -1, const int = -1, const int = -1 );
150 int createMenu( const int, const int, const int = -1, const int = -1 );
151 int createMenu( const int, const QString&, const int = -1, const int = -1 );
152 int createMenu( QAction*, const int, const int = -1, const int = -1, const int = -1 );
153 int createMenu( QAction*, const QString&, const int = -1, const int = -1, const int = -1 );//@}
155 /** @name Set menu shown functions*/ //@{
156 void setMenuShown( QAction*, const bool );
157 void setMenuShown( const int, const bool );//@}
158 /** @name Set tool shown functions*/ //@{
159 void setToolShown( QAction*, const bool );
160 void setToolShown( const int, const bool );//@}
162 void setActionShown( QAction*, const bool );
163 void setActionShown( const int, const bool );
165 static QAction* separator();
166 int actionId( const QAction* ) const;
168 QList<QAction*> actions() const;
169 QList<int> actionIds() const;
171 int registerAction( const int, QAction* );
172 QAction* createAction( const int, const QString&, const QIcon&, const QString&,
173 const QString&, const int, QObject* = 0,
174 const bool = false, QObject* = 0, const char* = 0,
175 const QString& = QString() );
178 virtual void onDesktopActivated();
182 SUIT_Desktop* myDesktop;
183 QMap<int, QAction*> myActionMap;
184 SUIT_ShortcutMgr* myShortcutMgr;
186 QLabel* myStatusLabel;
189 //! This function must return a new application instance.
192 //jfa 22.06.2005:typedef SUIT_Application* (*APP_CREATE_FUNC)( int, char** );
193 typedef SUIT_Application* (*APP_CREATE_FUNC)();
196 #define APP_CREATE_NAME "createApplication"
199 #pragma warning ( default:4251 )