qSlicerGenericIOOptionsWidget Class Reference

#include <Base/QTGUI/qSlicerGenericIOOptionsWidget.h>

Inheritance diagram for qSlicerGenericIOOptionsWidget:

Collaboration diagram for qSlicerGenericIOOptionsWidget:

Public Types
typedef qSlicerFileWriterOptionsWidget	Superclass
Public Types inherited from qSlicerFileWriterOptionsWidget
typedef qSlicerIOOptionsWidget	Superclass
Public Types inherited from qSlicerIOOptionsWidget
typedef qSlicerIOOptions	Superclass

Public Slots
void	setFileName (const QString &fileName) override
void	setFileNames (const QStringList &fileNames) override
void	setMRMLScene (vtkMRMLScene *scene) override
void	setObject (vtkObject *object) override
Public Slots inherited from qSlicerFileWriterOptionsWidget
virtual void	setObject (vtkObject *object)
	Set the object to write (typically a scene or a MRML node)
Public Slots inherited from qSlicerIOOptionsWidget
virtual void	setFileName (const QString &fileName)
virtual void	setFileNames (const QStringList &fileNames)
Public Slots inherited from qSlicerWidget
void	setMRMLScene (vtkMRMLScene *scene) override

Public Member Functions
Q_INVOKABLE vtkMRMLFileIOHandler *	ioHandler () const
	qSlicerGenericIOOptionsWidget (QWidget *parent=nullptr)
	qSlicerGenericIOOptionsWidget (vtkMRMLFileIOHandler *ioHandler, QWidget *parent=nullptr)
Q_INVOKABLE void	setIOHandler (vtkMRMLFileIOHandler *ioHandler)
	Reader or writer that describes the options.
void	updateGUI (const qSlicerIO::IOProperties &ioProperties) override
	Set values of options (for example, to set default options in a file dialog).
	~qSlicerGenericIOOptionsWidget () override
Public Member Functions inherited from qSlicerFileWriterOptionsWidget
	qSlicerFileWriterOptionsWidget (QWidget *parent=nullptr)
	~qSlicerFileWriterOptionsWidget () override
Public Member Functions inherited from qSlicerIOOptionsWidget
bool	isValid () const override
	qSlicerIOOptionsWidget (QWidget *parent=nullptr)
	~qSlicerIOOptionsWidget () override
Public Member Functions inherited from qSlicerWidget
vtkSlicerApplicationLogic *	appLogic () const
vtkMRMLAbstractLogic *	moduleLogic (const QString &moduleName) const
	qSlicerWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	~qSlicerWidget () override
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene.
	qSlicerObject ()
virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget.
virtual	~qSlicerObject ()
Public Member Functions inherited from qSlicerIOOptions
const qSlicerIO::IOProperties &	properties () const
	qSlicerIOOptions ()
	Constructor initialize empty properties.
virtual	~qSlicerIOOptions ()

Static Public Member Functions
static vtkMRMLFileIOHandler *	findIOHandler (const char *className)
template<class T>
static vtkSmartPointer< vtkMRMLFileIOHandler >	findOrCreateIOHandler ()

Protected Slots
void	onApplicationAboutToQuit ()
void	onOptionChanged ()
	Called when the user changes an option.

Protected Member Functions
void	updateOptions ()
	Request the description of options from the reader or writer and update the widgets.
Protected Member Functions inherited from qSlicerFileWriterOptionsWidget
	qSlicerFileWriterOptionsWidget (qSlicerIOOptionsPrivate *pimpl, QWidget *parent)
Protected Member Functions inherited from qSlicerIOOptionsWidget
	Q_DECLARE_PRIVATE_D (qGetPtrHelper(qSlicerIOOptions::d_ptr), qSlicerIOOptions)
	qSlicerIOOptionsWidget (qSlicerIOOptionsPrivate *pimpl, QWidget *parent)
void	updateValid () override
	Must be called anytime the result of isValid() can change.
Protected Member Functions inherited from qSlicerIOOptions
	qSlicerIOOptions (qSlicerIOOptionsPrivate *pimpl)

Static Protected Member Functions
static void	initializeUnregisteredIOHandler (vtkMRMLFileIOHandler *handler)
	Set the scene and the application logic's file IO manager in a reader or writer that is not registered.

Additional Inherited Members
Signals inherited from qSlicerIOOptionsWidget
void	validChanged (bool)
Signals inherited from qSlicerWidget
void	mrmlSceneChanged (vtkMRMLScene *)
Protected Attributes inherited from qSlicerIOOptionsWidget
QScopedPointer< qSlicerIOOptionsPrivate >	d_ptr
Protected Attributes inherited from qSlicerWidget
QScopedPointer< qSlicerWidgetPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr
Protected Attributes inherited from qSlicerIOOptions
QScopedPointer< qSlicerIOOptionsPrivate >	d_ptr

Detailed Description

Options widget that displays the options of a VTK-based reader or writer (see vtkMRMLIOOptionsDescription).

See https://slicer.readthedocs.io/en/latest/developer_guide/mrml_overview.html#reader-and-writer-options

Definition at line 36 of file qSlicerGenericIOOptionsWidget.h.

Member Typedef Documentation

Superclass

typedef qSlicerFileWriterOptionsWidget qSlicerGenericIOOptionsWidget::Superclass

Definition at line 40 of file qSlicerGenericIOOptionsWidget.h.

Constructor & Destructor Documentation

qSlicerGenericIOOptionsWidget() [1/2]

qSlicerGenericIOOptionsWidget::qSlicerGenericIOOptionsWidget ( QWidget * parent = nullptr )

explicit

qSlicerGenericIOOptionsWidget() [2/2]

qSlicerGenericIOOptionsWidget::qSlicerGenericIOOptionsWidget	(	vtkMRMLFileIOHandler *	ioHandler,
		QWidget *	parent = nullptr )

~qSlicerGenericIOOptionsWidget()

qSlicerGenericIOOptionsWidget::~qSlicerGenericIOOptionsWidget ( )

override

Member Function Documentation

findIOHandler()

static vtkMRMLFileIOHandler * qSlicerGenericIOOptionsWidget::findIOHandler ( const char * className )

static

Find a registered reader or writer of the specified class (exact class name match) in the file IO manager of the application logic. Returns nullptr if not found.

findOrCreateIOHandler()

template<class T>

static vtkSmartPointer< vtkMRMLFileIOHandler > qSlicerGenericIOOptionsWidget::findOrCreateIOHandler ( )

inlinestatic

Return registered reader or writer of the specified class. If not found then a new instance is created (it is not registered, but it can access the scene and the application logic).

Definition at line 59 of file qSlicerGenericIOOptionsWidget.h.

initializeUnregisteredIOHandler()

static void qSlicerGenericIOOptionsWidget::initializeUnregisteredIOHandler ( vtkMRMLFileIOHandler * handler )

staticprotected

Set the scene and the application logic's file IO manager in a reader or writer that is not registered.

ioHandler()

Q_INVOKABLE vtkMRMLFileIOHandler * qSlicerGenericIOOptionsWidget::ioHandler

(

)

const

onApplicationAboutToQuit

void qSlicerGenericIOOptionsWidget::onApplicationAboutToQuit ( )

protectedslot

Called when the application is about to quit. Node selectors stop observing the scene, because nodes may be removed from the scene after the application object is deleted (if this widget still exists at that time, for example because it was created from Python without a parent), and node selectors must not update their GUI then.

onOptionChanged

void qSlicerGenericIOOptionsWidget::onOptionChanged ( )

protectedslot

Called when the user changes an option.

setFileName

void qSlicerGenericIOOptionsWidget::setFileName ( const QString & fileName )

overrideslot

setFileNames

void qSlicerGenericIOOptionsWidget::setFileNames ( const QStringList & fileNames )

overrideslot

setIOHandler()

Q_INVOKABLE void qSlicerGenericIOOptionsWidget::setIOHandler

(

vtkMRMLFileIOHandler *

ioHandler

)

Reader or writer that describes the options.

setMRMLScene

void qSlicerGenericIOOptionsWidget::setMRMLScene ( vtkMRMLScene * scene )

overrideslot

setObject

void qSlicerGenericIOOptionsWidget::setObject ( vtkObject * object )

overrideslot

updateGUI()

void qSlicerGenericIOOptionsWidget::updateGUI ( const qSlicerIO::IOProperties & ioProperties )

overridevirtual

Set values of options (for example, to set default options in a file dialog).

Reimplemented from qSlicerIOOptionsWidget.

updateOptions()

void qSlicerGenericIOOptionsWidget::updateOptions ( )

protected

Request the description of options from the reader or writer and update the widgets.

---

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

• Base/QTGUI/qSlicerGenericIOOptionsWidget.h