CAF_Application Class Reference

OCC OCAF-based application. More...

#include <CAF_Application.h>

Inheritance diagram for CAF_Application:

Public Types
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	onHelpAbout ()
	Called when user activatees Help->About main menu command.
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	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
	CAF_Application ()
	Default constructor.
	CAF_Application (const Handle(TDocStd_Application)&)
	Constructor.
virtual	~CAF_Application ()
	Destructor.
virtual QString	applicationName () const
	Get application name.
	Handle (TDocStd_Application) stdApp() const
virtual QString	getFileFilter () const
	Get file extension filter.
virtual bool	isPossibleToClose (bool &)
virtual bool	useFile (const QString &)
virtual void	createEmptyStudy ()
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	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	start ()
virtual void	closeApplication ()
virtual void	contextMenuPopup (const QString &, QMenu *, QString &)
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	{ EditUndoId = STD_Application::UserID, EditRedoId, UserID }
enum	{ OpenCancel, OpenNew, OpenExist }
enum	{ CloseCancel, CloseSave, CloseDiscard }
Protected Slots
virtual bool	onUndo (int)
	Called when user activates "Undo" menu action.
virtual bool	onRedo (int)
	Called when user activates "Redo" menu action.
virtual void	onDesktopActivated ()
Protected Member Functions
virtual void	createActions ()
	Create menu and toolbars actions.
virtual void	updateCommandsStatus ()
	Update actions state (Undo/Redo).
virtual SUIT_Study *	createNewStudy ()
	Create new empty study.
bool	undo (CAF_Study *doc)
	Undo latest command operation for specified document.
bool	redo (CAF_Study *doc)
	Redo latest command operation undo for specified document.
virtual void	setStdApp (const Handle(TDocStd_Application)&)
	Set OCAF application.
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	beforeCloseDoc (SUIT_Study *theDoc)
virtual void	afterCloseDoc ()
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
virtual void	setActiveStudy (SUIT_Study *)
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 Member Functions
	Handle (TDocStd_Application) myStdApp

---

Detailed Description

Defines application configuration and behaviour for application using standard OCC OCAF data model. Allows using OCC OCAF serives (for example, undo/redo mechanizm).

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

EditUndoId
EditRedoId
UserID

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

CAF_Application::CAF_Application

(

)

CAF_Application::CAF_Application

(

const Handle(TDocStd_Application)&

app

)

Parameters:

app	OCAF application

CAF_Application::~CAF_Application

(

)

[virtual]

---

Member Function Documentation

QString CAF_Application::applicationName

(

)

const [virtual]

Returns:

application name

Reimplemented from STD_Application.

CAF_Application.Handle

(

TDocStd_Application

)

const

QString CAF_Application::getFileFilter

(

)

const [virtual]

The file extension filter is used in Open/Save dialog boxes.

Returns:

file filters for open/save document dialog box

Reimplemented from STD_Application.

References Handle(), and CAF_Tools.toQString().

void CAF_Application::onHelpAbout

(

)

[virtual, slot]

Reimplemented from STD_Application.

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

bool CAF_Application::onUndo

(

int

numActions

)

[protected, virtual, slot]

Undo operation on the active document.

Parameters:

numActions

undo depth (number of commands)

Returns:

true on success

References SUIT_Application.activeStudy(), undo(), and updateCommandsStatus().

bool CAF_Application::onRedo

(

int

numActions

)

[protected, virtual, slot]

Redo latest undo commands on the active document.

Parameters:

numActions

redo depth (number of commands)

Returns:

true on success

References SUIT_Application.activeStudy(), redo(), and updateCommandsStatus().

void CAF_Application::createActions

(

)

[protected, virtual]

Reimplemented from STD_Application.

References SUIT_Application.createMenu(), SUIT_Application.createTool(), SUIT_Application.desktop(), EditRedoId, EditUndoId, QtxResourceMgr.loadPixmap(), onRedo(), onUndo(), SUIT_Application.registerAction(), SUIT_Application.resourceMgr(), SUIT_Application.separator(), and QtxListAction.setComment().

void CAF_Application::updateCommandsStatus

(

)

[protected, virtual]

Reimplemented from STD_Application.

References SUIT_Application.action(), SUIT_Application.activeStudy(), QtxListAction.addNames(), CAF_Study.canRedo(), CAF_Study.canUndo(), EditRedoId, EditUndoId, redo(), CAF_Study.redoNames(), undo(), and CAF_Study.undoNames().

SUIT_Study * CAF_Application::createNewStudy

(

)

[protected, virtual]

Returns:

new study

Reimplemented from SUIT_Application.

bool CAF_Application::undo

(

CAF_Study *

doc

)

[protected]

Parameters:

doc	OCAF document

Returns:

true on success

References CAF_Study.undo(), and SUIT_Study.update().

bool CAF_Application::redo

(

CAF_Study *

doc

)

[protected]

Parameters:

doc	OCAF document

Returns:

true on success

References CAF_Study.redo(), and SUIT_Study.update().

void CAF_Application::setStdApp

(

const Handle(TDocStd_Application)&

app

)

[protected, virtual]

Parameters:

app	new OCAF application

CAF_Application.Handle

(

TDocStd_Application

)

[private]

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::createEmptyStudy

(

)

[virtual, inherited]

Create empty study.
Create new view manager and adding it to view managers list.

Reimplemented from SUIT_Application.

Reimplemented in CAM_Application, and LightApp_Application.

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.

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::start

(

)

[virtual, inherited]

Start STD_Application

Reimplemented from SUIT_Application.

Reimplemented in CAM_Application, LightApp_Application, and SalomeApp_Application.

References STD_Application.createActions(), STD_Application.loadPreferences(), STD_Application.myEditEnabled, STD_Application.setEditEnabled(), STD_Application.updateCommandsStatus(), and STD_Application.updateDesktopTitle().

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().

virtual void STD_Application.contextMenuPopup	(	const QString &	,
		QMenu *	,
		QString &
	)		[virtual, inherited]

Reimplemented in CAM_Application, LightApp_Application, and SalomeApp_Application.

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.

References SUIT_Application.activeStudy(), STD_Application.afterCloseDoc(), SUIT_Session.applications(), STD_Application.beforeCloseDoc(), STD_Application.clearViewManagers(), STD_Application.closeApplication(), SUIT_Study.closeDocument(), SUIT_Application.desktop(), STD_Application.isPossibleToClose(), STD_Application.savePreferences(), SUIT_Session.session(), SUIT_Application.setActiveStudy(), STD_Application.setDesktop(), STD_Application.updateCommandsStatus(), and STD_Application.updateDesktopTitle().

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::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::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::beforeCloseDoc

(

SUIT_Study *

theDoc

)

[protected, virtual, inherited]

Virtual function. Not implemented here.

Reimplemented in CAM_Application, and LightApp_Application.

void STD_Application::afterCloseDoc

(

)

[protected, virtual, inherited]

Virtual function. Not implemented here.

Reimplemented in CAM_Application, and LightApp_Application.

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().

void SUIT_Application::setActiveStudy

(

SUIT_Study *

study

)

[protected, virtual, inherited]

Sets study as active

Parameters:

study

- instance of study to be set as active

Reimplemented in CAM_Application, and LightApp_Application.

References SUIT_Application.myStudy, and SUIT_Application.updateCommandsStatus().

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

References test_table.a, and SUIT_Application.registerAction().

void SUIT_Application::onDesktopActivated

(

)

[protected, virtual, slot, inherited]

SLOT: it is called when desktop is activated

Reimplemented in LightApp_Application.

References SUIT_Application.activated().