SalomeApp_Application Class Reference

Application containing SalomeApp module or LightApp module.

#include <SalomeApp_Application.h>

Inheritance diagram for SalomeApp_Application:

Public Types
enum	{ MenuToolsId = 5 }
enum	{   DumpStudyId = LightApp_Application::UserID, LoadScriptId, PropertiesId, CatalogGenId,   RegDisplayId, SaveGUIStateId, ConnectId, DisconnectId,   UserID }
enum	WindowTypes { WT_NoteBook = LightApp_Application::WT_User, WT_User }
Public Types inherited from LightApp_Application
enum	WindowTypes { WT_ObjectBrowser, WT_PyConsole, WT_LogWindow, WT_User }
enum	{ MenuWindowId = 6 }
enum	{   RenameId = CAM_Application::UserID, CloseId, CloseAllId, GroupAllId,   PreferencesId, MRUId, ModulesListId, NewGLViewId,   NewPlot2dId, NewOCCViewId, NewVTKViewId, NewQxSceneViewId,   NewGraphicsViewId, NewPVViewId, NewPyViewerId, StyleId,   FullScreenId, UserID }
Public Types inherited from CAM_Application
typedef QList< CAM_Module * >	ModuleList
typedef QList< ModuleShortInfo >	ModuleShortInfoList
Public Types inherited from STD_Application
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	onLoadDoc ()
virtual void	onNewWithScript ()
virtual bool	onLoadDoc (const QString &)
virtual void	onUnloadDoc (bool ask=true)
virtual void	onCloseDoc (bool ask=true)
virtual void	onExit ()
	Close application. More...
virtual void	onCopy ()
virtual void	onPaste ()
void	onSaveGUIState ()
void	onUpdateStudy ()
bool	onRestoreStudy (const QString &theDumpScript, const QString &theStudyName, bool theIsStudySaved)
virtual void	onDockWindowVisibilityChanged (bool)
Public Slots inherited from LightApp_Application
virtual void	onHelpContentsModule ()
virtual void	onHelpContextModule (const QString &, const QString &, const QString &=QString())
virtual void	onNewDoc ()
virtual void	onOpenDoc ()
virtual void	onHelpAbout ()
virtual bool	onOpenDoc (const QString &)
virtual void	onCopy ()
virtual void	onPaste ()
virtual void	onDockWindowVisibilityChanged (bool)

Signals
void	dumpedStudyClosed (const QString &theDumpScript, const QString &theStudyName, bool theIsStudySaved)
void	notebookVarUpdated (QString theVarName)
void	objectDoubleClicked (SUIT_DataObject *)
Signals inherited from LightApp_Application
void	studyOpened ()
void	studySaved ()
void	studyClosed ()
void	preferenceChanged (const QString &, const QString &, const QString &)
void	preferenceResetToDefaults ()
void	operationFinished (const QString &, const QString &, const QStringList &)

Public Member Functions
	SalomeApp_Application ()
virtual	~SalomeApp_Application ()
virtual void	updateObjectBrowser (const bool=true)
virtual void	start ()
virtual void	contextMenuPopup (const QString &, QMenu *, QString &)
virtual bool	checkDataObject (LightApp_DataObject *theObj)
virtual bool	checkExistingDoc ()
SUIT_ViewManager *	newViewManager (const QString &)
void	updateSavePointDataObjects (SalomeApp_Study *)
virtual bool	isPossibleToClose (bool &)
virtual bool	useStudy (const QString &)
virtual void	updateDesktopTitle ()
virtual void	setNoteBook (SalomeApp_NoteBook *theNoteBook)
virtual SalomeApp_NoteBook *	getNoteBook () const
virtual bool	renameAllowed (const QString &) const
	Return true if object can be renamed. More...
virtual bool	renameObject (const QString &, const QString &)
	Return true if rename operation finished successfully, false otherwise. More...
Public Member Functions inherited from LightApp_Application
	LightApp_Application ()
virtual	~LightApp_Application ()
virtual QString	applicationName () const
virtual QString	applicationVersion () const
virtual CAM_Module *	loadModule (const QString &, const bool=true)
virtual bool	activateModule (const QString &)
LightApp_SelectionMgr *	selectionMgr () const
LogWindow *	logWindow ()
SUIT_DataBrowser *	objectBrowser ()
PyConsole_Console *	pythonConsole (const bool force=false)
LightApp_Preferences *	preferences () const
virtual QString	getFileFilter (bool) const
virtual QString	getFileName (bool open, const QString &initial, const QString &filters, const QString &caption, QWidget *parent)
virtual QString	getDirectory (const QString &initial, const QString &caption, QWidget *parent)
virtual QStringList	getOpenFileNames (const QString &initial, const QString &filters, const QString &caption, QWidget *parent)
void	updateActions ()
SUIT_ViewManager *	getViewManager (const QString &, const bool)
virtual void	addViewManager (SUIT_ViewManager *)
virtual void	removeViewManager (SUIT_ViewManager *)
virtual SUIT_ViewManager *	createViewManager (const QString &vmType, bool detached=false)
virtual SUIT_ViewManager *	createViewManager (const QString &vmType, QWidget *w)
virtual SUIT_ViewManager *	createViewManager (SUIT_ViewModel *)
QWidget *	getWindow (const int, const int=-1)
QWidget *	dockWindow (const int) const
void	removeDockWindow (const int)
void	insertDockWindow (const int, QWidget *)
void	placeDockWindow (const int, Qt::DockWidgetArea)
virtual void	closeApplication ()
virtual void	createEmptyStudy ()
virtual void	setDesktop (SUIT_Desktop *)
SUIT_Accel *	accel () const
void	setDefaultStudyName (const QString &theName)
virtual bool	event (QEvent *)
QStringList	viewManagersTypes () const
	Returns list of view manager types which are supported by this application. More...
virtual void	clearKnownViewManagers ()
	Removes ViewManagers only of known type. More...
virtual QString	browseObjects (const QStringList &theEntryList, const bool theIsApplyAndClose=true, const bool theIsOptimizedBrowsing=false)
virtual SUIT_DataObject *	findObject (const QString &) const
void	emitOperationFinished (const QString &, const QString &, const QStringList &)
	Emits operationFinished signal. More...
void	updateVisibilityState (DataObjectList &theList, SUIT_ViewModel *theViewModel)
PyConsole_Interp *	getPyInterp ()
Public Member Functions inherited from CAM_Application
	CAM_Application (const bool=true)
	Constructor. More...
virtual	~CAM_Application ()
	Destructor. More...
CAM_Module *	activeModule () const
	Get active module. More...
CAM_Module *	module (const QString &) const
	Get the module with specified name. More...
ModuleList	modules () const
	Get all loaded modules. More...
void	modules (ModuleList &) const
	Get all loaded modules. More...
void	modules (QStringList &, const bool loaded=true) const
	Get names of all modules. More...
virtual void	addModule (CAM_Module *)
	Add module mod to the modules list. More...
virtual void	loadModules ()
	Load modules from the modules information list. More...
bool	activateOperation (const QString &modName, int actionId)
	Load module modName and activate its operation, corresponding to actionId. This method is dedicated to run operations of some module from any other module. More...
bool	activateOperation (const QString &modName, const QString &actionId)
	Load module modName and activate its operation, corresponding to actionId. This method is dedicated to run operations of some module from any other module. More...
bool	activateOperation (const QString &modName, const QString &actionId, const QString &pluginName)
	Load module modName and activate its operation, corresponding to actionId and pluginName. This method is dedicated to run operations of some module from any other module. More...
Public Member Functions inherited from STD_Application
	STD_Application ()
virtual	~STD_Application ()
virtual bool	useFile (const QString &)
void	setEditEnabled (const bool)
bool	isEditEnabled () const
void	clearViewManagers ()
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
QString	getDirectory (const QString &initial, const QString &caption, QWidget *parent)
bool	exitConfirmation () const
void	setExitConfirmation (const bool)
Public Member Functions inherited from SUIT_Application
	SUIT_Application ()
virtual	~SUIT_Application ()
virtual SUIT_Desktop *	desktop ()
	Returns main widget (Desktop) of the application (if it exists) More...
virtual SUIT_Study *	activeStudy () const
	Returns active Study. If Application supports wirking with several studies this method should be redefined. More...
virtual int	getNbStudies () const
SUIT_ResourceMgr *	resourceMgr () const
SUIT_ShortcutMgr *	shortcutMgr () const
	Get access to shortcut manager. More...
void	putInfo (const QString &, const int=0)
	Puts the message to the status bar. More...
QAction *	action (const int) const
void	addPostRoutine (void(*theRoutine)())

Static Public Member Functions
static CORBA::ORB_var	orb ()
static SALOMEDSClient_StudyManager *	studyMgr ()
static SALOME_NamingService *	namingService ()
static SALOME_LifeCycleCORBA *	lcc ()
Static Public Member Functions inherited from LightApp_Application
static int	studyId ()
Static Public Member Functions inherited from CAM_Application
static QString	moduleName (const QString &)
	Get module name by its title (user name). More...
static QString	moduleTitle (const QString &)
	Get module title (user name) by its name. More...
static QString	moduleIcon (const QString &)
	Get module icon name. More...
static bool	isModuleAccessible (const QString &)
	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. More...
static ModuleShortInfoList	getVersionInfo ()
	Return information about version of the each module. More...

Protected Types
enum	{ OpenRefresh = LightApp_Application::OpenReload + 1 }
enum	{ CloseDisconnectSave = LightApp_Application::CloseDiscard + 1, CloseDisconnect }
enum	{ LoadStudyId = LightApp_Application::OpenStudyId + 1, NewAndScriptId }
Protected Types inherited from LightApp_Application
enum	{ NewStudyId = 1, OpenStudyId }
enum	BrowsePolicy { BP_Never = 0, BP_ApplyAndClose, BP_Always }
enum	{ OpenReload = CAM_Application::OpenExist + 1 }
typedef QPointer< QWidget >	WinPtr
typedef QMap< int, WinPtr >	WinMap
typedef QMap< QString, QByteArray >	WinVis
typedef QMap< QString, QByteArray >	WinGeom

Protected Slots
void	onStudyCreated (SUIT_Study *)
void	onStudyOpened (SUIT_Study *)
void	onDesktopMessage (const QString &)
Protected Slots inherited from LightApp_Application
virtual void	onDesktopActivated ()
virtual void	onViewManagerRemoved (SUIT_ViewManager *)
virtual void	onWindowActivated (SUIT_ViewWindow *theViewWindow)
void	onNewWindow ()
void	onModuleActivation (const QString &)
void	onCloseView (SUIT_ViewManager *)
virtual void	onStudyCreated (SUIT_Study *)
virtual void	onStudyOpened (SUIT_Study *)
virtual void	onStudySaved (SUIT_Study *)
virtual void	onStudyClosed (SUIT_Study *)
void	onWCDestroyed (QObject *)
void	onMRUActivated (const QString &)
void	onStylePreferences ()
void	onFullScreen ()
virtual void	onDesktopMessage (const QString &)

Protected Member Functions
virtual void	createActions ()
virtual SUIT_Study *	createNewStudy ()
virtual QWidget *	createWindow (const int)
virtual void	updateCommandsStatus ()
virtual void	onSelectionChanged ()
virtual void	createPreferences (LightApp_Preferences *)
virtual bool	closeAction (const int, bool &)
virtual int	closeChoice (const QString &)
virtual int	openChoice (const QString &)
virtual bool	openAction (const int, const QString &)
virtual QMap< int, QString >	activateModuleActions () const
	Get map of the operations which can be performed on the module activation. More...
virtual void	moduleActionSelected (const int)
	Called when the used selectes required operation chosen from "Activate module" dialog box. More...
void	objectBrowserColumnsVisibility ()
bool	updateStudy ()
virtual PyConsole_Interp *	createPyInterp ()
virtual void	afterCloseDoc ()
Protected Member Functions inherited from LightApp_Application
virtual void	createActionForViewer (const int id, const int parentId, const QString &suffix, const int accel)
virtual void	defaultWindows (QMap< int, int > &) const
void	defaultViewManagers (QStringList &) const
virtual void	setActiveStudy (SUIT_Study *)
virtual void	beforeCloseDoc (SUIT_Study *)
virtual void	moduleAdded (CAM_Module *)
virtual bool	activateModule (CAM_Module *=0)
LightApp_Preferences *	preferences (const bool) const
virtual void	preferencesChanged (const QString &, const QString &)
virtual void	loadPreferences ()
virtual void	savePreferences ()
void	updateWindows ()
void	updateViewManagers ()
void	updateModuleActions ()
void	removeModuleAction (const QString &)
void	loadDockWindowsState ()
void	saveDockWindowsState ()
virtual void	studyOpened (SUIT_Study *)
virtual void	studyCreated (SUIT_Study *)
virtual void	studySaved (SUIT_Study *)
void	updatePreference (const QString &, const QString &, const QString &)
QString	defaultModule () const
virtual void	currentWindows (QMap< int, int > &) const
void	currentViewManagers (QStringList &) const
void	moduleIconNames (QMap< QString, QString > &) const
bool	isLibExists (const QString &) const
QDockWidget *	windowDock (QWidget *) const
QByteArray	dockWindowsState (const QMap< QString, bool > &, const QMap< QString, bool > &) const
void	dockWindowsState (const QByteArray &, QMap< QString, bool > &, QMap< QString, bool > &) const
void	showPreferences (const QString &=QString())
Protected Member Functions inherited from CAM_Application
virtual bool	abortAllOperations ()
	Abort active operations if there are any. More...
Protected Member Functions inherited from STD_Application
virtual void	setActiveViewManager (SUIT_ViewManager *)
virtual bool	closeDoc (bool ask=true)
virtual bool	closeActiveDoc (bool permanently=true)
Protected Member Functions inherited from SUIT_Application
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)
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())
QAction *	createAction (const int, const QString &, const QIcon &, const QString &, const QString &, const QKeySequence &, QObject *=0, const bool=false, QObject *=0, const char *=0, const QString &=QString())
int	createTool (const QString &, const QString &=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)
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)
void	setMenuShown (QAction *, const bool)
void	setMenuShown (const int, const bool)
void	setToolShown (QAction *, const bool)
void	setToolShown (const int, const bool)

Private Slots
void	onDeleteInvalidReferences ()
void	onDblClick (SUIT_DataObject *)
void	onProperties ()
void	onDumpStudy ()
void	onLoadScript ()
void	onDeleteGUIState ()
void	onRestoreGUIState ()
void	onCatalogGen ()
void	onRegDisplay ()
void	onOpenWith ()
void	onExtAction ()

Private Member Functions
void	createExtraActions ()

Private Attributes
QPointer< SalomeApp_NoteBook >	myNoteBook
QMap< QString, QAction * >	myExtActions
bool	myIsCloseFromExit

Additional Inherited Members
Static Protected Member Functions inherited from CAM_Application
static QString	moduleLibrary (const QString &, const bool=true)
	Get module library name by its title (user name). More...
Protected Attributes inherited from LightApp_Application
LightApp_Preferences *	myPrefs
LightApp_SelectionMgr *	mySelMgr
LightApp_FullScreenHelper *	myScreenHelper
WinMap	myWin
WinVis	myWinVis
SUIT_Accel *	myAccel
QTimer *	myAutoSaveTimer
QStringList	myUserWmTypes
Static Protected Attributes inherited from LightApp_Application
static LightApp_Preferences *	_prefs_ = 0
static int	lastStudyId = 0

Member Enumeration Documentation

anonymous enum

Enumerator
MenuToolsId

anonymous enum

Enumerator
DumpStudyId
LoadScriptId
PropertiesId
CatalogGenId
RegDisplayId
SaveGUIStateId
ConnectId
DisconnectId
UserID

anonymous enum

protected

Enumerator
OpenRefresh

anonymous enum

protected

Enumerator
CloseDisconnectSave
CloseDisconnect

anonymous enum

protected

Enumerator
LoadStudyId
NewAndScriptId

enum SalomeApp_Application::WindowTypes

Enumerator
WT_NoteBook
WT_User

Constructor & Destructor Documentation

SalomeApp_Application::SalomeApp_Application

(

)

Constructor.

SalomeApp_Application::~SalomeApp_Application ( )

virtual

Destructor.

• Destroy event filter.

Member Function Documentation

QMap< int, QString > SalomeApp_Application::activateModuleActions ( ) const

protectedvirtual

The method should return the map of the kind { <id>:<name>} where <id> is an integer identifier of the operation and <name> is a title for the button to be added to the dialog box. After user selects the required operation by the clicking the corresponding button in the dialog box, its identifier is passed to the moduleActionSelected() method to process the made choice.

Returns

map of the operations

See Also

moduleActionSelected()

Reimplemented from LightApp_Application.

References LightApp_Application::activateModuleActions(), LoadStudyId, and NewAndScriptId.

void SalomeApp_Application::afterCloseDoc ( )

protectedvirtual

Close the Application

Reimplemented from LightApp_Application.

References LightApp_Application::afterCloseDoc(), dumpedStudyClosed(), and myNoteBook.

bool SalomeApp_Application::checkDataObject ( LightApp_DataObject *  theObj )

virtual

Check data object

Reimplemented from LightApp_Application.

bool SalomeApp_Application::checkExistingDoc ( )

virtual

Check existing document.

Reimplemented from LightApp_Application.

References SUIT_Application::activeStudy(), LightApp_Application::checkExistingDoc(), SUIT_MessageBox::critical(), SUIT_Application::desktop(), and studyMgr().

bool SalomeApp_Application::closeAction ( const int  choice, bool &  closePermanently  )

protectedvirtual

Reimplemented from STD_Application.

References SUIT_Application::activeStudy(), STD_Application::closeActiveDoc(), STD_Application::CloseCancel, STD_Application::CloseDiscard, CloseDisconnect, CloseDisconnectSave, STD_Application::CloseSave, STD_Application::onSaveAsDoc(), and STD_Application::onSaveDoc().

int SalomeApp_Application::closeChoice ( const QString &  docName )

protectedvirtual

Reimplemented from STD_Application.

References STD_Application::CloseCancel, STD_Application::CloseDiscard, CloseDisconnect, CloseDisconnectSave, STD_Application::CloseSave, SUIT_Application::desktop(), myIsCloseFromExit, and SUIT_MessageBox::question().

void SalomeApp_Application::contextMenuPopup ( const QString &  type, QMenu *  thePopup, QString &  title  )

virtual

Insert items in popup, which necessary for current application

Reimplemented from LightApp_Application.

References _PTR(), CAM_Application::activeModule(), SUIT_Application::activeStudy(), LightApp_Application::contextMenuPopup(), Handle(), LightApp_SelectionMgr::isSelectionCacheEnabled(), CAM_Module::moduleName(), CAM_Application::moduleTitle(), myExtActions, LightApp_Application::objectBrowser(), onDeleteGUIState(), onDeleteInvalidReferences(), onOpenWith(), onRestoreGUIState(), SUIT_DataBrowser::RenameShortcut, LightApp_SelectionMgr::selectedObjects(), LightApp_Application::selectionMgr(), and LightApp_SelectionMgr::setSelectionCacheEnabled().

void SalomeApp_Application::createActions ( )

protectedvirtual

Create actions:

Save GUI state

Dump study

Load script

Properties

Catalog Generator

Registry Display

Reimplemented from LightApp_Application.

References CatalogGenId, ConnectId, SUIT_Application::createAction(), LightApp_Application::createActions(), createExtraActions(), SUIT_Application::createMenu(), SUIT_Application::desktop(), DisconnectId, DumpStudyId, LoadScriptId, MenuToolsId, onCatalogGen(), onDumpStudy(), onLoadDoc(), onLoadScript(), onProperties(), onRegDisplay(), onUnloadDoc(), PropertiesId, RegDisplayId, and SUIT_Application::separator().

void SalomeApp_Application::createExtraActions ( )

private

Define extra actions defined in module definition XML file. Additional popup items sections can be defined by parameter "popupitems". Supported attributes: title - title of menu item, attributelocalid - AttributeLocalId defined for selected data item where menu command has to be applied, method - method which has to be called when menu item is selected Example: <section name="MODULENAME"> <parameter name="popupitems" value="menuitem1:menuitem2:..."> </section> <section name="importmed"> <parameter name="title" value="My menu"> <parameter name="objectid" value="VISU.Result"> <parameter name="method" value="nameOfModuleMethod"> </section>

References CAM_Application::moduleName(), CAM_Application::modules(), myExtActions, onExtAction(), SUIT_Session::resourceMgr(), SUIT_Session::session(), and QtxResourceMgr::stringValue().

SUIT_Study * SalomeApp_Application::createNewStudy ( )

protectedvirtual

Creates new study

Reimplemented from LightApp_Application.

References notebookVarUpdated(), LightApp_Application::onStudyClosed(), onStudyCreated(), onStudyOpened(), and LightApp_Application::onStudySaved().

void SalomeApp_Application::createPreferences ( LightApp_Preferences *  pref )

protectedvirtual

Create preferences.

Reimplemented from LightApp_Application.

References LightApp_Preferences::addPreference(), SUIT_PreferenceMgr::Bool, LightApp_Application::createPreferences(), LightApp_DataObject::EntryId, SalomeApp_DataObject::LastId, SUIT_PreferenceMgr::setItemProperty(), SUIT_PreferenceMgr::Space, and Vertical.

PyConsole_Interp * SalomeApp_Application::createPyInterp ( )

protectedvirtual

Reimplemented from LightApp_Application.

QWidget * SalomeApp_Application::createWindow ( const int  flag )

protectedvirtual

Create window.

Reimplemented from LightApp_Application.

References _PTR(), SUIT_Application::activeStudy(), QtxResourceMgr::booleanValue(), LightApp_Application::createWindow(), SUIT_Application::desktop(), LightApp_DataObject::EntryId, getNoteBook(), LightApp_Application::getPyInterp(), SalomeApp_DataObject::IORId, SalomeApp_DataObject::LastId, OB_Browser::model(), notebookVarUpdated(), onDblClick(), LightApp_DataObject::RefEntryId, SUIT_AbstractModel::registerColumn(), SUIT_Application::resourceMgr(), SUIT_AbstractModel::setAppropriate(), SUIT_DataBrowser::setAutoSizeColumns(), SUIT_DataBrowser::setAutoSizeFirstColumn(), SUIT_DataBrowser::setAutoUpdate(), setNoteBook(), SUIT_DataBrowser::setResizeOnExpandItem(), SUIT_DataBrowser::setUpdateModified(), Qtx::Toggled, OB_Browser::treeView(), SalomeApp_DataObject::ValueId, WT_NoteBook, LightApp_Application::WT_ObjectBrowser, and LightApp_Application::WT_PyConsole.

void SalomeApp_Application::dumpedStudyClosed ( const QString &  theDumpScript, const QString &  theStudyName, bool  theIsStudySaved  )

signal

SalomeApp_NoteBook * SalomeApp_Application::getNoteBook ( ) const

virtual

Return SalomeApp_NoteBook pointer

References myNoteBook.

bool SalomeApp_Application::isPossibleToClose ( bool &  closePermanently )

virtual

Check the application on closing.

Return values

true	if possible, else false

Reimplemented from STD_Application.

References STD_Application::isPossibleToClose().

SALOME_LifeCycleCORBA * SalomeApp_Application::lcc ( )

static

Create and return SALOME_LifeCycleCORBA.

References namingService().

void SalomeApp_Application::moduleActionSelected ( const int  id )

protectedvirtual

Performs the required operation according to the user choice.

Parameters

id	operation identifier

See Also

activateModuleActions()

Reimplemented from LightApp_Application.

References LoadStudyId, LightApp_Application::moduleActionSelected(), NewAndScriptId, onLoadDoc(), and onNewWithScript().

SALOME_NamingService * SalomeApp_Application::namingService ( )

static

Create and return SALOME_NamingService.

References orb().

SUIT_ViewManager * SalomeApp_Application::newViewManager

(

const QString &

type

)

Creates new view manager

Parameters

type	- type of view manager

References LightApp_Application::createViewManager().

void SalomeApp_Application::notebookVarUpdated ( QString  theVarName )

signal

void SalomeApp_Application::objectBrowserColumnsVisibility ( )

protected

Show/hide object browser colums according to preferences

References QtxResourceMgr::booleanValue(), LightApp_DataObject::EntryId, SalomeApp_DataObject::LastId, LightApp_Application::objectBrowser(), SUIT_Application::resourceMgr(), and OB_Browser::treeView().

void SalomeApp_Application::objectDoubleClicked ( SUIT_DataObject *  )

signal

void SalomeApp_Application::onCatalogGen ( )

privateslot

Display Catalog Genenerator dialog

References SUIT_Application::desktop().

void SalomeApp_Application::onCloseDoc ( bool  ask = true )

virtualslot

Check if the study is locked

References _PTR(), SUIT_Application::activeStudy(), SUIT_Application::desktop(), STD_Application::onCloseDoc(), and SUIT_MessageBox::question().

void SalomeApp_Application::onCopy ( )

virtualslot

SLOT. Copy objects to study maneger from selection maneger..

References _PTR(), SUIT_Application::activeStudy(), onSelectionChanged(), LightApp_SelectionMgr::selectedObjects(), LightApp_Application::selectionMgr(), and studyMgr().

void SalomeApp_Application::onDblClick ( SUIT_DataObject *  theObj )

privateslot

find original object by double click on item

References SUIT_DataOwnerPtrList::append(), LightApp_DataObject::isReference(), obj, LightApp_Application::objectBrowser(), objectDoubleClicked(), LightApp_DataObject::refEntry(), OB_Browser::selectedIndexes(), LightApp_Application::selectionMgr(), LightApp_SelectionMgr::setSelected(), and OB_Browser::treeView().

void SalomeApp_Application::onDeleteGUIState ( )

privateslot

Called on Delete GUI State popup command

References SUIT_Application::activeStudy(), getSelectedSavePoint(), SalomeApp_Study::removeSavePoint(), LightApp_Application::selectionMgr(), and updateSavePointDataObjects().

void SalomeApp_Application::onDeleteInvalidReferences ( )

privateslot

Delete references.

References _PTR(), SUIT_Application::activeStudy(), LightApp_SelectionMgr::selectedObjects(), LightApp_Application::selectionMgr(), and updateObjectBrowser().

void SalomeApp_Application::onDesktopMessage ( const QString &  message )

protectedslot

SLOT. Parse message for desktop.

References SUIT_Application::action(), STD_Application::closeActiveDoc(), ConnectId, LightApp_Application::onDesktopMessage(), onLoadDoc(), and updateCommandsStatus().

void SalomeApp_Application::onDockWindowVisibilityChanged ( bool  theIsVisible )

virtualslot

Public SLOT. Performs some actions when dockable windows are triggered.

References objectBrowserColumnsVisibility(), and LightApp_Application::onDockWindowVisibilityChanged().

void SalomeApp_Application::onDumpStudy ( )

privateslot

Private SLOT. On dump study.

References _PTR(), SUIT_Application::activeStudy(), SUIT_Application::desktop(), SalomeApp_Study::dump(), DumpStudyFileDlg::myMultiFileChk, DumpStudyFileDlg::myPublishChk, DumpStudyFileDlg::mySaveGUIChk, SUIT_Application::resourceMgr(), SUIT_FileDlg::selectedFile(), SUIT_FileDlg::setValidator(), and SUIT_MessageBox::warning().

void SalomeApp_Application::onExit ( )

virtualslot

References SUIT_Session::ASK, SUIT_Session::closeSession(), SUIT_Application::desktop(), STD_Application::exitConfirmation(), SalomeApp_ExitDlg::isServersShutdown(), myIsCloseFromExit, and SUIT_Session::session().

void SalomeApp_Application::onExtAction ( )

privateslot

Called when extra action is selected

References LightApp_Application::activateModule(), CAM_Application::activeModule(), Handle(), CAM_Application::moduleTitle(), LightApp_SelectionMgr::selectedObjects(), and LightApp_Application::selectionMgr().

void SalomeApp_Application::onLoadDoc ( )

virtualslot

SLOT. Load document.

References SUIT_Application::desktop(), studyMgr(), updateObjectBrowser(), LightApp_Application::updateViewManagers(), LightApp_Application::updateWindows(), and SUIT_MessageBox::warning().

bool SalomeApp_Application::onLoadDoc ( const QString &  aName )

virtualslot

SLOT. Load document with aName.

References SUIT_Application::activeStudy(), SUIT_Session::applications(), STD_Application::closeDoc(), SUIT_Application::desktop(), SUIT_Session::session(), SUIT_Application::startApplication(), SUIT_Study::studyName(), and useStudy().

void SalomeApp_Application::onLoadScript ( )

privateslot

Private SLOT. On load script.

References _PTR(), SUIT_Application::activeStudy(), SUIT_Application::desktop(), SUIT_FileDlg::getFileName(), SUIT_FileDlg::getLastVisitedPath(), LightApp_Application::pythonConsole(), and SUIT_MessageBox::warning().

void SalomeApp_Application::onNewWithScript ( )

virtualslot

SLOT. Create new study and load script

References SUIT_Application::desktop(), SUIT_FileDlg::getFileName(), SUIT_FileDlg::getLastVisitedPath(), LightApp_Application::onNewDoc(), and LightApp_Application::pythonConsole().

void SalomeApp_Application::onOpenWith ( )

privateslot

Private SLOT.

References LightApp_Application::activateModule(), Handle(), CAM_Application::moduleTitle(), LightApp_SelectionMgr::selectedObjects(), and LightApp_Application::selectionMgr().

void SalomeApp_Application::onPaste ( )

virtualslot

SLOT. Paste objects to study maneger from selection manager.

References _PTR(), SUIT_Application::activeStudy(), SUIT_Application::desktop(), LightApp_SelectionMgr::selectedObjects(), LightApp_Application::selectionMgr(), studyMgr(), LightApp_Application::updateActions(), updateObjectBrowser(), and SUIT_MessageBox::warning().

void SalomeApp_Application::onProperties ( )

privateslot

Private SLOT. On preferences.

References _PTR(), SUIT_Application::activeStudy(), SUIT_Application::desktop(), SalomeApp_StudyPropertiesDlg::isChanged(), LightApp_Application::updateActions(), and updateDesktopTitle().

void SalomeApp_Application::onRegDisplay ( )

privateslot

Display Registry Display dialog

References SUIT_Application::desktop(), ToolsGUI_RegWidget::GetRegWidget(), and orb().

void SalomeApp_Application::onRestoreGUIState ( )

privateslot

Called on Restore GUI State popup command

References getSelectedSavePoint(), SalomeApp_VisualState::restoreState(), and LightApp_Application::selectionMgr().

bool SalomeApp_Application::onRestoreStudy ( const QString &  theDumpScript, const QString &  theStudyName, bool  theIsStudySaved  )

slot

Function : onRestoreStudy Purpose : Load the dumped study from Python script

References _PTR(), SUIT_Session::activeApplication(), SUIT_Application::activeStudy(), app, getNoteBook(), SalomeApp_NoteBook::Init(), LightApp_Application::onNewDoc(), LightApp_Application::pythonConsole(), SUIT_Session::session(), LightApp_Application::updateActions(), and updateDesktopTitle().

void SalomeApp_Application::onSaveGUIState ( )

slot

Private SLOT. On save GUI state.

References SUIT_Application::activeStudy(), SalomeApp_VisualState::storeState(), LightApp_Application::updateActions(), updateObjectBrowser(), and updateSavePointDataObjects().

void SalomeApp_Application::onSelectionChanged ( )

protectedvirtual

Sets enable or disable some actions on selection changed.

Reimplemented from LightApp_Application.

References _PTR(), SUIT_Application::action(), CAM_Application::activeModule(), SUIT_Application::activeStudy(), LightApp_Module::canCopy(), LightApp_Module::canPaste(), STD_Application::EditCopyId, STD_Application::EditPasteId, LightApp_SelectionMgr::selectedObjects(), LightApp_Application::selectionMgr(), and studyMgr().

void SalomeApp_Application::onStudyCreated ( SUIT_Study *  study )

protectedslot

Called on New study operation

References LightApp_Application::loadDockWindowsState(), objectBrowserColumnsVisibility(), and LightApp_Application::onStudyCreated().

void SalomeApp_Application::onStudyOpened ( SUIT_Study *  study )

protectedslot

Called on Open study operation

References LightApp_Application::loadDockWindowsState(), objectBrowserColumnsVisibility(), and LightApp_Application::onStudyOpened().

void SalomeApp_Application::onUnloadDoc ( bool  ask = true )

virtualslot

SLOT. Unload document.

References SUIT_Study::abortAllOperations(), SUIT_Application::activeStudy(), STD_Application::closeActiveDoc(), SUIT_Application::desktop(), STD_Application::onSaveAsDoc(), STD_Application::onSaveDoc(), SUIT_MessageBox::question(), and SUIT_Study::studyName().

void SalomeApp_Application::onUpdateStudy ( )

slot

Function : onUpdateStudy Purpose : Slot to update the study.

References SUIT_Application::desktop(), updateStudy(), and SUIT_MessageBox::warning().

bool SalomeApp_Application::openAction ( const int  aChoice, const QString &  aName  )

protectedvirtual

Reimplemented from LightApp_Application.

References _PTR(), LightApp_Application::openAction(), STD_Application::OpenNew, OpenRefresh, and studyMgr().

int SalomeApp_Application::openChoice ( const QString &  aName )

protectedvirtual

Reimplemented from LightApp_Application.

References SUIT_Application::desktop(), STD_Application::OpenCancel, LightApp_Application::openChoice(), STD_Application::OpenNew, OpenRefresh, SUIT_MessageBox::question(), studyMgr(), and SUIT_MessageBox::warning().

CORBA::ORB_var SalomeApp_Application::orb ( )

static

Gets CORBA::ORB_var

References Qtx::CmdLineArgs::argc(), and Qtx::CmdLineArgs::argv().

bool SalomeApp_Application::renameAllowed ( const QString &  entry ) const

virtual

Checks that an object can be renamed.

Parameters

entry

entry of the object

Reimplemented from LightApp_Application.

bool SalomeApp_Application::renameObject ( const QString &  entry, const QString &  name  )

virtual

Rename object by entry.

Parameters

entry	entry of the object
name	new name of the object

Reimplemented from LightApp_Application.

References SUIT_Application::activeStudy(), getSelectedSavePoint(), SalomeApp_Study::Modified(), LightApp_Application::selectionMgr(), SalomeApp_Study::setNameOfSavePoint(), and updateSavePointDataObjects().

void SalomeApp_Application::setNoteBook ( SalomeApp_NoteBook *  theNoteBook )

virtual

Set SalomeApp_NoteBook pointer

References myNoteBook.

void SalomeApp_Application::start ( )

virtual

Start application.

Reimplemented from LightApp_Application.

References __getArgsList(), _PTR(), SUIT_Application::activeStudy(), SALOME_EventFilter::Init(), onLoadDoc(), LightApp_Application::onNewDoc(), LightApp_Application::onOpenDoc(), LightApp_Application::pythonConsole(), LightApp_Application::start(), and updateObjectBrowser().

SALOMEDSClient_StudyManager * SalomeApp_Application::studyMgr ( )

static

Create and return SALOMEDS_StudyManager.

References _PTR().

void SalomeApp_Application::updateCommandsStatus ( )

protectedvirtual

Enable/Disable menu items and toolbar buttons. Rebuild menu

Reimplemented from LightApp_Application.

References SUIT_Application::action(), SUIT_Application::activeStudy(), ConnectId, DisconnectId, DumpStudyId, LoadScriptId, onSelectionChanged(), PropertiesId, LightApp_Application::pythonConsole(), SaveGUIStateId, studyMgr(), and LightApp_Application::updateCommandsStatus().

void SalomeApp_Application::updateDesktopTitle ( )

virtual

Update desktop title.

Reimplemented from LightApp_Application.

References _PTR(), SUIT_Application::activeStudy(), LightApp_Application::applicationName(), LightApp_Application::applicationVersion(), SUIT_Application::desktop(), and Qtx::file().

void SalomeApp_Application::updateObjectBrowser ( const bool  updateModels = true )

virtual

Update obect browser: 1.if 'updateModels' true, update existing data models;

1. update "non-existing" (not loaded yet) data models;
2. update object browser if it exists

Reimplemented from LightApp_Application.

References _PTR(), SUIT_Application::activeStudy(), SUIT_DataBrowser::autoUpdate(), LightApp_Study::getVisualComponentName(), LightApp_Application::getWindow(), LightApp_Application::objectBrowser(), SUIT_DataBrowser::setAutoUpdate(), SalomeApp_DataModel::synchronize(), LightApp_Application::updateObjectBrowser(), updateSavePointDataObjects(), and LightApp_Application::WT_ObjectBrowser.

void SalomeApp_Application::updateSavePointDataObjects

(

SalomeApp_Study *

study

)

updateSavePointDataObjects: syncronize data objects that correspond to save points (gui states)

References SUIT_DataObject::appendChild(), SUIT_DataBrowser::autoUpdate(), SUIT_DataObject::children(), SUIT_SelectionMgr::clearSelected(), SalomeApp_SavePointObject::getId(), SalomeApp_Study::getSavePoints(), SUIT_DataObject::nextBrother(), LightApp_Application::objectBrowser(), SUIT_DataObject::removeChild(), SUIT_Study::root(), LightApp_Application::selectionMgr(), and SUIT_DataBrowser::setAutoUpdate().

bool SalomeApp_Application::updateStudy ( )

protected

Function : updateStudy Purpose : Update study by dumping the study to Python script and loading it. It is used to apply variable modifications done in NoteBook to created objects.

References _PTR(), SUIT_Application::activeStudy(), app, SUIT_Session::applications(), dumpedStudyClosed(), SalomeApp_Study::isSaved(), myNoteBook, onCloseDoc(), onRestoreStudy(), SalomeApp_Study::removeSavePoint(), SUIT_Session::session(), SalomeApp_VisualState::storeState(), and SalomeApp_Study::studyName().

bool SalomeApp_Application::useStudy ( const QString &  theName )

virtual

Opens other study into active Study. If Study is empty - creates it.

Parameters

theName

- name of study

References SUIT_Application::activeStudy(), LightApp_Application::createEmptyStudy(), SalomeApp_Study::loadDocument(), updateCommandsStatus(), and updateDesktopTitle().

Member Data Documentation

QMap<QString, QAction*> SalomeApp_Application::myExtActions

private

bool SalomeApp_Application::myIsCloseFromExit

private

QPointer<SalomeApp_NoteBook> SalomeApp_Application::myNoteBook

private

---

The documentation for this class was generated from the following files:

• src/SalomeApp/SalomeApp_Application.h
• src/SalomeApp/SalomeApp_Application.cxx