CAM_Module Class Reference

#include <CAM_Module.h>

Inheritance diagram for CAM_Module:


Public Slots
virtual bool	activateModule (SUIT_Study *)
virtual bool	deactivateModule (SUIT_Study *)
virtual void	connectToStudy (CAM_Study *)
virtual void	studyClosed (SUIT_Study *)
virtual void	studyChanged (SUIT_Study , SUIT_Study )
virtual void	onApplicationClosed (SUIT_Application *)
Public Member Functions
	CAM_Module ()
	CAM_Module (const QString &)
virtual	~CAM_Module ()
virtual void	initialize (CAM_Application *)
QString	moduleName () const
QPixmap	moduleIcon () const
CAM_DataModel *	dataModel () const
	Return data model. Create data model, if it was't created before.
CAM_Application *	application () const
virtual QString	iconName () const
virtual void	contextMenuPopup (const QString &, QPopupMenu *, QString &title)
virtual void	updateCommandsStatus ()
Set Menu Shown
virtual void	setMenuShown (const bool)
void	setMenuShown (QAction *, const bool)
void	setMenuShown (const int, const bool)
Set Tool Shown
virtual void	setToolShown (const bool)
void	setToolShown (QAction *, const bool)
void	setToolShown (const int, const bool)
Protected Member Functions
virtual CAM_DataModel *	createDataModel ()
virtual void	setModuleName (const QString &)
virtual void	setModuleIcon (const QPixmap &)
QtxActionMenuMgr *	menuMgr () const
QtxActionToolMgr *	toolMgr () const
int	registerAction (const int, QAction *)
bool	unregisterAction (const int)
bool	unregisterAction (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 methods.
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 methods.
int	createMenu (const QString &, const int, const int=-1, const int=-1, const int=-1, const bool=false)
int	createMenu (const QString &, const QString &, const int=-1, const int=-1, const int=-1, const bool=false)
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)

QAction *	action (const int) const
	Action ids methods.
int	actionId (const QAction *) const
Static Protected Member Functions
static QAction *	separator ()
Private Attributes
CAM_Application *	myApp
QString	myName
QPixmap	myIcon
CAM_DataModel *	myDataModel
QMap< int, QAction * >	myActionMap
Friends
class	CAM_Application

Detailed Description

Class provide support of tool and menu managers.

Constructor & Destructor Documentation

CAM_Module::CAM_Module ( )

Constructor.

CAM_Module::CAM_Module ( const QString & name )

Constructor. initialize name.

CAM_Module::~CAM_Module ( ) [virtual]

Destructor. Remove data model.

Member Function Documentation

void CAM_Module::initialize ( CAM_Application * app ) [virtual]

Initialize application.
Reimplemented in LightApp_Module, and SALOME_PYQT_Module.

QString CAM_Module::moduleName ( ) const

Return values:

Module name.

QPixmap CAM_Module::moduleIcon ( ) const

Return values:

Module icon.

CAM_DataModel * CAM_Module::dataModel ( ) const

CAM_Application * CAM_Module::application ( ) const

Return values:

CAM_Application pointer - application.

QString CAM_Module::iconName ( ) const [virtual]

Return values:

Module icon name.

virtual void CAM_Module.contextMenuPopup ( const QString & ,

QPopupMenu * ,

QString & title

) [virtual]

Reimplemented in LightApp_Module, and SALOME_PYQT_Module.

virtual void CAM_Module.updateCommandsStatus ( ) [virtual]

void CAM_Module::setMenuShown ( const bool ) [virtual]

Sets menus shown to on floag.
Parameters:

on - flag.

Reimplemented in SALOME_PYQT_Module.

void CAM_Module::setMenuShown ( QAction * a,

const bool

)

Sets menu shown for QAction a to on flag.
Parameters:

a - QAction

on - flag

void CAM_Module::setMenuShown ( const int,

const bool

)

Sets menu shown for action with id=id to on flag.
Parameters:

id - id of action

on - flag

void CAM_Module::setToolShown ( const bool ) [virtual]

Set tools shown to on flag.
Parameters:

on - boolean flag.

Reimplemented in SALOME_PYQT_Module.

void CAM_Module::setToolShown ( QAction * a,

const bool

)

Set tools shown for QAction a to on flag.
Parameters:

a - QAction

on - boolean flag

void CAM_Module::setToolShown ( const int,

const bool

)

Set tools shown for action with id=id to on flag.
Parameters:

id - integer action id

on - boolean flag

bool CAM_Module::activateModule ( SUIT_Study * study ) [virtual, slot]

Public slot
Return values:

true.

Reimplemented in LightApp_Module, and SALOME_PYQT_Module.

bool CAM_Module::deactivateModule ( SUIT_Study * ) [virtual, slot]

Public slot
Return values:

true.

Reimplemented in LightApp_Module, and SALOME_PYQT_Module.

void CAM_Module::connectToStudy ( CAM_Study * camStudy ) [virtual, slot]

Connect data model of module with active study

void CAM_Module::studyClosed ( SUIT_Study * study ) [virtual, slot]

Public slot, remove data model from study.

void CAM_Module::studyChanged ( SUIT_Study * ,

SUIT_Study *

) [virtual, slot]

Public slot, do nothing.

void CAM_Module::onApplicationClosed ( SUIT_Application * theApp ) [virtual, slot]

Public slot, nullify application pointer if the application was closed.

CAM_DataModel * CAM_Module::createDataModel ( ) [protected, virtual]

Create and return new instance of CAM_DataModel.
Reimplemented in LightApp_Module, and SalomeApp_Module.

void CAM_Module::setModuleName ( const QString & name ) [protected, virtual]

Sets module name to name.
Parameters:

name - new name for module.

void CAM_Module::setModuleIcon ( const QPixmap & icon ) [protected, virtual]

Sets module icon to icon.
Parameters:

icon - new icon for module.

QtxActionMenuMgr * CAM_Module::menuMgr ( ) const [protected]

Return menu manager pointer.
Return values:

QtxActionMenuMgr pointer - menu manager.

QtxActionToolMgr * CAM_Module::toolMgr ( ) const [protected]

Return tool manager pointer.
Return values:

QtxActionToolMgr pointer - tool manager.

int CAM_Module::createTool ( const QString & name ) [protected]

Create tool bar with name name, if it was't created before.
Return values:

-1 - if tool manager was't be created.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createTool ( const int,

const int,

const int = -1

) [protected]

Create tool. Insert QAction with id id from action map(myActionMap) to tool manager.
Parameters:

id - integer

tBar - integer

idx - integer

Return values:

integer id of new action in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createTool ( const int,

const QString & tBar,

const int = -1

) [protected]

Create tool. Insert QAction with id id from action map(myActionMap) to tool manager.
Parameters:

id - integer

tBar - QString&

idx - integer

Return values:

integer id of new action in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createTool ( QAction * a,

const int,

const int = -1,

const int = -1

) [protected]

Create tool. Register action a with id id. Insert QAction to tool manager.
Parameters:

a - QAction

tBar - integer

id - integer

idx - integer

Return values:

integer id of new action in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createTool ( QAction * a,

const QString & tBar,

const int = -1,

const int = -1

) [protected]

Create tool. Register action a with id id. Insert QAction to tool manager.
Parameters:

a - QAction

tBar - QString&

id - integer

idx - integer

Return values:

integer id of new action in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createMenu ( const QString & subMenu,

const int,

const int = -1,

const int = -1,

const int = -1,

const bool = false

) [protected]

Create menu. Insert submenu subMenu to menu manager.
Parameters:

subMenu - QString&

menu - integer

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createMenu ( const QString & subMenu,

const QString & menu,

const int = -1,

const int = -1,

const int = -1,

const bool = false

) [protected]

Create menu. Insert submenu subMenu to menu manager.
Parameters:

subMenu - QString&

menu - QString&

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::createMenu ( const int,

const int,

const int = -1,

const int = -1

) [protected]

Create menu. Insert QAction with id id from action map(myActionMap) to menu manager.
Parameters:

menu - integer

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

int CAM_Module::createMenu ( const int,

const QString & menu,

const int = -1,

const int = -1

) [protected]

Create menu. Insert QAction with id id from action map(myActionMap) to menu manager.
Parameters:

menu - QString&

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

int CAM_Module::createMenu ( QAction * a,

const int,

const int = -1,

const int = -1,

const int = -1

) [protected]

Create menu. Register action a with id id. Insert QAction to menu manager.
Parameters:

a - Qaction

menu - integer

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

int CAM_Module::createMenu ( QAction * a,

const QString & menu,

const int = -1,

const int = -1,

const int = -1

) [protected]

Create menu. Register action a with id id. Insert QAction to menu manager.
Parameters:

a - Qaction

menu - QString&

id - integer

group - integer

index - integer

Return values:

integer id of new menu in tool manager.

Return -1 if something wrong.

QAction * CAM_Module::separator ( ) [static, protected]

Return qt action manager separator.

QAction * CAM_Module::action ( const int ) const [protected]

Return action by id.
Parameters:

id - id of action.

Return values:

QAction.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::actionId ( const QAction * a ) const [protected]

Return id by action.
Parameters:

a - QAction.

Return values:

id of action.

Reimplemented in SALOME_PYQT_Module.

int CAM_Module::registerAction ( const int,

QAction * a

) [protected]

Register action in action map.
Parameters:

id - id for action.

a - action

Return values:

new id for action.

bool CAM_Module::unregisterAction ( const int ) [protected]

Unregister an action.
Parameters:

id - id for action.

Return values:

true if succeded, false if action is used

bool CAM_Module::unregisterAction ( QAction * a ) [protected]

Unregister an action.
Parameters:

a - action

Return values:

true if succeded, false if action is used

QAction * CAM_Module::createAction ( const int,

const QString & text,

const QIconSet & icon,

const QString & menu,

const QString & tip,

const int,

QObject * parent = 0,

const bool = false,

QObject * reciever = 0,

const char * member = 0

) [protected]

Create new instance of QtxAction and register action with id.
Parameters:

id - id for new action.

text - parameter for creation QtxAction

icon - parameter for creation QtxAction

menu - parameter for creation QtxAction

tip - tip status for QtxAction action.

key - parameter for creation QtxAction

parent - parent for action

toggle - parameter for creation QtxAction

reciever -

member -