Back to index

salome-gui  6.5.0
Classes | Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Static Protected Member Functions | Private Types | Private Slots | Private Member Functions | Private Attributes | Friends
CAM_EXPORT Protocol Reference

#include <CAM_Application.h>

Inheritance diagram for CAM_EXPORT:
Inheritance graph
[legend]
Collaboration diagram for CAM_EXPORT:
Collaboration graph
[legend]

List of all members.

Classes

struct  ModuleInfo
struct  ModuleShortInfo

Public Types

typedef QList< CAM_Module * > ModuleList
typedef QList< ModuleShortInfoModuleShortInfoList
typedef QList< CAM_DataModel * > ModelList

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

Signals

void rootChanged (const CAM_DataModel *)

Public Member Functions

 CAM_Application (const bool=true)
virtual ~CAM_Application ()
virtual void start ()
CAM_ModuleactiveModule () const
CAM_Modulemodule (const QString &) const
ModuleList modules () const
void modules (ModuleList &) const
void modules (QStringList &, const bool loaded=true) const
virtual void addModule (CAM_Module *)
virtual void loadModules ()
virtual CAM_ModuleloadModule (const QString &, const bool=true)
virtual bool activateModule (const QString &)
virtual void contextMenuPopup (const QString &, QMenu *, QString &)
QString moduleName (const QString &) const
QString moduleTitle (const QString &) const
QString moduleIcon (const QString &) const
bool isModuleAccessible (const QString &) const
virtual void createEmptyStudy ()
ModuleShortInfoList getVersionInfo () const
 CAM_DataModel (CAM_Module *)
virtual ~CAM_DataModel ()
virtual void initialize ()
CAM_DataObjectroot () const
CAM_Modulemodule () const
virtual bool open (const QString &, CAM_Study *, QStringList)
virtual bool save (QStringList &)
virtual bool saveAs (const QString &, CAM_Study *, QStringList &)
virtual bool close ()
virtual bool create (CAM_Study *)
 CAM_DataObject (SUIT_DataObject *=0)
virtual ~CAM_DataObject ()
CAM_Modulemodule () const
virtual CAM_DataModeldataModel () const
 CAM_ModuleObject (SUIT_DataObject *=0)
 CAM_ModuleObject (CAM_DataModel *, SUIT_DataObject *=0)
virtual ~CAM_ModuleObject ()
virtual QString name () const
QPixmap icon (const int=NameId) const
QString toolTip (const int=NameId) const
virtual CAM_DataModeldataModel () const
virtual void setDataModel (CAM_DataModel *)
 CAM_Module ()
 CAM_Module (const QString &)
virtual ~CAM_Module ()
virtual void initialize (CAM_Application *)
QString name () const
QString moduleName () const
virtual QPixmap moduleIcon () const
virtual QString iconName () const
CAM_DataModeldataModel () const
CAM_Applicationapplication () const
virtual void contextMenuPopup (const QString &, QMenu *, QString &)
virtual void updateCommandsStatus ()
virtual void putInfo (const QString &, const int=-1)
bool isActiveModule () const
virtual void setMenuShown (const bool)
void setMenuShown (QAction *, const bool)
void setMenuShown (const int, const bool)
virtual void setToolShown (const bool)
void setToolShown (QAction *, const bool)
void setToolShown (const int, const bool)
virtual void updateModuleVisibilityState ()
 CAM_Study (SUIT_Application *)
virtual ~CAM_Study ()
virtual void closeDocument (bool permanently=true)
bool appendDataModel (const CAM_DataModel *)
virtual bool insertDataModel (const CAM_DataModel *, const int=-1)
bool insertDataModel (const CAM_DataModel *, const CAM_DataModel *)
virtual bool removeDataModel (const CAM_DataModel *)
bool containsDataModel (const CAM_DataModel *) const
void dataModels (ModelList &) const

Protected Slots

virtual void updateModelRoot (const CAM_DataModel *)

Protected Member Functions

virtual SUIT_StudycreateNewStudy ()
virtual void updateCommandsStatus ()
virtual void moduleAdded (CAM_Module *)
virtual void beforeCloseDoc (SUIT_Study *)
virtual void afterCloseDoc ()
virtual bool activateModule (CAM_Module *=0)
virtual void setActiveStudy (SUIT_Study *)
QString moduleLibrary (const QString &, const bool=true) const
virtual void setRoot (const CAM_DataObject *)
virtual bool isSelectionCompatible ()
virtual CAM_DataModelcreateDataModel ()
void setName (const QString &)
virtual void setModuleName (const QString &)
QtxActionMenuMgrmenuMgr () const
QtxActionToolMgrtoolMgr () const
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)
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)
QAction * action (const int) const
int actionId (const QAction *) const
int registerAction (const int, QAction *)
bool unregisterAction (const int)
bool unregisterAction (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())
virtual void dataModelInserted (const CAM_DataModel *)
virtual bool openDataModel (const QString &, CAM_DataModel *)
virtual bool saveDataModel (const QString &, CAM_DataModel *)

Static Protected Member Functions

static QAction * separator ()

Private Types

typedef QList< ModuleInfoModuleInfoList

Private Slots

void onDestroyed (SUIT_DataObject *)
void onInfoChanged (QString)

Private Member Functions

void readModuleList ()

Private Attributes

CAM_ModulemyModule
 active module
ModuleList myModules
 loaded modules list
ModuleInfoList myInfoList
 modules info list
bool myAutoLoad
 auto loading flag
bool myBlocked
 "blocked" flag, internal usage
CAM_DataObjectmyRoot
 root data object
CAM_DataModelmyDataModel
 data model
CAM_ApplicationmyApp
 parent application object
QString myName
 module title (user name)
QPixmap myIcon
 module icon
QString myInfo
 latest info message
QMap< int, QAction * > myActionMap
 menu actions
bool myMenuShown
 menu shown flag
bool myToolShown
 tool shown flag
ModelList myDataModels
 data models list

Friends

class CAM_Application

Detailed Description

Definition at line 38 of file CAM_Application.h.


Class Documentation

struct CAM_EXPORT::ModuleInfo

Definition at line 95 of file CAM_Application.h.

Class Members
QString icon
QString internal
bool isSingleton
QString name
QString title
QString version
struct CAM_EXPORT::ModuleShortInfo

Definition at line 44 of file CAM_Application.h.

Class Members
QString name
QString version

Member Typedef Documentation

Definition at line 42 of file CAM_Study.h.

typedef QList<ModuleInfo> CAM_EXPORT::ModuleInfoList [private]

Definition at line 96 of file CAM_Application.h.

Definition at line 43 of file CAM_Application.h.

Definition at line 45 of file CAM_Application.h.


Constructor & Destructor Documentation

virtual CAM_EXPORT::~CAM_Application ( ) [virtual]
virtual CAM_EXPORT::~CAM_DataModel ( ) [virtual]
virtual CAM_EXPORT::~CAM_DataObject ( ) [virtual]
virtual CAM_EXPORT::~CAM_ModuleObject ( ) [virtual]
virtual CAM_EXPORT::~CAM_Module ( ) [virtual]
virtual CAM_EXPORT::~CAM_Study ( ) [virtual]

Member Function Documentation

QAction* CAM_EXPORT::action ( const int  ) const [protected]
int CAM_EXPORT::actionId ( const QAction *  ) const [protected]
virtual bool CAM_EXPORT::activateModule ( const QString &  ) [virtual]
virtual bool CAM_EXPORT::activateModule ( CAM_Module = 0) [protected, virtual]
virtual bool CAM_EXPORT::activateModule ( SUIT_Study ) [virtual, slot]
virtual void CAM_EXPORT::addModule ( CAM_Module ) [virtual]
virtual void CAM_EXPORT::afterCloseDoc ( ) [protected, virtual]
virtual void CAM_EXPORT::beforeCloseDoc ( SUIT_Study ) [protected, virtual]
CAM_EXPORT::CAM_Application ( const bool  = true)
CAM_EXPORT::CAM_Module ( const QString &  )
CAM_EXPORT::CAM_Study ( SUIT_Application *  )
virtual bool CAM_EXPORT::close ( ) [virtual]

Here is the caller graph for this function:

virtual void CAM_EXPORT::closeDocument ( bool  permanently = true) [virtual]
virtual void CAM_EXPORT::connectToStudy ( CAM_Study ) [virtual, slot]
bool CAM_EXPORT::containsDataModel ( const CAM_DataModel ) const
virtual void CAM_EXPORT::contextMenuPopup ( const QString &  ,
QMenu *  ,
QString &   
) [virtual]
virtual void CAM_EXPORT::contextMenuPopup ( const QString &  ,
QMenu *  ,
QString &   
) [inline, virtual]

Definition at line 68 of file CAM_Module.h.

{};
virtual bool CAM_EXPORT::create ( CAM_Study ) [virtual]
QAction* CAM_EXPORT::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() 
) [protected]
virtual CAM_DataModel* CAM_EXPORT::createDataModel ( ) [protected, virtual]
virtual void CAM_EXPORT::createEmptyStudy ( ) [virtual]
int CAM_EXPORT::createMenu ( const QString &  ,
const int  ,
const int  = -1,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createMenu ( const QString &  ,
const QString &  ,
const int  = -1,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createMenu ( const int  ,
const int  ,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createMenu ( const int  ,
const QString &  ,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createMenu ( QAction *  ,
const int  ,
const int  = -1,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createMenu ( QAction *  ,
const QString &  ,
const int  = -1,
const int  = -1,
const int  = -1 
) [protected]
virtual SUIT_Study* CAM_EXPORT::createNewStudy ( ) [protected, virtual]
int CAM_EXPORT::createTool ( const QString &  ) [protected]
int CAM_EXPORT::createTool ( const int  ,
const int  ,
const int  = -1 
) [protected]
int CAM_EXPORT::createTool ( const int  ,
const QString &  ,
const int  = -1 
) [protected]
int CAM_EXPORT::createTool ( QAction *  ,
const int  ,
const int  = -1,
const int  = -1 
) [protected]
int CAM_EXPORT::createTool ( QAction *  ,
const QString &  ,
const int  = -1,
const int  = -1 
) [protected]
virtual CAM_DataModel* CAM_EXPORT::dataModel ( ) const [virtual]
virtual CAM_DataModel* CAM_EXPORT::dataModel ( ) const [virtual]
virtual void CAM_EXPORT::dataModelInserted ( const CAM_DataModel ) [protected, virtual]
virtual bool CAM_EXPORT::deactivateModule ( SUIT_Study ) [virtual, slot]
QPixmap CAM_EXPORT::icon ( const int  = NameId) const
virtual QString CAM_EXPORT::iconName ( ) const [virtual]
virtual void CAM_EXPORT::initialize ( ) [virtual]
virtual void CAM_EXPORT::initialize ( CAM_Application ) [virtual]
virtual bool CAM_EXPORT::insertDataModel ( const CAM_DataModel ,
const int  = -1 
) [virtual]
bool CAM_EXPORT::insertDataModel ( const CAM_DataModel ,
const CAM_DataModel  
)
bool CAM_EXPORT::isModuleAccessible ( const QString &  ) const
virtual bool CAM_EXPORT::isSelectionCompatible ( ) [protected, virtual]
virtual CAM_Module* CAM_EXPORT::loadModule ( const QString &  ,
const bool  = true 
) [virtual]
virtual void CAM_EXPORT::loadModules ( ) [virtual]
QtxActionMenuMgr* CAM_EXPORT::menuMgr ( ) const [protected]
CAM_Module* CAM_EXPORT::module ( const QString &  ) const
virtual void CAM_EXPORT::moduleAdded ( CAM_Module ) [protected, virtual]
virtual QPixmap CAM_EXPORT::moduleIcon ( ) const [virtual]
QString CAM_EXPORT::moduleIcon ( const QString &  ) const
QString CAM_EXPORT::moduleLibrary ( const QString &  ,
const bool  = true 
) const [protected]
QString CAM_EXPORT::moduleName ( ) const
QString CAM_EXPORT::moduleName ( const QString &  ) const
void CAM_EXPORT::modules ( QStringList &  ,
const bool  loaded = true 
) const
QString CAM_EXPORT::moduleTitle ( const QString &  ) const
virtual QString CAM_EXPORT::name ( ) const [virtual]
QString CAM_EXPORT::name ( ) const
virtual void CAM_EXPORT::onApplicationClosed ( SUIT_Application *  ) [virtual, slot]
void CAM_EXPORT::onDestroyed ( SUIT_DataObject ) [private, slot]
void CAM_EXPORT::onInfoChanged ( QString  ) [private, slot]
virtual bool CAM_EXPORT::open ( const QString &  ,
CAM_Study ,
QStringList   
) [virtual]
virtual bool CAM_EXPORT::openDataModel ( const QString &  ,
CAM_DataModel  
) [protected, virtual]
virtual void CAM_EXPORT::putInfo ( const QString &  ,
const int  = -1 
) [virtual]
int CAM_EXPORT::registerAction ( const int  ,
QAction *   
) [protected]
virtual bool CAM_EXPORT::removeDataModel ( const CAM_DataModel ) [virtual]
void CAM_EXPORT::rootChanged ( const CAM_DataModel ) [signal]
virtual bool CAM_EXPORT::save ( QStringList &  ) [virtual]
virtual bool CAM_EXPORT::saveAs ( const QString &  ,
CAM_Study ,
QStringList &   
) [virtual]
virtual bool CAM_EXPORT::saveDataModel ( const QString &  ,
CAM_DataModel  
) [protected, virtual]
static QAction* CAM_EXPORT::separator ( ) [static, protected]
virtual void CAM_EXPORT::setActiveStudy ( SUIT_Study ) [protected, virtual]
virtual void CAM_EXPORT::setDataModel ( CAM_DataModel ) [virtual]
virtual void CAM_EXPORT::setMenuShown ( const bool  ) [virtual]
void CAM_EXPORT::setMenuShown ( QAction *  ,
const bool   
)
void CAM_EXPORT::setMenuShown ( const int  ,
const bool   
)
virtual void CAM_EXPORT::setModuleName ( const QString &  ) [protected, virtual]
void CAM_EXPORT::setName ( const QString &  ) [protected]
virtual void CAM_EXPORT::setRoot ( const CAM_DataObject ) [protected, virtual]
virtual void CAM_EXPORT::setToolShown ( const bool  ) [virtual]
void CAM_EXPORT::setToolShown ( QAction *  ,
const bool   
)
void CAM_EXPORT::setToolShown ( const int  ,
const bool   
)
virtual void CAM_EXPORT::start ( ) [virtual]
virtual void CAM_EXPORT::studyChanged ( SUIT_Study ,
SUIT_Study  
) [virtual, slot]
virtual void CAM_EXPORT::studyClosed ( SUIT_Study ) [virtual, slot]
QtxActionToolMgr* CAM_EXPORT::toolMgr ( ) const [protected]
QString CAM_EXPORT::toolTip ( const int  = NameId) const
bool CAM_EXPORT::unregisterAction ( const int  ) [protected]
bool CAM_EXPORT::unregisterAction ( QAction *  ) [protected]
virtual void CAM_EXPORT::updateCommandsStatus ( ) [inline, virtual]

Definition at line 69 of file CAM_Module.h.

{};
virtual void CAM_EXPORT::updateCommandsStatus ( ) [protected, virtual]
virtual void CAM_EXPORT::updateModelRoot ( const CAM_DataModel ) [protected, virtual, slot]

Friends And Related Function Documentation

friend class CAM_Application [friend]

Definition at line 145 of file CAM_Module.h.


Member Data Documentation

QMap<int, QAction*> CAM_EXPORT::myActionMap [private]

menu actions

Definition at line 141 of file CAM_Module.h.

parent application object

Definition at line 136 of file CAM_Module.h.

bool CAM_EXPORT::myAutoLoad [private]

auto loading flag

Definition at line 102 of file CAM_Application.h.

bool CAM_EXPORT::myBlocked [private]

"blocked" flag, internal usage

Definition at line 103 of file CAM_Application.h.

data model

Definition at line 58 of file CAM_DataObject.h.

data models list

Definition at line 69 of file CAM_Study.h.

QPixmap CAM_EXPORT::myIcon [private]

module icon

Definition at line 138 of file CAM_Module.h.

QString CAM_EXPORT::myInfo [private]

latest info message

Definition at line 139 of file CAM_Module.h.

modules info list

Definition at line 101 of file CAM_Application.h.

bool CAM_EXPORT::myMenuShown [private]

menu shown flag

Definition at line 142 of file CAM_Module.h.

active module

module

Definition at line 99 of file CAM_Application.h.

loaded modules list

Definition at line 100 of file CAM_Application.h.

QString CAM_EXPORT::myName [private]

module title (user name)

Definition at line 137 of file CAM_Module.h.

root data object

Definition at line 65 of file CAM_DataModel.h.

bool CAM_EXPORT::myToolShown [private]

tool shown flag

Definition at line 143 of file CAM_Module.h.


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