OCC OCAF-based application. More...

#include <CAF_Application.h>

Inheritance diagram for CAF_Application:

Public Slots
virtual void	onHelpAbout ()
	Called when user activatees Help->About main menu command. More...

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

Public Member Functions
	CAF_Application ()
	Default constructor. More...

	CAF_Application (const Handle(TDocStd_Application)&)
	Constructor. More...

virtual	~CAF_Application ()
	Destructor. More...

virtual QString	applicationName () const
	Get application name. More...

	Handle (TDocStd_Application) stdApp() const

virtual QString	getFileFilter (bool) const

Public Member Functions inherited from STD_Application
	STD_Application ()

virtual	~STD_Application ()

virtual QString	applicationName () const

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	getFileFilter (bool open) 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 ()

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_Desktop *	desktop ()
	Returns main widget (Desktop) of the application (if it exists) More...

virtual bool	isPossibleToClose (bool &)

virtual void	closeApplication ()

virtual SUIT_Study *	activeStudy () const
	Returns active Study. If Application supports wirking with several studies this method should be redefined. More...

virtual QString	applicationName () const =0
	Returns Name of application. Using is not defined. More...

virtual QString	applicationVersion () const

virtual void	start ()
	Shows the application's main widget. For non GUI application must be redefined. More...

virtual bool	useFile (const QString &theFileName)
	Opens document <theFileName> into active Study. If Study is empty - creates it. More...

virtual void	createEmptyStudy ()
	Creates new empty Study if active Study = 0. 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...

virtual QString	getFileName (bool open, const QString &initial, const QString &filters, const QString &caption, QWidget *parent)=0
	Invokes application-specific "Open/Save File" dialog and returns the selected file name. More...

virtual QString	getDirectory (const QString &initial, const QString &caption, QWidget *parent)=0
	Invokes application-specific "Select Directory" dialog and returns the selected directory name. More...

virtual int	viewManagerId (const SUIT_ViewManager *) const =0

virtual void	viewManagers (const QString &, QList< SUIT_ViewManager * > &) const =0

QAction *	action (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)

Protected Types
enum	{ EditUndoId = STD_Application::UserID , EditRedoId , UserID }

Protected Types inherited from STD_Application
enum	{ OpenCancel , OpenNew , OpenExist }

enum	{ CloseCancel , CloseSave , CloseDiscard }

Protected Slots
virtual bool	onUndo (int)
	Called when user activates "Undo" menu action. More...

virtual bool	onRedo (int)
	Called when user activates "Redo" menu action. More...

Protected Slots inherited from SUIT_Application
virtual void	onDesktopActivated ()

Protected Member Functions
virtual void	createActions ()

virtual void	updateCommandsStatus ()
	Update actions state (Undo/Redo). More...

virtual SUIT_Study *	createNewStudy ()
	Create new empty study. More...

bool	undo (CAF_Study *doc)
	Undo latest command operation for specified document. More...

bool	redo (CAF_Study *doc)
	Redo latest command operation undo for specified document. More...

virtual void	setStdApp (const Handle(TDocStd_Application)&)
	Set OCAF application. More...

Protected Member Functions inherited from STD_Application
virtual void	createActions ()

virtual void	customize ()

virtual void	updateCommandsStatus ()

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 &)

virtual bool	closeDoc (bool ask=true)

virtual bool	closeActiveDoc (bool permanently=true)

virtual bool	abortAllOperations ()
	Abort active operations if there are any. More...

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 *)

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

QAction *	createAction (const int, QObject , const bool, const QString &, const QString &, const QString &, const QString &, const QIcon &=QIcon(), QObject =nullptr, const char *=nullptr)

SUIT_Application *	startApplication (int, char **) const

SUIT_Application *	startApplication (const QString &, int, char **) const

virtual void	setActiveStudy (SUIT_Study *)

Private Member Functions
	Handle (TDocStd_Application) myStdApp

Additional Inherited Members
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 }

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)

Static Protected Member Functions inherited from SUIT_Application
static QAction *	separator ()

Detailed Description

OCC OCAF-based application.

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

anonymous enum

protected

Enumerator
EditUndoId
EditRedoId
UserID

Constructor & Destructor Documentation

◆ CAF_Application() [1/2]

CAF_Application::CAF_Application ( )

Default constructor.

◆ CAF_Application() [2/2]

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

Constructor.

Parameters

app	OCAF application

◆ ~CAF_Application()

CAF_Application::~CAF_Application ( )

virtual

Destructor.

Member Function Documentation

◆ applicationName()

QString CAF_Application::applicationName ( ) const

virtual

Get application name.

Returns: application name

Reimplemented from STD_Application.

◆ createActions()

virtual void CAF_Application::createActions ( )

protectedvirtual

Create actions, menus and tools

Reimplemented from STD_Application.

◆ createNewStudy()

SUIT_Study * CAF_Application::createNewStudy ( )

protectedvirtual

Create new empty study.

Returns: new study

Reimplemented from SUIT_Application.

◆ getFileFilter()

virtual QString CAF_Application::getFileFilter ( bool open ) const

virtual

Return values

QString - return file extension(s).

Reimplemented from STD_Application.

◆ Handle() [1/2]

CAF_Application::Handle ( TDocStd_Application )

private

◆ Handle() [2/2]

CAF_Application::Handle ( TDocStd_Application ) const

◆ onHelpAbout

void CAF_Application::onHelpAbout ( )

virtualslot

Called when user activatees Help->About main menu command.

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

◆ onRedo

bool CAF_Application::onRedo ( int numActions )

protectedvirtualslot

Called when user activates "Redo" menu action.

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

◆ onUndo

bool CAF_Application::onUndo ( int numActions )

protectedvirtualslot

Called when user activates "Undo" menu action.

Undo operation on the active document.

Parameters

numActions undo depth (number of commands)

Returns: true on success

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

◆ redo()

bool CAF_Application::redo ( CAF_Study * doc )

protected

Redo latest command operation undo for specified document.

Parameters

doc	OCAF document

Returns: true on success

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

◆ setStdApp()

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

protectedvirtual

Set OCAF application.

Parameters

app	new OCAF application

◆ undo()

bool CAF_Application::undo ( CAF_Study * doc )

protected

Undo latest command operation for specified document.

Parameters

doc	OCAF document

Returns: true on success

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

◆ updateCommandsStatus()

void CAF_Application::updateCommandsStatus ( )

protectedvirtual

Update actions state (Undo/Redo).

Reimplemented from STD_Application.

References SUIT_Application::action(), SUIT_Application::activeStudy(), CAF_Study::canRedo(), CAF_Study::canUndo(), EditRedoId, EditUndoId, redo(), CAF_Study::redoNames(), undo(), CAF_Study::undoNames(), and STD_Application::updateCommandsStatus().

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

src/CAF/CAF_Application.h
src/CAF/CAF_Application.cxx

Public Slots

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ CAF_Application() [1/2]

◆ CAF_Application() [2/2]

◆ ~CAF_Application()

Member Function Documentation

◆ applicationName()

◆ createActions()

◆ createNewStudy()

◆ getFileFilter()

◆ Handle() [1/2]

◆ Handle() [2/2]

◆ onHelpAbout

◆ onRedo

◆ onUndo

◆ redo()

◆ setStdApp()

◆ undo()

◆ updateCommandsStatus()