CAF_Application Class Reference

#include <CAF_Application.h>

Inheritance diagram for CAF_Application:

Public Slots
virtual void	onHelpAbout ()
virtual void	onNewDoc ()
virtual void	onCloseDoc (bool ask=true)
virtual void	onSaveDoc ()
virtual bool	onSaveAsDoc ()
virtual void	onOpenDoc ()
virtual bool	onOpenDoc (const QString &)
virtual void	onLoadDoc ()
virtual bool	onLoadDoc (const QString &)
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 *)
Signals
void	viewManagerAdded (SUIT_ViewManager *)
void	viewManagerRemoved (SUIT_ViewManager *)
void	viewManagerActivated (SUIT_ViewManager *)
void	applicationClosed (SUIT_Application *)
void	activated (SUIT_Application *)
Public Member Functions
	CAF_Application ()
	CAF_Application (const Handle(TDocStd_Application)&)
virtual	~CAF_Application ()
virtual QString	applicationName () const
	Handle (TDocStd_Application) stdApp() const
virtual QString	getFileFilter () const
virtual bool	isPossibleToClose ()
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 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 &, QPopupMenu *, QString &)
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 bool	useStudy (const QString &theName)
	Loads document <theName> into active Study. If Study is empty - creates it.
virtual int	getNbStudies () const
SUIT_ResourceMgr *	resourceMgr () const
virtual SUIT_Convertor *	getConvertor (const SUIT_ViewModel *theViewer)
void	putInfo (const QString &, const int=0)
	Puts the message to the status bar.
Protected Types
enum	{ EditUndoId = STD_Application::UserID, EditRedoId, UserID }
enum	{   FileNewId, FileOpenId, FileLoadId, FileCloseId,   FileSaveId, FileSaveAsId, FileExitId, ViewStatusBarId,   ViewWindowsId, NewWindowId, EditCutId, EditCopyId,   EditPasteId, HelpAboutId, UserID }
Protected Slots
virtual bool	onUndo (int)
virtual bool	onRedo (int)
virtual void	onDesktopActivated ()
Protected Member Functions
virtual void	createActions ()
virtual void	updateCommandsStatus ()
virtual SUIT_Study *	createNewStudy ()
bool	undo (CAF_Study *doc)
bool	redo (CAF_Study *doc)
virtual void	setStdApp (const Handle(TDocStd_Application)&)
virtual void	updateDesktopTitle ()
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 *)
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
int	registerAction (const int, QAction *)
QAction *	createAction (const int, const QString &, const QIconSet &, const QString &, const QString &, const int, QObject *=0, const bool=false, QObject *=0, const char *=0)
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 with link to standard OCC OCAF data model. Allows to use OCC OCAF serives (for example, undo/redo)

---

Member Enumeration Documentation

anonymous enum [protected]

Enumerator: EditUndoId  EditRedoId  UserID  Reimplemented from STD_Application.

anonymous enum [protected, inherited]

Enumerator: FileNewId  FileOpenId  FileLoadId  FileCloseId  FileSaveId  FileSaveAsId  FileExitId  ViewStatusBarId  ViewWindowsId  NewWindowId  EditCutId  EditCopyId  EditPasteId  HelpAboutId  UserID

---

Constructor & Destructor Documentation

CAF_Application::CAF_Application (   )

Default constructor

CAF_Application::CAF_Application (  const Handle(TDocStd_Application)&  app  )

Constructor with OCAF application Parameters: app  - OCAF application

CAF_Application::~CAF_Application (   )  [virtual]

Destructor

---

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]

Returns: file filters for open/save document Reimplemented from STD_Application.

void CAF_Application::onHelpAbout (   )  [virtual, slot]

SLOT: called by clicking on Help->About in main menu Reimplemented from STD_Application.

bool CAF_Application::onUndo (  int  numActions  )  [protected, virtual, slot]

Undo operation on the active document. [ virtual protected slot ]

bool CAF_Application::onRedo (  int  numActions  )  [protected, virtual, slot]

Redo operation on the active document. [ virtual protected slot ]

void CAF_Application::createActions (   )  [protected, virtual]

Creates actions of application Reimplemented from STD_Application.

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

Enables / disables the actions according to the application state. [ virtual protected ] Reimplemented from STD_Application.

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

Creates new study Reimplemented from SUIT_Application.

bool CAF_Application::undo (  CAF_Study *  doc  )  [protected]

Undo operation on the given document. [ virtual protected ]

bool CAF_Application::redo (  CAF_Study *  doc  )  [protected]

Redo operation on the given document. [ virtual protected ]

void CAF_Application::setStdApp (  const Handle(TDocStd_Application)&  app  )  [protected, virtual]

Sets OCAF application

CAF_Application.Handle (  TDocStd_Application   )  [private]

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

Check the application on closing. Return values: true  if possible, else false Reimplemented from SUIT_Application.

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

Return values: true,if  document opened successful, else false. Reimplemented from SUIT_Application.

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  )  [inherited]

Sets theEnable for menu manager and for tool manager.

bool STD_Application.isEditEnabled (   )  const [inherited]

void STD_Application::clearViewManagers (   )  [inherited]

Remove all view managers from view managers list.

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.

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

Remove view manager from view managers list. Reimplemented in LightApp_Application.

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

Return values: SUIT_ViewManager  - return pointer to active view manager.

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

Return values: SUIT_ViewManager  by viewer manager type name.

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

Return values: TRUE,if  view manager vm, already in view manager list (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.

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.

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.

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.

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

Start STD_Application Reimplemented from SUIT_Application. Reimplemented in CAM_Application, LightApp_Application, and SalomeApp_Application.

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

Close the Application Reimplemented from SUIT_Application.

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

Reimplemented in CAM_Application, LightApp_Application, and SalomeApp_Application.

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.

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

Close document, if it's possible.

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

Save document if all ok, else error message.

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

Return values: TRUE,if  doument saved successful, else FALSE.

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

Put file name from file dialog to onOpenDoc(const QString&) function Reimplemented in LightApp_Application.

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

Return values: true,if  document was opened successful, else false. Reimplemented in LightApp_Application, and SalomeApp_Application.

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

called on loading the existent study Reimplemented in SalomeApp_Application.

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

Return values: true,if  document was loaded successful, else false. Reimplemented in LightApp_Application, and SalomeApp_Application.

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

Closing session.

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

Virtual slot. Not implemented here. Reimplemented in SalomeApp_Application.

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

Virtual slot. Not implemented here. Reimplemented in SalomeApp_Application.

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

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

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

Event on closing desktop

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

Public slot.

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

Update desktop title. Reimplemented in LightApp_Application, and SalomeApp_Application.

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

Changes desktop Parameters: desk  - new desktop Reimplemented from SUIT_Application.

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

Allow to load preferences before the desktop will be shown.

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

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

Custom activity after study is opened Updates desktop and actions

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

Custom activity after study is created Updates desktop and actions

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 LightApp_Application.

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

Sets active manager to , if in view managers list.

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

Returns: main window of application (desktop)

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

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

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

Returns: version of application Reimplemented in LightApp_Application.

bool SUIT_Application::useStudy (  const QString &  theName  )  [virtual, inherited]

Opens other study into active Study. If Study is empty - creates it. Parameters: theName  - name of study 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.

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

Returns: global resource manager

virtual SUIT_Convertor* SUIT_Application.getConvertor (  const SUIT_ViewModel *  theViewer  )  [virtual, inherited]

Returns instance of data object Convertor class according to given Viewer. If convertation is not supported returns 0.

void SUIT_Application::putInfo (  const QString &  msg, const   int = 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

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

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

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

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.

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

Creates new toolbar Returns: identificator of new toolbar in tool manager Parameters: