qSlicerCLIModule Class Reference

#include <Base/QTCLI/qSlicerCLIModule.h>

Inheritance diagram for qSlicerCLIModule:

Collaboration diagram for qSlicerCLIModule:

List of all members.

Public Types
typedef qSlicerAbstractModule	Superclass
Public Member Functions
virtual QString	acknowledgementText () const
virtual QStringList	categories () const
	Extracted from the "category" field.
Q_INVOKABLE vtkSlicerCLIModuleLogic *	cliModuleLogic ()
virtual QStringList	contributors () const
	Extracted from the "contributor" field.
QString	entryPoint () const
virtual QString	helpText () const
virtual int	index () const
	Optionally set in the module XML description.
virtual QImage	logo () const
	The logo of the module, the credits given by the grants or instution.
QString	moduleType () const
	qSlicerCLIModule (QWidget *parent=0)
void	setEntryPoint (const QString &entryPoint)
void	setLogo (const ModuleLogo &logo)
void	setModuleType (const QString &type)
void	setTempDirectory (const QString &tempDirectory)
	Set temporary directory associated with the module.
void	setXmlModuleDescription (const QString &xmlModuleDescription)
QString	tempDirectory () const
virtual QString	title () const
virtual	~qSlicerCLIModule ()
Static Public Member Functions
static QImage	moduleLogoToImage (const ModuleLogo &logo)
Protected Member Functions
virtual vtkMRMLAbstractLogic *	createLogic ()
virtual qSlicerAbstractModuleRepresentation *	createWidgetRepresentation ()
virtual void	setup ()
	All initialization code should be done in the setup.
Protected Attributes
QScopedPointer < qSlicerCLIModulePrivate >	d_ptr

---

Detailed Description

Definition at line 37 of file qSlicerCLIModule.h.

---

Member Typedef Documentation

typedef qSlicerAbstractModule qSlicerCLIModule::Superclass

Reimplemented from qSlicerAbstractModule.

Definition at line 42 of file qSlicerCLIModule.h.

---

Constructor & Destructor Documentation

qSlicerCLIModule::qSlicerCLIModule

(

QWidget *

parent = 0

)

virtual qSlicerCLIModule::~qSlicerCLIModule

(

)

[virtual]

---

Member Function Documentation

virtual QString qSlicerCLIModule::acknowledgementText

(

)

const [virtual]

Return acknowledgement text for the module Must be reimplemented in the derived classes

Reimplemented from qSlicerAbstractCoreModule.

virtual QStringList qSlicerCLIModule::categories

(

)

const [virtual]

Extracted from the "category" field.

Reimplemented from qSlicerAbstractCoreModule.

Q_INVOKABLE vtkSlicerCLIModuleLogic* qSlicerCLIModule::cliModuleLogic

(

)

This method allows to get a pointer to the ModuleLogic. If no moduleLogic already exists, one will be created calling 'createLogic' method.

virtual QStringList qSlicerCLIModule::contributors

(

)

const [virtual]

Extracted from the "contributor" field.

Reimplemented from qSlicerAbstractCoreModule.

virtual vtkMRMLAbstractLogic* qSlicerCLIModule::createLogic

(

)

[protected, virtual]

Create and return the logic associated to this module

Implements qSlicerAbstractCoreModule.

virtual qSlicerAbstractModuleRepresentation* qSlicerCLIModule::createWidgetRepresentation

(

)

[protected, virtual]

Create and return the widget representation associated to this module

Implements qSlicerAbstractCoreModule.

QString qSlicerCLIModule::entryPoint

(

)

const

virtual QString qSlicerCLIModule::helpText

(

)

const [virtual]

Return help/acknowledgement text

Reimplemented from qSlicerAbstractCoreModule.

virtual int qSlicerCLIModule::index

(

)

const [virtual]

Optionally set in the module XML description.

Reimplemented from qSlicerAbstractCoreModule.

virtual QImage qSlicerCLIModule::logo

(

)

const [virtual]

The logo of the module, the credits given by the grants or instution.

Reimplemented from qSlicerAbstractModule.

static QImage qSlicerCLIModule::moduleLogoToImage

(

const ModuleLogo &

logo

)

[static]

Convert a ModuleLogo into a QIcon

Todo:

: Find a better place for this util function

QString qSlicerCLIModule::moduleType

(

)

const

void qSlicerCLIModule::setEntryPoint

(

const QString &

entryPoint

)

Set module entry point. Typically "slicer:0x012345" for loadable CLI or "/home/user/work/Slicer-Superbuild/../mycliexec" for executable CLI

void qSlicerCLIModule::setLogo

(

const ModuleLogo &

logo

)

void qSlicerCLIModule::setModuleType

(

const QString &

type

)

SharedObjectModule for loadable modules or CommandLineModule for executable modules.

void qSlicerCLIModule::setTempDirectory

(

const QString &

tempDirectory

)

Set temporary directory associated with the module.

virtual void qSlicerCLIModule::setup

(

)

[protected, virtual]

All initialization code should be done in the setup.

Implements qSlicerAbstractCoreModule.

void qSlicerCLIModule::setXmlModuleDescription

(

const QString &

xmlModuleDescription

)

Assign the module XML description. Note: That will also trigger the parsing of the XML structure

QString qSlicerCLIModule::tempDirectory

(

)

const

virtual QString qSlicerCLIModule::title

(

)

const [virtual]

Title of the module, (displayed to the user) title() must be reimplemented in derived classes.

Implements qSlicerAbstractCoreModule.

---

Member Data Documentation

QScopedPointer<qSlicerCLIModulePrivate> qSlicerCLIModule::d_ptr [protected]

Reimplemented from qSlicerAbstractModule.

Definition at line 105 of file qSlicerCLIModule.h.

---

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

• Base/QTCLI/qSlicerCLIModule.h