Introduces an application class which provides modular architecture. More...

#include <CAM_Application.h>

Inheritance diagram for CAM_Application:

Data Structures
struct	ModuleInfo
Public Types
typedef QList< CAM_Module * >	ModuleList
enum	{ MenuFileId, FileNewId, FileOpenId, FileReopenId, FileCloseId, FileSaveId, FileSaveAsId, FileExitId, MenuViewId, ViewWindowsId, ViewToolBarsId, ViewStatusBarId, NewWindowId, MenuEditId, EditCutId, EditCopyId, EditPasteId, MenuHelpId, HelpAboutId, UserID }
Public Slots
virtual void	onNewDoc ()
virtual bool	onNewDoc (const QString &)
virtual void	onCloseDoc (bool ask=true)
virtual void	onSaveDoc ()
virtual bool	onSaveAsDoc ()
virtual void	onOpenDoc ()
virtual bool	onOpenDoc (const QString &)
virtual bool	onReopenDoc ()
virtual void	onExit ()
virtual void	onCopy ()
virtual void	onPaste ()
virtual void	onViewStatusBar (bool)
virtual void	onHelpAbout ()
virtual void	onDesktopClosing (SUIT_Desktop , QCloseEvent )
virtual void	onConnectPopupRequest (SUIT_PopupClient , QContextMenuEvent )
virtual void	onHelpContextModule (const QString &, const QString &, const QString &=QString())
Signals
void	viewManagerAdded (SUIT_ViewManager *)
void	viewManagerRemoved (SUIT_ViewManager *)
void	viewManagerActivated (SUIT_ViewManager *)
void	applicationClosed (SUIT_Application *)
void	activated (SUIT_Application *)
void	infoChanged (QString)
Public Member Functions
	CAM_Application (const bool=true)
	Constructor.
virtual	~CAM_Application ()
	Destructor.
virtual void	start ()
	Start an application.
CAM_Module *	activeModule () const
	Get active module.
CAM_Module *	module (const QString &) const
	Get the module with specified name.
ModuleList	modules () const
	Get all loaded modules.
void	modules (ModuleList &) const
	Get all loaded modules.
void	modules (QStringList &, const bool loaded=true) const
	Get names of all modules.
virtual void	addModule (CAM_Module *)
	Add module mod to the modules list.
virtual void	loadModules ()
	Load modules from the modules information list.
virtual CAM_Module *	loadModule (const QString &, const bool=true)
	Load module modName.
virtual bool	activateModule (const QString &)
	Activate module modName.
virtual void	contextMenuPopup (const QString &, QMenu *, QString &)
	Add common menu items to the popup menu.
QString	moduleName (const QString &) const
	Get module name by its title (user name).
QString	moduleTitle (const QString &) const
	Get module title (user name) by its name.
QString	moduleIcon (const QString &) const
	Get module icon name.
bool	isModuleAccessible (const QString &) const
	Returns `true` if module is accessible for the current application. Singleton module can be loaded only in one application object. In other application objects this module will be unavailable.
virtual void	createEmptyStudy ()
	Create new empty study.
virtual QString	applicationName () const
virtual bool	isPossibleToClose (bool &)
virtual bool	useFile (const QString &)
void	setEditEnabled (const bool)
bool	isEditEnabled () const
void	clearViewManagers ()
virtual void	addViewManager (SUIT_ViewManager *)
virtual void	removeViewManager (SUIT_ViewManager *)
SUIT_ViewManager *	activeViewManager () const
SUIT_ViewManager *	viewManager (const QString &) const
bool	containsViewManager (SUIT_ViewManager *) const
ViewManagerList	viewManagers () const
void	viewManagers (ViewManagerList &) const
void	viewManagers (const QString &, ViewManagerList &) const
virtual int	viewManagerId (const SUIT_ViewManager *) const
virtual QString	getFileFilter () const
virtual QString	getFileName (bool open, const QString &initial, const QString &filters, const QString &caption, QWidget *parent)
QString	getDirectory (const QString &initial, const QString &caption, QWidget *parent)
virtual void	closeApplication ()
bool	exitConfirmation () const
void	setExitConfirmation (const bool)
virtual void	updateDesktopTitle ()
virtual SUIT_Desktop *	desktop ()
	Returns main widget (Desktop) of the application (if it exists)
virtual SUIT_Study *	activeStudy () const
	Returns active Study. If Application supports wirking with several studies this method should be redefined.
virtual QString	applicationVersion () const
virtual int	getNbStudies () const
SUIT_ResourceMgr *	resourceMgr () const
SUIT_ShortcutMgr *	shortcutMgr () const
	Get access to shortcut manager.
void	putInfo (const QString &, const int=0)
	Puts the message to the status bar.
Protected Types
enum	{ OpenCancel, OpenNew, OpenExist }
enum	{ CloseCancel, CloseSave, CloseDiscard }
Protected Slots
virtual void	onDesktopActivated ()
Protected Member Functions
virtual SUIT_Study *	createNewStudy ()
	Create new study.
virtual void	updateCommandsStatus ()
	Update menu commands status.
virtual void	moduleAdded (CAM_Module *)
	Callback function, called when the module is added to the application.
virtual void	beforeCloseDoc (SUIT_Study *)
	Prepare application to study closing.
virtual void	afterCloseDoc ()
virtual bool	activateModule (CAM_Module *=0)
	Activate module mod.
virtual void	setActiveStudy (SUIT_Study *)
	Set active study.
QString	moduleLibrary (const QString &, const bool=true) const
	Get module library name by its title (user name).
virtual void	createActions ()
virtual void	setDesktop (SUIT_Desktop *)
virtual void	loadPreferences ()
virtual void	savePreferences ()
virtual void	studySaved (SUIT_Study *)
virtual void	studyOpened (SUIT_Study *)
virtual void	studyCreated (SUIT_Study *)
virtual void	setActiveViewManager (SUIT_ViewManager *)
virtual int	openChoice (const QString &)
virtual bool	openAction (const int, const QString &)
virtual int	closeChoice (const QString &)
virtual bool	closeAction (const int, bool &)
SUIT_Application *	startApplication (int, char **) const
SUIT_Application *	startApplication (const QString &, int, char **) const
void	setActionShown (QAction *, const bool)
void	setActionShown (const int, const bool)
QAction *	action (const int) const
int	actionId (const QAction *) const
QList< QAction * >	actions () const
QList< int >	actionIds () const
int	registerAction (const int, QAction *)
QAction *	createAction (const int, const QString &, const QIcon &, const QString &, const QString &, const int, QObject =0, const bool=false, QObject =0, const char *=0, const QString &=QString())
Create tool functions
int	createTool (const QString &)
int	createTool (const int, const int, const int=-1)
int	createTool (const int, const QString &, const int=-1)
int	createTool (QAction *, const int, const int=-1, const int=-1)
int	createTool (QAction *, const QString &, const int=-1, const int=-1)
Create menu functions
int	createMenu (const QString &, const int, const int=-1, const int=-1, const int=-1)
int	createMenu (const QString &, const QString &, const int=-1, const int=-1, const int=-1)
int	createMenu (const int, const int, const int=-1, const int=-1)
int	createMenu (const int, const QString &, const int=-1, const int=-1)
int	createMenu (QAction *, const int, const int=-1, const int=-1, const int=-1)
int	createMenu (QAction *, const QString &, const int=-1, const int=-1, const int=-1)
Set menu shown functions
void	setMenuShown (QAction *, const bool)
void	setMenuShown (const int, const bool)
Set tool shown functions
void	setToolShown (QAction *, const bool)
void	setToolShown (const int, const bool)
Static Protected Member Functions
static QAction *	separator ()
Private Types
typedef QList< ModuleInfo >	ModuleInfoList
Private Member Functions
void	readModuleList ()
	Read modules information list.
Private Attributes
CAM_Module *	myModule
	active module
ModuleList	myModules
	loaded modules list
ModuleInfoList	myInfoList
	modules info list
bool	myAutoLoad
	auto loading flag

Detailed Description

This class defines multi-modular application configuration and behaviour. Each module (CAM_Module) can have own data model, document windows and viewers, etc.

An application provides all necessary functionality for modules management, like

loading of modules
modules activation/deactivation
etc

Member Typedef Documentation

typedef QList<CAM_Module*> CAM_Application.ModuleList

typedef QList<ModuleInfo> CAM_Application.ModuleInfoList [private]

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

MenuFileId
FileNewId
FileOpenId
FileReopenId
FileCloseId
FileSaveId
FileSaveAsId
FileExitId
MenuViewId
ViewWindowsId
ViewToolBarsId
ViewStatusBarId
NewWindowId
MenuEditId
EditCutId
EditCopyId
EditPasteId
MenuHelpId
HelpAboutId
UserID

anonymous enum [protected, inherited]

Enumerator:

OpenCancel
OpenNew
OpenExist

anonymous enum [protected, inherited]

Enumerator:

CloseCancel
CloseSave
CloseDiscard

Constructor & Destructor Documentation

CAM_Application::CAM_Application ( const bool autoLoad = true )

Read modules list (from command line or from resource file). If autoLoad parameter is true all the modules will be loaded immediately after application starting, otherwise each module will be loaded by demand (with activateModule()).

Parameters:

autoLoad auto loading flag

References readModuleList().

CAM_Application::~CAM_Application ( ) [virtual]

Does nothing currently.

References myModules.

Member Function Documentation

void CAM_Application::start ( ) [virtual]

Load all modules, if "auto loading" flag has been set to true.

See also:: CAM_Application()

Reimplemented from STD_Application.

Reimplemented in LightApp_Application, and SalomeApp_Application.

References loadModules(), and myAutoLoad.

CAM_Module * CAM_Application::activeModule ( ) const

Returns:: active module or 0 if there are no any

References myModule.

CAM_Module * CAM_Application::module ( const QString & modName ) const

Returns:: module or 0 if not found

References myModules.

CAM_Application::ModuleList CAM_Application::modules ( ) const

Returns:: list of modules

References myModules.

void CAM_Application::modules ( CAM_Application::ModuleList & out ) const

Parameters:

returning list of modules

References myModules.

void CAM_Application::modules	(	QStringList &	lst,
		const bool	loaded = `true`
	)		const

Get loaded modules names if loaded is true, otherwise get all avaiable modules names.

Parameters:

lst	output list of modules names
loaded	boolean flag, defines what modules names to return

References myInfoList, and myModules.

void CAM_Application::addModule ( CAM_Module * mod ) [virtual]

Performes module initialization. Does nothing if the module is already added.

Parameters:

mod	module being added

See also:: CAM_Module.initialize()

References CAM_Module.initialize(), module(), moduleAdded(), CAM_Module.moduleName(), myInfoList, and myModules.

void CAM_Application::loadModules ( ) [virtual]

If some module can not be loaded, an error message is shown.

References addModule(), SUIT_MessageBox.critical(), SUIT_Application.desktop(), isModuleAccessible(), loadModule(), and myInfoList.

CAM_Module * CAM_Application::loadModule	(	const QString &	modName,
		const bool	showMsg = `true`
	)		`[virtual]`

The function prints warning message if:

modules information list is empty
modules information list does not include specified module info
module library can not be loaded by some reason

Parameters:

modName module name

Returns:: module object pointer or 0 if module could not be loaded

Reimplemented in LightApp_Application.

References SUIT_Application.desktop(), GET_MODULE_NAME, isModuleAccessible(), module(), moduleLibrary(), moduleName(), myInfoList, CAM_Module.setModuleName(), CAM_Module.setName(), and SUIT_MessageBox.warning().

bool CAM_Application::activateModule ( const QString & modName ) [virtual]

Parameters:

modName module name

Returns:: true, if module is loaded and activated successfully and false otherwise

Reimplemented in LightApp_Application.

References SUIT_Application.activeStudy(), addModule(), loadModule(), module(), and moduleLibrary().

void CAM_Application::contextMenuPopup	(	const QString &	type,
		QMenu *	menu,
		QString &	title
	)		`[virtual]`

Menu items list is defined by the active module.

Parameters:

type	popup menu context
menu	popup menu
title	popup menu title, which can be set by the module if required

Reimplemented from STD_Application.

Reimplemented in LightApp_Application, and SalomeApp_Application.

References activeModule(), and CAM_Module.contextMenuPopup().

QString CAM_Application::moduleName ( const QString & title ) const

Parameters:

title module title (user name)

Returns:: module name or null QString if module is not found

References myInfoList.

QString CAM_Application::moduleTitle ( const QString & name ) const

Parameters:

name	module name

Returns:: module title (user name) or null QString if module is not found

References myInfoList.

QString CAM_Application::moduleIcon ( const QString & name ) const

Parameters:

name	module name

Returns:: module icon or null QString if module is not found

References myInfoList.

bool CAM_Application::isModuleAccessible ( const QString & title ) const

Parameters:

title module title (user name)

Returns:: true if module is accessible (can be loaded) or false otherwise

References SUIT_Session.applications(), modules(), myInfoList, and SUIT_Session.session().

void CAM_Application::createEmptyStudy ( ) [virtual]

Reimplemented from STD_Application.

Reimplemented in LightApp_Application.

References SUIT_Application.activeStudy().

SUIT_Study * CAM_Application::createNewStudy ( ) [protected, virtual]

Returns:: study object pointer

Reimplemented from SUIT_Application.

Reimplemented in LightApp_Application, and SalomeApp_Application.

void CAM_Application::updateCommandsStatus ( ) [protected, virtual]

Reimplemented from STD_Application.

Reimplemented in LightApp_Application, and SalomeApp_Application.

References activeModule(), and CAM_Module.updateCommandsStatus().

void CAM_Application::moduleAdded ( CAM_Module * ) [protected, virtual]

This virtual method can be re-implemented in the successors. Base implementation does nothing.

Parameters:

mod	module being added

Reimplemented in LightApp_Application.

void CAM_Application::beforeCloseDoc ( SUIT_Study * theDoc ) [protected, virtual]

Closes all modules in study theDoc.

Parameters:

theDoc study

Reimplemented from STD_Application.

Reimplemented in LightApp_Application.

References myModules.

void CAM_Application::afterCloseDoc ( ) [protected, virtual]

Reimplemented from STD_Application.

Reimplemented in LightApp_Application.

bool CAM_Application::activateModule ( CAM_Module * mod = 0 ) [protected, virtual]

Shows error message if module could not be activated in the current study.

Parameters:

mod	module object pointer

Returns:: true, if module is loaded and activated successfully and false otherwise

Reimplemented in LightApp_Application.

References CAM_Module.activateModule(), SUIT_Application.activeStudy(), CAM_Module.connectToStudy(), SUIT_MessageBox.critical(), CAM_Module.deactivateModule(), SUIT_Application.desktop(), CAM_Module.moduleName(), myModule, CAM_Module.setMenuShown(), CAM_Module.setToolShown(), and updateCommandsStatus().

void CAM_Application::setActiveStudy ( SUIT_Study * study ) [protected, virtual]

Parameters:

study study to be made active

Reimplemented from SUIT_Application.

Reimplemented in LightApp_Application.

QString CAM_Application::moduleLibrary	(	const QString &	title,
		const bool	full = `true`
	)		const `[protected]`

Parameters:

title	module title (user name)
full	if `true`, return full library name, otherwise return its internal name

Returns:: module library name or null QString if module is not found

References Qtx.library(), and myInfoList.

void CAM_Application::readModuleList ( ) [private]

This function first tries to get the modules names list by parsing the application command line arguments, looking for the "--modules ( <mod_name>[:<mod_name>...] )" option. List of modules is separated by colon symbol (":").

If "--modules" command line option is not used, the list of modules is retrieved from the application resource file: parameter "modules" of the section "launch".

Then the information about each module (module title (user name), library name) is retrieved from the corresponding section of resource file with help of resources manager.

Shows the warning message, if module information list is empty.

See also:: SUIT_ResourceMgr

References QtxResourceMgr.booleanValue(), SUIT_Application.desktop(), Qtx.extension(), Qtx.file(), CAM_Application.ModuleInfo.icon, CAM_Application.ModuleInfo.internal, CAM_Application.ModuleInfo.isSingleton, modules(), moduleTitle(), myInfoList, CAM_Application.ModuleInfo.name, SUIT_Session.resourceMgr(), SUIT_Session.session(), QtxResourceMgr.stringValue(), CAM_Application.ModuleInfo.title, and SUIT_MessageBox.warning().

QString STD_Application::applicationName ( ) const [virtual, inherited]

Return values:

QString "StdApplication"

Implements SUIT_Application.

Reimplemented in CAF_Application, and LightApp_Application.

bool STD_Application::isPossibleToClose ( bool & closePermanently ) [virtual, inherited]

Check the application on closing.

Return values:

true	if possible, else false

Reimplemented from SUIT_Application.

Reimplemented in SalomeApp_Application.

References SUIT_Study.abortAllOperations(), SUIT_Application.activeStudy(), STD_Application.closeAction(), STD_Application.closeChoice(), and SUIT_Study.studyName().

bool STD_Application::useFile ( const QString & theFileName ) [virtual, inherited]

Return values:

true,if document opened successful, else false.

Reimplemented from SUIT_Application.

References SUIT_Application.activeStudy(), and STD_Application.studyOpened().

void STD_Application::setEditEnabled ( const bool theEnable ) [inherited]

Sets theEnable for menu manager and for tool manager.

References SUIT_Application.action(), QtxActionMgr.actionId(), SUIT_Application.desktop(), STD_Application.EditCopyId, STD_Application.EditPasteId, SUIT_Desktop.menuMgr(), STD_Application.myEditEnabled, QtxActionToolMgr.setShown(), QtxActionMenuMgr.setShown(), and SUIT_Desktop.toolMgr().

bool STD_Application.isEditEnabled ( ) const [inherited]

void STD_Application::clearViewManagers ( ) [inherited]

Remove all view managers from view managers list.

References STD_Application.removeViewManager(), and STD_Application.viewManagers().

void STD_Application::addViewManager ( SUIT_ViewManager * vm ) [virtual, inherited]

Add view manager to view managers list, if it not already there.

Reimplemented in LightApp_Application.

References SUIT_Application.activated(), SUIT_PopupClient.connectPopupRequest(), STD_Application.containsViewManager(), STD_Application.myViewMgrs, STD_Application.onConnectPopupRequest(), STD_Application.onViewManagerActivated(), and STD_Application.viewManagerAdded().

void STD_Application::removeViewManager ( SUIT_ViewManager * vm ) [virtual, inherited]

Remove view manager from view managers list.

Reimplemented in LightApp_Application.

References SUIT_Application.activated(), SUIT_ViewManager.closeAllViews(), SUIT_PopupClient.disconnectPopupRequest(), STD_Application.myActiveViewMgr, STD_Application.myViewMgrs, STD_Application.onConnectPopupRequest(), STD_Application.onViewManagerActivated(), and STD_Application.viewManagerRemoved().

SUIT_ViewManager * STD_Application::activeViewManager ( ) const [inherited]

Return values:

SUIT_ViewManager - return pointer to active view manager.

References STD_Application.myActiveViewMgr.

SUIT_ViewManager * STD_Application::viewManager ( const QString & vmType ) const [inherited]

Return values:

SUIT_ViewManager by viewer manager type name.

References STD_Application.myViewMgrs.

bool STD_Application::containsViewManager ( SUIT_ViewManager * vm ) const [inherited]

Return values:

TRUE,if view manager vm, already in view manager list (myViewMgrs).

References STD_Application.myViewMgrs.

ViewManagerList STD_Application::viewManagers ( ) const [inherited]

Return values:

ViewManagerList - const list of all view managers.

void STD_Application::viewManagers ( ViewManagerList & lst ) const [inherited]

Parameters:

lst	- output list of all view managers.

References STD_Application.myViewMgrs.

void STD_Application::viewManagers	(	const QString &	vmType,
		ViewManagerList &	lst
	)		const `[inherited]`

Parameters:

vmType	- input view manager type name
lst	- output list of view managers with types vmType.

References STD_Application.myViewMgrs.

int STD_Application::viewManagerId ( const SUIT_ViewManager * theManager ) const [virtual, inherited]

Return index of the view ma

Implements SUIT_Application.

References STD_Application.myViewMgrs.

virtual QString STD_Application.getFileFilter ( ) const [virtual, inherited]

Reimplemented in CAF_Application, LightApp_Application, and SalomeApp_Application.

QString STD_Application::getFileName	(	bool	open,
		const QString &	initial,
		const QString &	filters,
		const QString &	caption,
		QWidget *	parent
	)		`[virtual, inherited]`

Return values:

QString - return file name from dialog.

Implements SUIT_Application.

Reimplemented in LightApp_Application.

References test_big_table.aName, SUIT_Application.desktop(), Qtx.extension(), SUIT_MessageBox.question(), and rx.

QString STD_Application::getDirectory	(	const QString &	initial,
		const QString &	caption,
		QWidget *	parent
	)		`[virtual, inherited]`

Return values:

QString - return directory name from dialog.

Implements SUIT_Application.

Reimplemented in LightApp_Application.

References SUIT_Application.desktop().

void STD_Application::closeApplication ( ) [virtual, inherited]

Close the Application

Reimplemented from SUIT_Application.

References SUIT_Application.activeStudy(), STD_Application.afterCloseDoc(), STD_Application.beforeCloseDoc(), SUIT_Study.closeDocument(), SUIT_Application.desktop(), STD_Application.savePreferences(), SUIT_Application.setActiveStudy(), and STD_Application.setDesktop().

bool STD_Application::exitConfirmation ( ) const [inherited]

Return values:

requirement of exit confirmation

References STD_Application.myExitConfirm.

void STD_Application::setExitConfirmation ( const bool on ) [inherited]

Set the requirement of exit confirmation

References STD_Application.myExitConfirm.

void STD_Application::updateDesktopTitle ( ) [virtual, inherited]

Update desktop title.

Reimplemented in LightApp_Application, and SalomeApp_Application.

References SUIT_Application.activeStudy(), STD_Application.applicationName(), SUIT_Application.applicationVersion(), SUIT_Application.desktop(), and Qtx.file().

void STD_Application.viewManagerAdded ( SUIT_ViewManager * ) [signal, inherited]

emit that view manager added

void STD_Application.viewManagerRemoved ( SUIT_ViewManager * ) [signal, inherited]

emit that view manager removed

void STD_Application.viewManagerActivated ( SUIT_ViewManager * ) [signal, inherited]

emit that view manager activated

void STD_Application::onNewDoc ( ) [virtual, slot, inherited]

Opens new application

Reimplemented in LightApp_Application.

bool STD_Application::onNewDoc ( const QString & name ) [virtual, slot, inherited]

Opens new application

References SUIT_Application.activeStudy(), SUIT_Application.closeApplication(), SUIT_Study.createDocument(), SUIT_Application.createEmptyStudy(), STD_Application.createEmptyStudy(), STD_Application.onNewDoc(), SUIT_Application.setActiveStudy(), SUIT_Application.startApplication(), and STD_Application.studyCreated().

void STD_Application::onCloseDoc ( bool ask = true ) [virtual, slot, inherited]

Close document, if it's possible.

Reimplemented in SalomeApp_Application.

void STD_Application::onSaveDoc ( ) [virtual, slot, inherited]

Save document if all ok, else error message.

References SUIT_Application.activeStudy(), SUIT_MessageBox.critical(), SUIT_Application.desktop(), STD_Application.onSaveAsDoc(), SUIT_Application.putInfo(), SUIT_Study.saveDocument(), and STD_Application.studySaved().

bool STD_Application::onSaveAsDoc ( ) [virtual, slot, inherited]

Return values:

TRUE,if doument saved successful, else FALSE.

References SUIT_Application.activeStudy(), test_big_table.aName, SUIT_MessageBox.critical(), SUIT_Application.desktop(), STD_Application.getFileFilter(), STD_Application.getFileName(), SUIT_Application.putInfo(), SUIT_Study.saveDocumentAs(), SUIT_Study.studyName(), and STD_Application.studySaved().

void STD_Application::onOpenDoc ( ) [virtual, slot, inherited]

Put file name from file dialog to onOpenDoc(const QString&) function

Reimplemented in LightApp_Application.

References test_big_table.aName, STD_Application.getFileFilter(), and STD_Application.getFileName().

bool STD_Application::onOpenDoc ( const QString & aName ) [virtual, slot, inherited]

Return values:

true,if document was opened successful, else false.

Reimplemented in LightApp_Application.

References STD_Application.openAction(), and STD_Application.openChoice().

bool STD_Application::onReopenDoc ( ) [virtual, slot, inherited]

Reload document from the file.

References SUIT_Application.activeStudy(), STD_Application.afterCloseDoc(), STD_Application.beforeCloseDoc(), STD_Application.clearViewManagers(), STD_Application.closeApplication(), SUIT_Study.closeDocument(), SUIT_Application.desktop(), SUIT_Study.isSaved(), SUIT_MessageBox.question(), SUIT_Application.setActiveStudy(), STD_Application.setDesktop(), SUIT_Study.studyName(), STD_Application.updateCommandsStatus(), STD_Application.updateDesktopTitle(), and STD_Application.useFile().

void STD_Application::onExit ( ) [virtual, slot, inherited]

Closing session.

Reimplemented in SalomeApp_Application.

References SUIT_Session.closeSession(), SUIT_Application.desktop(), STD_Application.exitConfirmation(), SUIT_MessageBox.question(), and SUIT_Session.session().

void STD_Application::onCopy ( ) [virtual, slot, inherited]

Virtual slot. Not implemented here.

Reimplemented in LightApp_Application, and SalomeApp_Application.

void STD_Application::onPaste ( ) [virtual, slot, inherited]

Virtual slot. Not implemented here.

Reimplemented in LightApp_Application, and SalomeApp_Application.

void STD_Application::onViewStatusBar ( bool on ) [virtual, slot, inherited]

Sets status bar show, if = true, else status bar hide.

References SUIT_Application.desktop().

void STD_Application::onHelpAbout ( ) [virtual, slot, inherited]

Call SUIT_MessageBox.info1(...) with about information.

Reimplemented in CAF_Application, and LightApp_Application.

References SUIT_Application.desktop(), and SUIT_MessageBox.information().

void STD_Application::onDesktopClosing	(	SUIT_Desktop *	,
		QCloseEvent *	e
	)		`[virtual, slot, inherited]`

Event on closing desktop

References STD_Application.closeApplication(), STD_Application.isPossibleToClose(), STD_Application.onExit(), and SUIT_Session.session().

void STD_Application::onConnectPopupRequest	(	SUIT_PopupClient *	client,
		QContextMenuEvent *	e
	)		`[virtual, slot, inherited]`

Public slot.

References SUIT_PopupClient.contextMenuPopup(), STD_Application.contextMenuPopup(), SUIT_PopupClient.popupClientType(), QtxMenu.setTitleText(), and Qtx.simplifySeparators().

void STD_Application::createActions ( ) [protected, virtual, inherited]

Create actions, menus and tools

Reimplemented in CAF_Application, LightApp_Application, and SalomeApp_Application.

References test_table.a, SUIT_Application.createAction(), SUIT_Application.createMenu(), SUIT_Application.createTool(), SUIT_Application.desktop(), QtxDockAction.DockWidget, STD_Application.EditCopyId, STD_Application.EditPasteId, STD_Application.FileCloseId, STD_Application.FileExitId, STD_Application.FileNewId, STD_Application.FileOpenId, STD_Application.FileReopenId, STD_Application.FileSaveAsId, STD_Application.FileSaveId, STD_Application.HelpAboutId, QtxResourceMgr.loadPixmap(), STD_Application.MenuEditId, STD_Application.MenuFileId, STD_Application.MenuHelpId, STD_Application.MenuViewId, STD_Application.NewWindowId, STD_Application.onCloseDoc(), STD_Application.onCopy(), STD_Application.onExit(), STD_Application.onHelpAbout(), STD_Application.onNewDoc(), STD_Application.onOpenDoc(), STD_Application.onPaste(), STD_Application.onReopenDoc(), STD_Application.onSaveAsDoc(), STD_Application.onSaveDoc(), STD_Application.onViewStatusBar(), SUIT_Application.registerAction(), SUIT_Application.resourceMgr(), SUIT_Application.separator(), QtxDockAction.setDockType(), QtxDockAction.ToolBar, STD_Application.ViewStatusBarId, STD_Application.ViewToolBarsId, and STD_Application.ViewWindowsId.

void STD_Application::setDesktop ( SUIT_Desktop * desk ) [protected, virtual, inherited]

Changes desktop

Parameters:

desk	- new desktop

Reimplemented from SUIT_Application.

Reimplemented in SalomeApp_Application.

References SUIT_Application.desktop(), and STD_Application.onDesktopClosing().

void STD_Application::loadPreferences ( ) [protected, virtual, inherited]

Allow to load preferences before the desktop will be shown.

Reimplemented in LightApp_Application.

void STD_Application::savePreferences ( ) [protected, virtual, inherited]

Allow to save preferences before the application will be closed.

Reimplemented in LightApp_Application.

void STD_Application::studySaved ( SUIT_Study * ) [protected, virtual, inherited]

Custom activity after study is opened Updates desktop and actions

Reimplemented in LightApp_Application.

References STD_Application.updateCommandsStatus(), and STD_Application.updateDesktopTitle().

void STD_Application::studyOpened ( SUIT_Study * ) [protected, virtual, inherited]

Custom activity after study is opened Updates desktop and actions

Reimplemented in LightApp_Application.

References STD_Application.updateCommandsStatus(), and STD_Application.updateDesktopTitle().

void STD_Application::studyCreated ( SUIT_Study * ) [protected, virtual, inherited]

Custom activity after study is created Updates desktop and actions

Reimplemented in LightApp_Application.

References STD_Application.updateCommandsStatus(), and STD_Application.updateDesktopTitle().

void STD_Application::setActiveViewManager ( SUIT_ViewManager * vm ) [protected, virtual, inherited]

Sets active manager to , if in view managers list.

References STD_Application.containsViewManager(), STD_Application.myActiveViewMgr, and STD_Application.viewManagerActivated().

int STD_Application::openChoice ( const QString & aName ) [protected, virtual, inherited]

Reimplemented in LightApp_Application, and SalomeApp_Application.

References test_big_table.aName, SUIT_Session.applications(), STD_Application.OpenExist, STD_Application.OpenNew, and SUIT_Session.session().

bool STD_Application::openAction	(	const int	choice,
		const QString &	aName
	)		`[protected, virtual, inherited]`

Reimplemented in LightApp_Application, and SalomeApp_Application.

References SUIT_Application.activeStudy(), test_big_table.aName, SUIT_Session.applications(), SUIT_Application.closeApplication(), SUIT_Application.desktop(), STD_Application.OpenCancel, STD_Application.OpenExist, STD_Application.OpenNew, SUIT_Session.session(), SUIT_Application.startApplication(), SUIT_Application.useFile(), and STD_Application.useFile().

int STD_Application::closeChoice ( const QString & docName ) [protected, virtual, inherited]

Reimplemented in SalomeApp_Application.

References STD_Application.CloseCancel, STD_Application.CloseDiscard, STD_Application.CloseSave, SUIT_Application.desktop(), and SUIT_MessageBox.question().

bool STD_Application::closeAction	(	const int	choice,
		bool &	closePermanently
	)		`[protected, virtual, inherited]`

Reimplemented in SalomeApp_Application.

References SUIT_Application.activeStudy(), STD_Application.CloseCancel, STD_Application.CloseDiscard, STD_Application.CloseSave, STD_Application.onSaveAsDoc(), and STD_Application.onSaveDoc().

SUIT_Desktop * SUIT_Application::desktop ( ) [virtual, inherited]

Returns:: main window of application (desktop)

References SUIT_Application.myDesktop.

SUIT_Study * SUIT_Application::activeStudy ( ) const [virtual, inherited]

Returns:: active Study. If Application supports wirking with several studies this method should be redefined

References SUIT_Application.myStudy.

QString SUIT_Application::applicationVersion ( ) const [virtual, inherited]

Returns:: version of application

Reimplemented in LightApp_Application.

int SUIT_Application::getNbStudies ( ) const [virtual, inherited]

Returns number of Studies. Must be redefined in Applications which support several studies for one Application instance.

Returns:: number of Studies. Must be redefined in Applications which support several studies for one Application instance.

References SUIT_Application.activeStudy().

SUIT_ResourceMgr * SUIT_Application::resourceMgr ( ) const [inherited]

Returns:: global resource manager

References SUIT_Session.resourceMgr(), and SUIT_Session.session().

SUIT_ShortcutMgr * SUIT_Application::shortcutMgr ( ) const [inherited]

Returns:: global shortcut manager

References SUIT_ShortcutMgr.getShortcutMgr().

void SUIT_Application::putInfo	(	const QString &	msg,
		const int	msec = `0`
	)		`[inherited]`

Puts the message to the status bar

Parameters:

msg	- text of message
msec	- time in milliseconds, after that the status label will be cleared

References DEFAULT_MESSAGE_DELAY, SUIT_Application.desktop(), SUIT_Application.infoChanged(), SUIT_Application.myStatusLabel, and SUIT_Application.onInfoClear().

void SUIT_Application.applicationClosed ( SUIT_Application * ) [signal, inherited]

void SUIT_Application.activated ( SUIT_Application * ) [signal, inherited]

void SUIT_Application.infoChanged ( QString ) [signal, inherited]

void SUIT_Application::onHelpContextModule	(	const QString &	,
		const QString &	,
		const QString &	= `QString()`
	)		`[virtual, slot, inherited]`

SLOT: is used for Help browsing

Reimplemented in LightApp_Application.

SUIT_Application * SUIT_Application::startApplication	(	int	argc,
		char **	argv
	)		const `[protected, inherited]`

Initialize with application arguments

Parameters:

argc	- number of application arguments
argv	- array of application arguments

SUIT_Application * SUIT_Application::startApplication	(	const QString &	name,
		int	argc,
		char **	argv
	)		const `[protected, inherited]`

Initialize with application name and arguments

Parameters:

name	- name of application
argc	- number of application arguments
argv	- array of application arguments

References SUIT_Session.session(), and SUIT_Session.startApplication().

int SUIT_Application::createTool ( const QString & name ) [protected, inherited]

Creates new toolbar

Returns:: identificator of new toolbar in tool manager

Parameters:

name	- name of new toolbar

References QtxActionToolMgr.createToolBar(), SUIT_Application.desktop(), and SUIT_Desktop.toolMgr().

int SUIT_Application::createTool	(	const int	id,
		const int	tBar,
		const int	idx = `-1`
	)		`[protected, inherited]`

Creates new toolbutton

Returns:: "id" if all right or -1 otherwise

Parameters:

id	- SUIT identificator of action
tBar	- identificator of toolbar
idx	- index in toolbar

References SUIT_Application.action(), SUIT_Application.desktop(), QtxActionToolMgr.insert(), and SUIT_Desktop.toolMgr().

int SUIT_Application::createTool	(	const int	id,
		const QString &	tBar,
		const int	idx = `-1`
	)		`[protected, inherited]`

Creates new toolbutton

Returns:: "id" if all right or -1 otherwise

Parameters:

id	- SUIT identificator of action
tBar	- name of toolbar
idx	- index in toolbar

References SUIT_Application.action(), SUIT_Application.desktop(), QtxActionToolMgr.insert(), and SUIT_Desktop.toolMgr().

int SUIT_Application::createTool	(	QAction *	a,
		const int	tBar,
		const int	id = `-1`,
		const int	idx = `-1`
	)		`[protected, inherited]`

Creates new toolbutton

Returns:: SUIT identificator of new action

Parameters:

a	- action
tBar	- identificator of toolbar
id	- proposed SUIT identificator of action (if it is -1, then must be use any free)
idx	- index in toolbar

References SUIT_Application.desktop(), QtxActionToolMgr.insert(), SUIT_Application.registerAction(), and SUIT_Desktop.toolMgr().

int SUIT_Application::createTool	(	QAction *	a,
		const QString &	tBar,
		const int	id = `-1`,
		const int	idx = `-1`
	)		`[protected, inherited]`

Creates new toolbutton

Returns:: SUIT identificator of new action

Parameters:

a	- action
tBar	- name of toolbar
id	- proposed SUIT identificator of action (if it is -1, then must be use any free)
idx	- index in toolbar

References SUIT_Application.desktop(), QtxActionToolMgr.insert(), SUIT_Application.registerAction(), and SUIT_Desktop.toolMgr().

int SUIT_Application::createMenu	(	const QString &	subMenu,
		const int	menu,
		const int	id = `-1`,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: identificator of new action in menu manager

Parameters:

subMenu	- menu text of new item
menu	- identificator of parent menu item
id	- proposed identificator of action
group	- group in menu manager
index	- index in menu

References SUIT_Application.desktop(), QtxActionMenuMgr.insert(), and SUIT_Desktop.menuMgr().

int SUIT_Application::createMenu	(	const QString &	subMenu,
		const QString &	menu,
		const int	id = `-1`,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: identificator of new action in menu manager

Parameters:

subMenu	- menu text of new item
menu	- menu text of parent menu item
id	- proposed identificator of action
group	- group in menu manager
index	- index in menu

References SUIT_Application.desktop(), QtxActionMenuMgr.insert(), and SUIT_Desktop.menuMgr().

int SUIT_Application::createMenu	(	const int	id,
		const int	menu,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: identificator of new action in menu manager

Parameters:

id	- SUIT identificator of action
menu	- menu text of parent menu item
group	- group in menu manager
index	- index in menu

References SUIT_Application.action(), SUIT_Application.desktop(), QtxActionMenuMgr.insert(), and SUIT_Desktop.menuMgr().

int SUIT_Application::createMenu	(	const int	id,
		const QString &	menu,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: identificator of new action in menu manager

Parameters:

id	- SUIT identificator of action
menu	- menu text of parent menu item
group	- group in menu manager
index	- index in menu

References SUIT_Application.action(), SUIT_Application.desktop(), QtxActionMenuMgr.insert(), and SUIT_Desktop.menuMgr().

int SUIT_Application::createMenu	(	QAction *	a,
		const int	menu,
		const int	id = `-1`,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: SUIT identificator of new action

Parameters:

a	- action
menu	- identificator of parent menu item
id	- proposed SUIT identificator of action
group	- group in menu manager
index	- index in menu

References SUIT_Application.desktop(), QtxActionMenuMgr.insert(), SUIT_Desktop.menuMgr(), and SUIT_Application.registerAction().

int SUIT_Application::createMenu	(	QAction *	a,
		const QString &	menu,
		const int	id = `-1`,
		const int	group = `-1`,
		const int	index = `-1`
	)		`[protected, inherited]`

Creates new menu item

Returns:: SUIT identificator of new action

Parameters:

a	- action
menu	- menu text of parent menu item
id	- proposed SUIT identificator of action
group	- group in menu manager
index	- index in menu

References SUIT_Application.desktop(), QtxActionMenuMgr.insert(), SUIT_Desktop.menuMgr(), and SUIT_Application.registerAction().

void SUIT_Application::setMenuShown	(	QAction *	a,
		const bool	on
	)		`[protected, inherited]`

Show/hide menu item corresponding to action

Parameters:

a	- action
on	- if it is true, the item will be shown, otherwise it will be hidden

References QtxActionMgr.actionId(), SUIT_Application.desktop(), SUIT_Desktop.menuMgr(), and QtxActionMenuMgr.setShown().

void SUIT_Application::setMenuShown	(	const int	id,
		const bool	on
	)		`[protected, inherited]`

Show/hide menu item corresponding to action

Parameters:

id	- identificator of action in menu manager
on	- if it is true, the item will be shown, otherwise it will be hidden

References SUIT_Application.action(), and SUIT_Application.setMenuShown().

void SUIT_Application::setToolShown	(	QAction *	a,
		const bool	on
	)		`[protected, inherited]`

Show/hide tool button corresponding to action

Parameters:

a	- action
on	- if it is true, the button will be shown, otherwise it will be hidden

References QtxActionMgr.actionId(), SUIT_Application.desktop(), QtxActionToolMgr.setShown(), and SUIT_Desktop.toolMgr().

void SUIT_Application::setToolShown	(	const int	id,
		const bool	on
	)		`[protected, inherited]`

Show/hide menu item corresponding to action

Parameters:

id	- identificator of action in tool manager
on	- if it is true, the button will be shown, otherwise it will be hidden

References SUIT_Application.action(), and SUIT_Application.setToolShown().

void SUIT_Application::setActionShown	(	QAction *	a,
		const bool	on
	)		`[protected, inherited]`

Show/hide both menu item and tool button corresponding to action

Parameters:

a	- action
on	- if it is true, the item will be shown, otherwise it will be hidden

References SUIT_Application.setMenuShown(), and SUIT_Application.setToolShown().

void SUIT_Application::setActionShown	(	const int	id,
		const bool	on
	)		`[protected, inherited]`

Show/hide both menu item and tool button corresponding to action

Parameters:

id	- identificator in both menu manager and tool manager
on	- if it is true, the item will be shown, otherwise it will be hidden

References SUIT_Application.setMenuShown(), and SUIT_Application.setToolShown().

QAction * SUIT_Application::separator ( ) [static, protected, inherited]

Returns:: global action used as separator

QAction * SUIT_Application::action ( const int id ) const [protected, inherited]

Returns:: action by it's SUIT identificator

Parameters:

id	- SUIT identificator

References test_table.a, and SUIT_Application.myActionMap.

int SUIT_Application::actionId ( const QAction * a ) const [protected, inherited]

Returns:: SUIT identificator of action

Parameters:

a - action

References test_table.a, and SUIT_Application.myActionMap.

QList< QAction * > SUIT_Application::actions ( ) const [protected, inherited]

References SUIT_Application.myActionMap.

QList< int > SUIT_Application::actionIds ( ) const [protected, inherited]

References SUIT_Application.myActionMap.

int SUIT_Application::registerAction	(	const int	id,
		QAction *	a
	)		`[protected, inherited]`

Registers action both in menu manager and tool manager

Parameters:

id	- proposed SUIT identificator (if it is -1, auto generated one is used)
a	- action

References SUIT_Application.action(), SUIT_Application.actionId(), SUIT_Application.desktop(), SUIT_Desktop.menuMgr(), SUIT_Application.myActionMap, QtxActionMgr.registerAction(), and SUIT_Desktop.toolMgr().

QAction * SUIT_Application::createAction	(	const int	id,
		const QString &	text,
		const QIcon &	icon,
		const QString &	menu,
		const QString &	tip,
		const int	key,
		QObject *	parent = `0`,
		const bool	toggle = `false`,
		QObject *	reciever = `0`,
		const char *	member = `0`,
		const QString &	shortcutAction = `QString()`
	)		`[protected, inherited]`

Creates action and registers it both in menu manager and tool manager

Returns:: new instance of action

Parameters:

id	- proposed SUIT identificator
text	- description
icon	- icon for toolbar
menu	- menu text
tip	- tool tip
key	- shortcut
parent	- parent object
toggle	- if it is TRUE the action will be a toggle action, otherwise it will be a command action
reciever	- object that contains slot
member	- slot to be called when action is activated