Version: 9.12.0
SalomeApp_Application Class Reference

Application containing SalomeApp module or LightApp module. More...

#include <SalomeApp_Application.h>

Inheritance diagram for SalomeApp_Application:
Inheritance graph

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_InfoPanel , 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 , NewPV3DViewId ,
  StyleId , FullScreenId , WebSiteId , ForumId ,
  VideosId , TutorialsId , UserID
}
 
- Public Types inherited from CAM_Application
typedef QList< CAM_Module * > ModuleList
 
typedef QList< ModuleShortInfoModuleShortInfoList
 
- 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 onNewDoc ()
 
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 onOpenDoc ()
 
virtual bool onOpenDoc (const QString &)
 
virtual bool onReopenDoc ()
 
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)
 
- Public Slots inherited from STD_Application
virtual void onNewDoc ()
 
virtual bool onNewDoc (const QString &)
 
virtual void onCloseDoc (bool ask=true)
 
virtual bool 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 *)
 
- Public Slots inherited from SUIT_Application
virtual void onHelpContextModule (const QString &, const QString &, const QString &=QString())
 

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 moduleActivated (const QString &)
 
void studyOpened ()
 
void studySaved ()
 
void studyClosed ()
 
void preferenceChanged (const QString &, const QString &, const QString &)
 
void preferenceResetToDefaults ()
 
void operationFinished (const QString &, const QString &, const QStringList &)
 
- Signals inherited from STD_Application
void viewManagerAdded (SUIT_ViewManager *)
 
void viewManagerRemoved (SUIT_ViewManager *)
 
void viewManagerActivated (SUIT_ViewManager *)
 
void appClosed ()
 
- Signals inherited from SUIT_Application
void applicationClosed (SUIT_Application *)
 
void activated (SUIT_Application *)
 
void infoChanged (QString)
 

Public Member Functions

 SalomeApp_Application (SALOME_NamingService_Abstract *ns=nullptr)
 
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_ViewManagernewViewManager (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_NoteBookgetNoteBook () 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_ModuleloadModule (const QString &, const bool=true)
 
virtual bool activateModule (const QString &)
 
LightApp_SelectionMgrselectionMgr () const
 
LogWindowlogWindow ()
 
SUIT_DataBrowserobjectBrowser ()
 
QtxInfoPanelinfoPanel ()
 
PyConsole_Console * pythonConsole (const bool force=false)
 
LightApp_Preferencespreferences () 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_ViewManagergetViewManager (const QString &, const bool)
 
virtual void addViewManager (SUIT_ViewManager *)
 
virtual void removeViewManager (SUIT_ViewManager *)
 
virtual SUIT_ViewManagercreateViewManager (const QString &vmType, bool detached=false)
 
virtual SUIT_ViewManagercreateViewManager (const QString &vmType, QWidget *w)
 
virtual SUIT_ViewManagercreateViewManager (SUIT_ViewModel *)
 
QWidgetgetWindow (const int)
 
QWidgetdockWindow (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_Accelaccel () 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_DataObjectfindObject (const QString &) const
 
void emitOperationFinished (const QString &, const QString &, const QStringList &)
 Emits operationFinished signal. More...
 
void updateVisibilityState (DataObjectList &theList, SUIT_ViewModel *theViewModel)
 
void updatePresentations (const QString &theComponent, const QStringList &theViewManagerTypes)
 
virtual bool checkExistingDoc (bool=true)
 
PyConsole_InterpgetPyInterp ()
 
- Public Member Functions inherited from CAM_Application
 CAM_Application (const bool=true)
 Constructor. More...
 
virtual ~CAM_Application ()
 Destructor. More...
 
CAM_ModuleactiveModule () const
 Get active module. More...
 
CAM_Modulemodule (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, const 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_ViewManageractiveViewManager () const
 
SUIT_ViewManagerviewManager (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)
 
int showNotification (const QString &message, const QString &title, int timeout=-1)
 Show notification with specified text and title. More...
 
void hideNotification (const QString &message)
 Close notifications with specified text. More...
 
void hideNotification (int id)
 Closes the notifications with specified identifier. More...
 
- Public Member Functions inherited from SUIT_Application
 SUIT_Application ()
 
virtual ~SUIT_Application ()
 
virtual SUIT_Desktopdesktop ()
 Returns main widget (Desktop) of the application (if it exists) More...
 
virtual SUIT_StudyactiveStudy () const
 Returns active Study. If Application supports wirking with several studies this method should be redefined. More...
 
virtual int getNbStudies () const
 
SUIT_ResourceMgrresourceMgr () const
 
SUIT_ShortcutMgrshortcutMgr () const
 Get access to shortcut manager. More...
 
void putInfo (const QString &, const int=0)
 Puts the message to the status bar
More...
 
QActionaction (const int) const
 
void addPostRoutine (void(*theRoutine)())
 
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)
 
void clearTool (const QString &)
 
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)
 

Static Public Member Functions

static CORBA::ORB_var orb ()
 
static _PTR (Study) getStudy()
 
static SALOME_NamingService_Abstract * namingService ()
 
static SALOME_LifeCycleCORBA * lcc ()
 
- 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 QString moduleDescription (const QString &)
 Get module description. More...
 
static QString moduleLibrary (const QString &, const bool=true)
 Get module library name by its title (user name). More...
 
static QString moduleDisplayer (const QString &)
 Get displayer proxy for given module, by its title (user name). More...
 
static ModuleShortInfoList getVersionInfo ()
 Return information about version of the each module. More...
 
static void logUserEvent (const QString &)
 Log GUI event. More...
 
static void logAction (QAction *, const QString &=QString())
 Log given action. More...
 
static void logStructuredUserEvent (const QString &module, const QString &section, const QString &action, const QString &event, const QString &message="")
 

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< QWidgetWinPtr
 
typedef QMap< int, WinPtrWinMap
 
typedef QMap< QString, QByteArray > WinVis
 
typedef QMap< QString, QByteArray > WinGeom
 
typedef QList< int > IdList
 
typedef QMap< QString, IdListIdMap
 
- Protected Types inherited from STD_Application
enum  { OpenCancel , OpenNew , OpenExist }
 
enum  { CloseCancel , CloseSave , CloseDiscard }
 

Protected Slots

void onStudyCreated (SUIT_Study *)
 
void onStudyOpened (SUIT_Study *)
 
void onDesktopMessage (const QString &)
 
virtual void onModuleActivation (const QString &)
 
- Protected Slots inherited from LightApp_Application
virtual void onDesktopActivated ()
 
virtual void onViewManagerRemoved (SUIT_ViewManager *)
 
virtual void onWindowActivated (SUIT_ViewWindow *theViewWindow)
 
void onNewWindow ()
 
virtual void onModuleActivation (const QString &)
 
void onExtAdding ()
 
void onExtRemoving (const QString &)
 
void onShowExtInfo ()
 
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 &)
 
virtual void onInfoPanelShown ()
 
- Protected Slots inherited from SUIT_Application
virtual void onDesktopActivated ()
 

Protected Member Functions

virtual void createActions ()
 
virtual SUIT_StudycreateNewStudy ()
 
virtual QWidgetcreateWindow (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_InterpcreatePyInterp ()
 
virtual bool canOpenDoc (const QString &)
 
virtual void afterCloseDoc ()
 
virtual void addCatalogue (const QString &, const QString &)
 
- Protected Member Functions inherited from LightApp_Application
void showHelp (const QString &)
 
virtual void addExtensionsActions (LightApp_ModuleAction *moduleAction)
 
virtual void customize ()
 
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 void moduleDeactivated (CAM_Module *)
 Callback function, called when the module is just deactivated. More...
 
virtual bool activateModule (CAM_Module *=0)
 
LightApp_Preferencespreferences (const bool) const
 
virtual void preferencesChanged (const QString &, const QString &)
 
virtual void loadPreferences ()
 
virtual void savePreferences ()
 
void updateWindows ()
 
void updateViewManagers ()
 
void updateModuleActions ()
 
bool checkModule (const QString &)
 Check module availability. More...
 
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
 
QPixmap moduleIcon (const QString &, const int=-1) const
 
QDockWidgetwindowDock (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())
 
void showPreferences (const QStringList &)
 
- Protected Member Functions inherited from CAM_Application
virtual bool abortAllOperations ()
 Abort active operations if there are any. More...
 
bool appendModuleInfo (const QString &)
 
void removeModuleInfo (const QString &)
 
- 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
void setMenuShown (QAction *, const bool)
 
void setMenuShown (const int, const bool)
 
void setToolShown (QAction *, const bool)
 
void setToolShown (const int, const bool)
 
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 *)
 
QActioncreateAction (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())
 
QActioncreateAction (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())
 
SUIT_ApplicationstartApplication (int, char **) const
 
SUIT_ApplicationstartApplication (const QString &, int, char **) const
 

Static Protected Attributes

static std::unique_ptr< SALOME_NamingService_Abstract > _ns
 
- Static Protected Attributes inherited from LightApp_Application
static LightApp_Preferences_prefs_ = 0
 

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 ()
 
void ensureShaperIsActivated ()
 

Private Attributes

QPointer< SalomeApp_NoteBookmyNoteBook
 
QMap< QString, QAction * > myExtActions
 
bool myIsCloseFromExit
 
bool myToIgnoreMessages
 

Additional Inherited Members

- Static Protected Member Functions inherited from SUIT_Application
static QActionseparator ()
 
- Protected Attributes inherited from LightApp_Application
LightApp_PreferencesmyPrefs
 
LightApp_SelectionMgrmySelMgr
 
LightApp_FullScreenHelpermyScreenHelper
 
WinMap myWin
 
WinVis myWinVis
 
IdMap myHelpItems
 
SUIT_AccelmyAccel
 
QTimer * myAutoSaveTimer
 
QStringList myUserWmTypes
 

Detailed Description

Application containing SalomeApp module or LightApp module.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MenuToolsId 

◆ anonymous enum

anonymous enum
Enumerator
DumpStudyId 
LoadScriptId 
PropertiesId 
CatalogGenId 
RegDisplayId 
SaveGUIStateId 
ConnectId 
DisconnectId 
UserID 

◆ anonymous enum

anonymous enum
protected
Enumerator
OpenRefresh 

◆ anonymous enum

anonymous enum
protected
Enumerator
CloseDisconnectSave 
CloseDisconnect 

◆ anonymous enum

anonymous enum
protected
Enumerator
LoadStudyId 
NewAndScriptId 

◆ WindowTypes

Enumerator
WT_NoteBook 
WT_User 

Constructor & Destructor Documentation

◆ SalomeApp_Application()

SalomeApp_Application::SalomeApp_Application ( SALOME_NamingService_Abstract *  ns = nullptr)

Constructor.

References _ns, and orb().

◆ ~SalomeApp_Application()

SalomeApp_Application::~SalomeApp_Application ( )
virtual

Destructor.

  • Destroy event filter.

Member Function Documentation

◆ _PTR()

static SalomeApp_Application::_PTR ( Study  )
static

◆ activateModuleActions()

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

Get map of the operations which can be performed on the module activation.

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.

◆ addCatalogue()

void SalomeApp_Application::addCatalogue ( const QString &  moduleName,
const QString &  catalogue 
)
protectedvirtual

◆ afterCloseDoc()

void SalomeApp_Application::afterCloseDoc ( )
protectedvirtual

Close the Application

Reimplemented from LightApp_Application.

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

◆ canOpenDoc()

bool SalomeApp_Application::canOpenDoc ( const QString &  url)
protectedvirtual

Reimplemented from LightApp_Application.

References _PTR().

◆ checkDataObject()

bool SalomeApp_Application::checkDataObject ( LightApp_DataObject theObj)
virtual

Check data object

Reimplemented from LightApp_Application.

◆ checkExistingDoc()

bool SalomeApp_Application::checkExistingDoc ( )
virtual

◆ closeAction()

◆ closeChoice()

◆ contextMenuPopup()

◆ createActions()

◆ createExtraActions()

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

◆ createNewStudy()

SUIT_Study * SalomeApp_Application::createNewStudy ( )
protectedvirtual

◆ createPreferences()

◆ createPyInterp()

PyConsole_Interp * SalomeApp_Application::createPyInterp ( )
protectedvirtual

Reimplemented from LightApp_Application.

References SUIT_Application::resourceMgr().

◆ createWindow()

◆ dumpedStudyClosed

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

◆ ensureShaperIsActivated()

void SalomeApp_Application::ensureShaperIsActivated ( )
private

◆ getNoteBook()

SalomeApp_NoteBook * SalomeApp_Application::getNoteBook ( ) const
virtual

Return SalomeApp_NoteBook pointer

References myNoteBook.

◆ isPossibleToClose()

bool SalomeApp_Application::isPossibleToClose ( bool &  closePermanently)
virtual

Check the application on closing.

Return values
trueif possible, else false

Reimplemented from STD_Application.

References STD_Application::isPossibleToClose().

◆ lcc()

SALOME_LifeCycleCORBA * SalomeApp_Application::lcc ( )
static

Create and return SALOME_LifeCycleCORBA.

References namingService().

◆ moduleActionSelected()

void SalomeApp_Application::moduleActionSelected ( const int  id)
protectedvirtual

Called when the used selectes required operation chosen from "Activate module" dialog box.

Performs the required operation according to the user choice.

Parameters
idoperation identifier
See also
activateModuleActions()

Reimplemented from LightApp_Application.

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

◆ namingService()

SALOME_NamingService_Abstract * SalomeApp_Application::namingService ( )
static

Create and return SALOME_NamingService.

References _ns.

◆ newViewManager()

SUIT_ViewManager * SalomeApp_Application::newViewManager ( const QString &  type)

Creates new view manager

Parameters
type- type of view manager

References LightApp_Application::createViewManager().

◆ notebookVarUpdated

void SalomeApp_Application::notebookVarUpdated ( QString  theVarName)
signal

◆ objectBrowserColumnsVisibility()

void SalomeApp_Application::objectBrowserColumnsVisibility ( )
protected

◆ objectDoubleClicked

void SalomeApp_Application::objectDoubleClicked ( SUIT_DataObject )
signal

◆ onCatalogGen

void SalomeApp_Application::onCatalogGen ( )
privateslot

Display Catalog Genenerator dialog

References SUIT_Application::desktop().

◆ onCloseDoc

void SalomeApp_Application::onCloseDoc ( bool  ask = true)
virtualslot

◆ onCopy

void SalomeApp_Application::onCopy ( )
virtualslot

◆ onDblClick

◆ onDeleteGUIState

void SalomeApp_Application::onDeleteGUIState ( )
privateslot

◆ onDeleteInvalidReferences

void SalomeApp_Application::onDeleteInvalidReferences ( )
privateslot

◆ onDesktopMessage

void SalomeApp_Application::onDesktopMessage ( const QString &  message)
protectedslot

◆ onDockWindowVisibilityChanged

void SalomeApp_Application::onDockWindowVisibilityChanged ( bool  theIsVisible)
virtualslot

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

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

◆ onDumpStudy

◆ onExit

◆ onExtAction

◆ onLoadDoc [1/2]

◆ onLoadDoc [2/2]

bool SalomeApp_Application::onLoadDoc ( const QString &  aName)
virtualslot

◆ onLoadScript

void SalomeApp_Application::onLoadScript ( )
privateslot

◆ onModuleActivation

void SalomeApp_Application::onModuleActivation ( const QString &  modName)
protectedvirtualslot

On module activation action.

References SUIT_Application::activeStudy(), and LightApp_Application::onModuleActivation().

◆ onNewDoc

void SalomeApp_Application::onNewDoc ( )
virtualslot

SLOT. Create a document.

References myToIgnoreMessages, and LightApp_Application::onNewDoc().

◆ onNewWithScript

void SalomeApp_Application::onNewWithScript ( )
virtualslot

◆ onOpenDoc [1/2]

void SalomeApp_Application::onOpenDoc ( )
virtualslot

SLOT. Load document.

References myToIgnoreMessages, and LightApp_Application::onOpenDoc().

◆ onOpenDoc [2/2]

bool SalomeApp_Application::onOpenDoc ( const QString &  name)
virtualslot

SLOT. Load document.

References myToIgnoreMessages, and LightApp_Application::onOpenDoc().

◆ onOpenWith

◆ onPaste

◆ onProperties

void SalomeApp_Application::onProperties ( )
privateslot

◆ onRegDisplay

void SalomeApp_Application::onRegDisplay ( )
privateslot

Display Registry Display dialog

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

◆ onReopenDoc

bool SalomeApp_Application::onReopenDoc ( )
virtualslot

SLOT. Reload document from the file.

References myToIgnoreMessages, and STD_Application::onReopenDoc().

◆ onRestoreGUIState

void SalomeApp_Application::onRestoreGUIState ( )
privateslot

◆ onRestoreStudy

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

◆ onSaveGUIState

void SalomeApp_Application::onSaveGUIState ( )
slot

◆ onSelectionChanged()

void SalomeApp_Application::onSelectionChanged ( )
protectedvirtual

◆ onStudyCreated

void SalomeApp_Application::onStudyCreated ( SUIT_Study study)
protectedslot

◆ onStudyOpened

void SalomeApp_Application::onStudyOpened ( SUIT_Study study)
protectedslot

◆ onUnloadDoc

◆ onUpdateStudy

void SalomeApp_Application::onUpdateStudy ( )
slot

Function : onUpdateStudy Purpose : Slot to update the study.

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

◆ openAction()

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

◆ openChoice()

int SalomeApp_Application::openChoice ( const QString &  aName)
protectedvirtual

◆ orb()

CORBA::ORB_var SalomeApp_Application::orb ( )
static

Gets CORBA::ORB_var

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

◆ renameAllowed()

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

Return true if object can be renamed.

Checks that an object can be renamed.

Parameters
entryentry of the object

Reimplemented from LightApp_Application.

◆ renameObject()

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

Return true if rename operation finished successfully, false otherwise.

Rename object by entry.

Parameters
entryentry of the object
namenew name of the object

Reimplemented from LightApp_Application.

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

◆ setNoteBook()

void SalomeApp_Application::setNoteBook ( SalomeApp_NoteBook theNoteBook)
virtual

Set SalomeApp_NoteBook pointer

References myNoteBook.

◆ start()

void SalomeApp_Application::start ( )
virtual

◆ updateCommandsStatus()

void SalomeApp_Application::updateCommandsStatus ( )
protectedvirtual

◆ updateDesktopTitle()

void SalomeApp_Application::updateDesktopTitle ( )
virtual

◆ updateObjectBrowser()

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

◆ updateSavePointDataObjects()

◆ updateStudy()

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(), SUIT_Session::applications(), dumpedStudyClosed(), SalomeApp_Study::isSaved(), myNoteBook, onCloseDoc(), onRestoreStudy(), SalomeApp_Study::removeSavePoint(), SUIT_Session::session(), SalomeApp_VisualState::storeState(), and SalomeApp_Study::studyName().

◆ useStudy()

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

◆ _ns

std::unique_ptr< SALOME_NamingService_Abstract > SalomeApp_Application::_ns
staticprotected

◆ myExtActions

QMap<QString, QAction*> SalomeApp_Application::myExtActions
private

◆ myIsCloseFromExit

bool SalomeApp_Application::myIsCloseFromExit
private

◆ myNoteBook

QPointer<SalomeApp_NoteBook> SalomeApp_Application::myNoteBook
private

◆ myToIgnoreMessages

bool SalomeApp_Application::myToIgnoreMessages
private

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