qSlicerFileWriter Class Reference

#include <Base/QTCore/qSlicerFileWriter.h>

Inheritance diagram for qSlicerFileWriter:

Collaboration diagram for qSlicerFileWriter:

Public Member Functions
virtual bool	canWriteObject (vtkObject *object) const
	Return true if the object is handled by the writer. More...
virtual QStringList	extensions (vtkObject *object) const =0
	qSlicerFileWriter (QObject *parent=0)
virtual bool	write (const qSlicerIO::IOProperties &properties)
QStringList	writtenNodes () const
virtual	~qSlicerFileWriter ()
Public Member Functions inherited from qSlicerIO
virtual QString	description () const =0
	Unique name of the reader/writer. More...
virtual IOFileType	fileType () const =0
	Multiple readers can share the same file type. More...
virtual qSlicerIOOptions *	options () const
	qSlicerIO (QObject *parent=0)
virtual	~qSlicerIO ()
Public Member Functions inherited from qSlicerObject
vtkMRMLScene *	mrmlScene () const
	Return a pointer on the MRML scene. More...
	qSlicerObject ()
virtual void	setMRMLScene (vtkMRMLScene *)
	Set the current MRML scene to the widget. More...
virtual	~qSlicerObject ()

Protected Member Functions
void	setWrittenNodes (const QStringList &nodes)

Protected Attributes
QScopedPointer< qSlicerFileWriterPrivate >	d_ptr
Protected Attributes inherited from qSlicerObject
QScopedPointer< qSlicerObjectPrivate >	d_ptr

Additional Inherited Members
Public Types inherited from qSlicerIO
typedef QString	IOFileType
typedef QVariantMap	IOProperties
typedef QObject	Superclass

Detailed Description

Definition at line 30 of file qSlicerFileWriter.h.

Constructor & Destructor Documentation

qSlicerFileWriter()

qSlicerFileWriter::qSlicerFileWriter

(

QObject *

parent = 0

)

~qSlicerFileWriter()

virtual qSlicerFileWriter::~qSlicerFileWriter ( )

virtual

Member Function Documentation

canWriteObject()

virtual bool qSlicerFileWriter::canWriteObject ( vtkObject *  object ) const

virtual

Return true if the object is handled by the writer.

Reimplemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, and qSlicerSceneWriter.

extensions()

virtual QStringList qSlicerFileWriter::extensions ( vtkObject *  object ) const

pure virtual

Return a list of the supported extensions for a particuliar object. Please read QFileDialog::nameFilters for the allowed formats Example: "Image (*.jpg *.png *.tiff)", "Model (*.vtk)"

Implemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, and qSlicerSceneWriter.

setWrittenNodes()

void qSlicerFileWriter::setWrittenNodes ( const QStringList &  nodes )

protected

write()

virtual bool qSlicerFileWriter::write ( const qSlicerIO::IOProperties &  properties )

virtual

Write the node identified by nodeID into the fileName file. Returns true on success Properties availables:

• QString nodeID
• QString fileName
• QString fileFormat
• bool compressed ...

Reimplemented in qSlicerScriptedFileWriter, qSlicerNodeWriter, and qSlicerSceneWriter.

writtenNodes()

QStringList qSlicerFileWriter::writtenNodes

(

)

const

Member Data Documentation

d_ptr

QScopedPointer<qSlicerFileWriterPrivate> qSlicerFileWriter::d_ptr

protected

Definition at line 62 of file qSlicerFileWriter.h.

---

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

• Base/QTCore/qSlicerFileWriter.h