qSlicerModulesMenu Class Reference

#include <Base/QTGUI/qSlicerModulesMenu.h>

List of all members.

Public Types
typedef QMenu	Superclass
Properties
QString	currentModule
bool	duplicateActions
bool	showHiddenModules
Public Slots
void	addModule (const QString &moduleName)
void	removeModule (const QString &moduleName)
	Remove the module from the list of available module.
void	setCurrentModule (const QString &moduleName)
	Select a module by name. It looks for the module action and triggers it.
void	setCurrentModuleByTitle (const QString &title)
	Select a module by title. It looks for the module action and triggers it.
Signals
void	currentModuleChanged (const QString &name)
Public Member Functions
void	addModules (const QStringList &moduleNames)
	Add a list of module available for selection.
QString	currentModule () const
	Return the last selected module name.
bool	duplicateActions () const
QAction *	moduleAction (const QString &moduleName) const
qSlicerModuleManager *	moduleManager () const
	qSlicerModulesMenu (QWidget *parent=0)
	qSlicerModulesMenu (const QString &title, QWidget *parent=0)
void	removeModules (const QStringList &moduleNames)
	Add a list of module available for selection.
void	setDuplicateActions (bool duplicate)
void	setModuleManager (qSlicerModuleManager *moduleManager)
	Set the module manager to retrieve the modules from.
void	setShowHiddenModules (bool show)
bool	showHiddenModules () const
virtual	~qSlicerModulesMenu ()
Protected Slots
void	actionSelected (QAction *action)
void	onActionTriggered ()
Protected Member Functions
void	addModule (qSlicerAbstractCoreModule *)
void	removeModule (qSlicerAbstractCoreModule *)
Protected Attributes
QScopedPointer < qSlicerModulesMenuPrivate >	d_ptr

---

Detailed Description

qSlicerModulesMenu supports a tree hierarchy of modules (based on module->category() )

Definition at line 37 of file qSlicerModulesMenu.h.

---

Member Typedef Documentation

typedef QMenu qSlicerModulesMenu::Superclass

Definition at line 58 of file qSlicerModulesMenu.h.

---

Property Documentation

QString qSlicerModulesMenu::currentModule [read, write]

Definition at line 40 of file qSlicerModulesMenu.h.

bool qSlicerModulesMenu::duplicateActions [read, write]

By default (duplicateActions = false), multiple instances of qSlicerModulesMenu share the same QActions. When a module QAction is fired from a menu, all the qSlicerModulesMenu would make it the current module. When duplicateActions is true, the QActions populating the menu are duplicates from the original module QAction. That way the qSlicerModulesMenu behaves independently from the other qSlicerModulesMenus. Note: this property should be set before moduels are added (addModule()).

Definition at line 48 of file qSlicerModulesMenu.h.

bool qSlicerModulesMenu::showHiddenModules [read, write]

By default (showHiddenModules == false), modules with the hidden property set to true are not shown. If showHiddenModules is true, all the modules are visible. Note: this property should be set before modules are added (addModule), changing its value won't change the visibility of the current volumes but only the future added modules

Definition at line 56 of file qSlicerModulesMenu.h.

---

Constructor & Destructor Documentation

qSlicerModulesMenu::qSlicerModulesMenu	(	const QString &	title,
		QWidget *	parent = 0
	)

Constructor title is the name of the menu (can appear using right click on the toolbar area)

qSlicerModulesMenu::qSlicerModulesMenu

(

QWidget *

parent = 0

)

virtual qSlicerModulesMenu::~qSlicerModulesMenu

(

)

[virtual]

---

Member Function Documentation

void qSlicerModulesMenu::actionSelected

(

QAction *

action

)

[protected, slot]

void qSlicerModulesMenu::addModule

(

const QString &

moduleName

)

[slot]

Add a module by name into the menu. The category property of the module is used to assign a submenu to the module action. If a module is hidden and showHiddenModules is false (default), the module is ignored and not added into the list

See also:

qSlicerAbstractCoreModule::category()

qSlicerAbstractCoreModule::action()

qSlicerAbstractCoreModule::isHidden()

void qSlicerModulesMenu::addModule

(

qSlicerAbstractCoreModule *

)

[protected]

void qSlicerModulesMenu::addModules

(

const QStringList &

moduleNames

)

[inline]

Add a list of module available for selection.

Definition at line 131 of file qSlicerModulesMenu.h.

QString qSlicerModulesMenu::currentModule

(

)

const

Return the last selected module name.

void qSlicerModulesMenu::currentModuleChanged

(

const QString &

name

)

[signal]

The signal is fired every time a module is selected. The QAction of the module is triggered.

bool qSlicerModulesMenu::duplicateActions

(

)

const

QAction* qSlicerModulesMenu::moduleAction

(

const QString &

moduleName

)

const

qSlicerModuleManager* qSlicerModulesMenu::moduleManager

(

)

const

void qSlicerModulesMenu::onActionTriggered

(

)

[protected, slot]

void qSlicerModulesMenu::removeModule

(

qSlicerAbstractCoreModule *

)

[protected]

void qSlicerModulesMenu::removeModule

(

const QString &

moduleName

)

[slot]

Remove the module from the list of available module.

void qSlicerModulesMenu::removeModules

(

const QStringList &

moduleNames

)

[inline]

Add a list of module available for selection.

Definition at line 140 of file qSlicerModulesMenu.h.

void qSlicerModulesMenu::setCurrentModule

(

const QString &

moduleName

)

[slot]

Select a module by name. It looks for the module action and triggers it.

void qSlicerModulesMenu::setCurrentModuleByTitle

(

const QString &

title

)

[slot]

Select a module by title. It looks for the module action and triggers it.

void qSlicerModulesMenu::setDuplicateActions

(

bool

duplicate

)

void qSlicerModulesMenu::setModuleManager

(

qSlicerModuleManager *

moduleManager

)

Set the module manager to retrieve the modules from.

void qSlicerModulesMenu::setShowHiddenModules

(

bool

show

)

If true, modules with the hidden property set to true are still visible in the module.

bool qSlicerModulesMenu::showHiddenModules

(

)

const

---

Member Data Documentation

QScopedPointer<qSlicerModulesMenuPrivate> qSlicerModulesMenu::d_ptr [protected]

Definition at line 120 of file qSlicerModulesMenu.h.

---

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

• Base/QTGUI/qSlicerModulesMenu.h