#include <Base/QTCLI/qSlicerCLIModule.h>

Inheritance diagram for qSlicerCLIModule:

[legend]

Collaboration diagram for qSlicerCLIModule:

[legend]

Public Types
typedef qSlicerAbstractModule	Superclass

Public Types inherited from qSlicerAbstractModule
typedef qSlicerAbstractCoreModule	Superclass

typedef QObject	Superclass

Public Member Functions
QString	acknowledgementText () const override

QStringList	associatedNodeTypes () const override
	Specify editable node types.

QStringList	categories () const override
	Extracted from the "category" field.

Q_INVOKABLE vtkSlicerCLIModuleLogic *	cliModuleLogic ()

QStringList	contributors () const override
	Extracted from the "contributor" field.

QString	entryPoint () const

QString	helpText () const override
	Return help/acknowledgement text.

int	index () const override
	Optionally set in the module XML description.

QImage	logo () const override
	The logo of the module, the credits given by the grants or institution.

ModuleDescription &	moduleDescription ()

QString	moduleType () const

	qSlicerCLIModule (QWidget *parent=nullptr)

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

QString	title () const override

QString	translate (const std::string &sourceText) const
	Translate string from source language to current application language.

	~qSlicerCLIModule () override

Public Member Functions inherited from qSlicerAbstractModule
Q_INVOKABLE QAction *	action ()

virtual QIcon	icon () const

	qSlicerAbstractModule (QObject *parent=nullptr)

	~qSlicerAbstractModule () override

	qSlicerAbstractCoreModule (QObject *parent=nullptr)

	~qSlicerAbstractCoreModule () override

virtual void	printAdditionalInfo ()

QString	slicerWikiUrl () const
	Convenience method to return slicer wiki URL.

QString	defaultDocumentationLink () const

void	initialize (vtkSlicerApplicationLogic *appLogic)

virtual QString	name () const

virtual void	setName (const QString &name)

virtual bool	isHidden () const

bool	isWidgetRepresentationCreationEnabled () const

void	setWidgetRepresentationCreationEnabled (bool value)

qSlicerAbstractModuleRepresentation *	widgetRepresentation ()

qSlicerAbstractModuleRepresentation *	createNewWidgetRepresentation ()

void	setAppLogic (vtkSlicerApplicationLogic *appLogic)

vtkSlicerApplicationLogic *	appLogic () const

vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	Convenience method for getting another module's logic from appLogic.

Q_INVOKABLE vtkMRMLAbstractLogic *	logic ()

Q_INVOKABLE vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.

virtual QStringList	dependencies () const

QString	path () const

void	setPath (const QString &newPath)

bool	isInstalled () const

void	setInstalled (bool value)

bool	isBuiltIn () const

void	setBuiltIn (bool value)

Static Public Member Functions
static QImage	moduleLogoToImage (const ModuleLogo &logo)

Protected Member Functions
vtkMRMLAbstractLogic *	createLogic () override
	Create and return the logic associated to this module.

qSlicerAbstractModuleRepresentation *	createWidgetRepresentation () override
	Create and return the widget representation associated to this module.

void	setup () override
	All initialization code should be done in the setup.

Protected Attributes
QScopedPointer< qSlicerCLIModulePrivate >	d_ptr

Protected Attributes inherited from qSlicerAbstractModule
QScopedPointer< qSlicerAbstractModulePrivate >	d_ptr

QScopedPointer< qSlicerAbstractCoreModulePrivate >	d_ptr

Additional Inherited Members
Properties inherited from qSlicerAbstractModule
QIcon	icon

QImage	logo

QString	name

QString	title

QStringList	categories

int	index

bool	hidden

bool	widgetRepresentationCreationEnabled

QString	helpText

QString	acknowledgementText

QStringList	contributors

QString	slicerWikiUrl

QString	defaultDocumentationLink

QStringList	dependencies

QString	path

bool	isInstalled

bool	isBuiltIn

QStringList	associatedNodeTypes

virtual void	setMRMLScene (vtkMRMLScene *)

Detailed Description

Definition at line 40 of file qSlicerCLIModule.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerAbstractModule qSlicerCLIModule::Superclass

Definition at line 45 of file qSlicerCLIModule.h.

Constructor & Destructor Documentation

◆ qSlicerCLIModule()

qSlicerCLIModule::qSlicerCLIModule ( QWidget * parent = nullptr )

◆ ~qSlicerCLIModule()

qSlicerCLIModule::~qSlicerCLIModule ( )

override

Member Function Documentation

◆ acknowledgementText()

QString qSlicerCLIModule::acknowledgementText ( ) const

overridevirtual

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

Reimplemented from qSlicerAbstractCoreModule.

◆ associatedNodeTypes()

QStringList qSlicerCLIModule::associatedNodeTypes ( ) const

overridevirtual

Specify editable node types.

Reimplemented from qSlicerAbstractCoreModule.

◆ categories()

QStringList qSlicerCLIModule::categories ( ) const

overridevirtual

Extracted from the "category" field.

Reimplemented from qSlicerAbstractCoreModule.

◆ cliModuleLogic()

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.

◆ contributors()

QStringList qSlicerCLIModule::contributors ( ) const

overridevirtual

Extracted from the "contributor" field.

Reimplemented from qSlicerAbstractCoreModule.

◆ createLogic()

vtkMRMLAbstractLogic * qSlicerCLIModule::createLogic ( )

overrideprotectedvirtual

Create and return the logic associated to this module.

Implements qSlicerAbstractCoreModule.

◆ createWidgetRepresentation()

qSlicerAbstractModuleRepresentation * qSlicerCLIModule::createWidgetRepresentation ( )

overrideprotectedvirtual

Create and return the widget representation associated to this module.

Implements qSlicerAbstractCoreModule.

◆ entryPoint()

QString qSlicerCLIModule::entryPoint ( ) const

◆ helpText()

QString qSlicerCLIModule::helpText ( ) const

overridevirtual

Return help/acknowledgement text.

Reimplemented from qSlicerAbstractCoreModule.

◆ index()

int qSlicerCLIModule::index ( ) const

overridevirtual

Optionally set in the module XML description.

Reimplemented from qSlicerAbstractCoreModule.

◆ logo()

QImage qSlicerCLIModule::logo ( ) const

overridevirtual

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

Reimplemented from qSlicerAbstractModule.

◆ moduleDescription()

ModuleDescription & qSlicerCLIModule::moduleDescription ( )

Return the module description object used to store the module properties.

◆ moduleLogoToImage()

static QImage qSlicerCLIModule::moduleLogoToImage ( const ModuleLogo & logo )

static

Convert a ModuleLogo into a QIcon

Todo: : Find a better place for this helper function

◆ moduleType()

QString qSlicerCLIModule::moduleType ( ) const

◆ setEntryPoint()

void qSlicerCLIModule::setEntryPoint ( const QString & entryPoint )

Set module entry point. Typically "slicer:0x012345" for loadable CLI or "/home/user/work/Slicer-SuperBuild/../my-cli-exec" for executable CLI

◆ setLogo()

void qSlicerCLIModule::setLogo ( const ModuleLogo & logo )

◆ setModuleType()

void qSlicerCLIModule::setModuleType ( const QString & type )

SharedObjectModule for loadable modules or CommandLineModule for executable modules.

◆ setTempDirectory()

void qSlicerCLIModule::setTempDirectory ( const QString & tempDirectory )

Set temporary directory associated with the module.

◆ setup()

void qSlicerCLIModule::setup ( )

overrideprotectedvirtual

All initialization code should be done in the setup.

Implements qSlicerAbstractCoreModule.

◆ setXmlModuleDescription()

void qSlicerCLIModule::setXmlModuleDescription ( const QString & xmlModuleDescription )

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

◆ tempDirectory()

QString qSlicerCLIModule::tempDirectory ( ) const

◆ title()

QString qSlicerCLIModule::title ( ) const

overridevirtual

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

Implements qSlicerAbstractCoreModule.

◆ translate()

QString qSlicerCLIModule::translate ( const std::string & sourceText ) const

Translate string from source language to current application language.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerCLIModulePrivate> qSlicerCLIModule::d_ptr

protected

Definition at line 119 of file qSlicerCLIModule.h.

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

Base/QTCLI/qSlicerCLIModule.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerCLIModule()

◆ ~qSlicerCLIModule()

Member Function Documentation

◆ acknowledgementText()

◆ associatedNodeTypes()

◆ categories()

◆ cliModuleLogic()

◆ contributors()

◆ createLogic()

◆ createWidgetRepresentation()

◆ entryPoint()

◆ helpText()

◆ index()

◆ logo()

◆ moduleDescription()

◆ moduleLogoToImage()

◆ moduleType()

◆ setEntryPoint()

◆ setLogo()

◆ setModuleType()

◆ setTempDirectory()

◆ setup()

◆ setXmlModuleDescription()

◆ tempDirectory()

◆ title()

◆ translate()

Member Data Documentation

◆ d_ptr