 |
Slicer 4.2
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
|
Slicer 4.2
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Base/QTGUI/qSlicerScriptedLoadableModule.h>
Public Types | |
| typedef qSlicerScriptedLoadableModulePrivate | Pimpl |
| typedef qSlicerLoadableModule | Superclass |
Properties | |
| QString | acknowledgementText |
| QStringList | categories |
| Reimplemented to expose the setter setCategories. | |
| QStringList | contributors |
| QStringList | dependencies |
| QVariantMap | extensions |
| QString | helpText |
| bool | hidden |
| QIcon | icon |
| int | index |
| QString | title |
Public Member Functions | |
| virtual QString | acknowledgementText () const |
| virtual QStringList | categories () const |
| virtual QStringList | contributors () const |
| Return the contributors of the module. | |
| virtual QStringList | dependencies () const |
| virtual QVariantMap | extensions () const |
| virtual QString | helpText () const |
| Return help/acknowledgement text. | |
| virtual QIcon | icon () const |
| virtual int | index () const |
| Return the category index of the module. | |
| virtual bool | isHidden () const |
| QString | pythonSource () const |
| qSlicerScriptedLoadableModule (QObject *parent=0) | |
| void | setAcknowledgementText (const QString &newAcknowledgementText) |
| void | setCategories (const QStringList &newCategories) |
| void | setContributors (const QStringList &newContributors) |
| void | setDependencies (const QStringList &dependencies) |
| void | setExtensions (const QVariantMap &extensions) |
| void | setHelpText (const QString &newHelpText) |
| void | setHidden (bool hidden) |
| void | setIcon (const QIcon &newIcon) |
| void | setIndex (const int index) |
| bool | setPythonSource (const QString &newPythonSource) |
| void | setTitle (const QString &newTitle) |
| virtual QString | title () const |
| virtual | ~qSlicerScriptedLoadableModule () |
Protected Member Functions | |
| virtual vtkMRMLAbstractLogic * | createLogic () |
| virtual qSlicerAbstractModuleRepresentation * | createWidgetRepresentation () |
| Create and return a widget representation for the module. | |
| void | registerFileDialog () |
| virtual void | setup () |
| All initialization code should be done in the setup. | |
Protected Attributes | |
| QScopedPointer < qSlicerScriptedLoadableModulePrivate > | d_ptr |
Definition at line 34 of file qSlicerScriptedLoadableModule.h.
| typedef qSlicerScriptedLoadableModulePrivate qSlicerScriptedLoadableModule::Pimpl |
Definition at line 52 of file qSlicerScriptedLoadableModule.h.
Reimplemented from qSlicerLoadableModule.
Definition at line 51 of file qSlicerScriptedLoadableModule.h.
QString qSlicerScriptedLoadableModule::acknowledgementText [read, write] |
This property holds the acknowledgments for the module Credits (organization, grants, thanks...) can be given and are displayed in the acknowledgment tab in the module panel. The contributors of the module will automatically be appended when needed, don't duplicate the information in the acknowledgements. acknowledgementText() must be reimplemented for each module.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 42 of file qSlicerScriptedLoadableModule.h.
QStringList qSlicerScriptedLoadableModule::categories [read, write] |
Reimplemented to expose the setter setCategories.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 39 of file qSlicerScriptedLoadableModule.h.
QStringList qSlicerScriptedLoadableModule::contributors [read, write] |
This property holds the authors of the module It is shown in the Acknowledgement page. If there are multiple contributors, they must be listed in the order of contribution. For each contributor, the name of the institution can succede the author: e.g. John Doe, CompanyName Inc. contributors() must be reimplemented for each module.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 40 of file qSlicerScriptedLoadableModule.h.
QStringList qSlicerScriptedLoadableModule::dependencies [read, write] |
This property holds the module name list of the module dependencies. It is used to order the loading of the modules. When setup() is called it is ensured that all the dependencies have already been setup. There is no dependency cycle check, so special care must be taken to avoid infinite loop. By default, there is no dependencies.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 46 of file qSlicerScriptedLoadableModule.h.
QVariantMap qSlicerScriptedLoadableModule::extensions [read, write] |
Definition at line 43 of file qSlicerScriptedLoadableModule.h.
QString qSlicerScriptedLoadableModule::helpText [read, write] |
This property holds the help of the module. The help is displayed inside the module as a tab. helpText must be reimplemented for each module.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 41 of file qSlicerScriptedLoadableModule.h.
bool qSlicerScriptedLoadableModule::hidden [read, write] |
This property holds whether the module is visible to the user. If the module is hidden, it doesn't appear in the list of modules menu. However, the module is programatically accessible. By default, modules are visible (hidden == false).
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 45 of file qSlicerScriptedLoadableModule.h.
QIcon qSlicerScriptedLoadableModule::icon [read, write] |
This property holds the module's icon. It is also the icon of the module QAction (see action()).
Reimplemented from qSlicerAbstractModule.
Definition at line 44 of file qSlicerScriptedLoadableModule.h.
int qSlicerScriptedLoadableModule::index [read, write] |
This property controls the index used to sort modules in the module selector's menu in the module's category. An index of 0 means the module should be first in the category, a value of 1 if the module should be second and so on. -1 means that the module should be added at the end. In case modules indexes have the same index, the alphabetical order will be used. -1 by default.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 47 of file qSlicerScriptedLoadableModule.h.
QString qSlicerScriptedLoadableModule::title [read, write] |
This property contains the title of the module. e.g. "Volumes", "Volume Rendering", "Welcome to Slicer"... title (not name) is displayed to the user in the GUI (but internally name is used to uniquely identify the module). The module title can contain any characters. title() must be overwritten for each module.
Reimplemented from qSlicerAbstractCoreModule.
Definition at line 37 of file qSlicerScriptedLoadableModule.h.
| qSlicerScriptedLoadableModule::qSlicerScriptedLoadableModule | ( | QObject * | parent = 0 | ) |
| virtual qSlicerScriptedLoadableModule::~qSlicerScriptedLoadableModule | ( | ) | [virtual] |
| virtual QString qSlicerScriptedLoadableModule::acknowledgementText | ( | ) | const [virtual] |
Return acknowledgement text for the module Must be reimplemented in the derived classes
Reimplemented from qSlicerLoadableModule.
| virtual QStringList qSlicerScriptedLoadableModule::categories | ( | ) | const [virtual] |
Categories the module belongs to. Categories support subcategories. Use the '.' separator to specify a subcategory (no depth limit), e.g.: "Filtering.Arithmetic". The function must be reimplemented in derived classes. Note: If a category doesn't exist, it will be created.
Reimplemented from qSlicerAbstractCoreModule.
| virtual QStringList qSlicerScriptedLoadableModule::contributors | ( | ) | const [virtual] |
Return the contributors of the module.
Reimplemented from qSlicerAbstractCoreModule.
| virtual vtkMRMLAbstractLogic* qSlicerScriptedLoadableModule::createLogic | ( | ) | [protected, virtual] |
Create and return the module logic Note: Only one instance of the logic will exist per module
Implements qSlicerAbstractCoreModule.
| virtual qSlicerAbstractModuleRepresentation* qSlicerScriptedLoadableModule::createWidgetRepresentation | ( | ) | [protected, virtual] |
Create and return a widget representation for the module.
Implements qSlicerAbstractCoreModule.
| virtual QStringList qSlicerScriptedLoadableModule::dependencies | ( | ) | const [virtual] |
Reimplemented from qSlicerAbstractCoreModule.
| virtual QVariantMap qSlicerScriptedLoadableModule::extensions | ( | ) | const [virtual] |
| virtual QString qSlicerScriptedLoadableModule::helpText | ( | ) | const [virtual] |
Return help/acknowledgement text.
Reimplemented from qSlicerLoadableModule.
| virtual QIcon qSlicerScriptedLoadableModule::icon | ( | ) | const [virtual] |
Icon of the module. Anytime a graphical representation of the module is needed, the icon is used. It's the icon shown in the module selector as well as in the frequently used module toolbar (if any).
Reimplemented from qSlicerAbstractModule.
| virtual int qSlicerScriptedLoadableModule::index | ( | ) | const [virtual] |
Return the category index of the module.
Reimplemented from qSlicerAbstractCoreModule.
| virtual bool qSlicerScriptedLoadableModule::isHidden | ( | ) | const [virtual] |
Enable/Disable hide state of the module Needs to be hidden before the module menu is created.
Reimplemented from qSlicerAbstractCoreModule.
| QString qSlicerScriptedLoadableModule::pythonSource | ( | ) | const |
| void qSlicerScriptedLoadableModule::registerFileDialog | ( | ) | [protected] |
| void qSlicerScriptedLoadableModule::setAcknowledgementText | ( | const QString & | newAcknowledgementText | ) |
| void qSlicerScriptedLoadableModule::setCategories | ( | const QStringList & | newCategories | ) |
| void qSlicerScriptedLoadableModule::setContributors | ( | const QStringList & | newContributors | ) |
| void qSlicerScriptedLoadableModule::setDependencies | ( | const QStringList & | dependencies | ) |
| void qSlicerScriptedLoadableModule::setExtensions | ( | const QVariantMap & | extensions | ) |
| void qSlicerScriptedLoadableModule::setHelpText | ( | const QString & | newHelpText | ) |
| void qSlicerScriptedLoadableModule::setHidden | ( | bool | hidden | ) |
| void qSlicerScriptedLoadableModule::setIcon | ( | const QIcon & | newIcon | ) |
| void qSlicerScriptedLoadableModule::setIndex | ( | const int | index | ) |
| bool qSlicerScriptedLoadableModule::setPythonSource | ( | const QString & | newPythonSource | ) |
| void qSlicerScriptedLoadableModule::setTitle | ( | const QString & | newTitle | ) |
| virtual void qSlicerScriptedLoadableModule::setup | ( | ) | [protected, virtual] |
All initialization code should be done in the setup.
Reimplemented from qSlicerLoadableModule.
| virtual QString qSlicerScriptedLoadableModule::title | ( | ) | const [virtual] |
Title of the module, (displayed to the user) title() must be reimplemented in derived classes.
Implements qSlicerAbstractCoreModule.
QScopedPointer<qSlicerScriptedLoadableModulePrivate> qSlicerScriptedLoadableModule::d_ptr [protected] |
Reimplemented from qSlicerLoadableModule.
Definition at line 102 of file qSlicerScriptedLoadableModule.h.
1.7.4
