qSlicerStandardFileDialog Class Reference

#include <Base/QTGUI/qSlicerFileDialog.h>

Inheritance diagram for qSlicerStandardFileDialog:

Collaboration diagram for qSlicerStandardFileDialog:

Properties
IOAction	action
QString	description
qSlicerIO::IOFileType	fileType
Properties inherited from qSlicerFileDialog
QString	description
QStringList	loadedNodes

Public Member Functions
qSlicerFileDialog::IOAction	action () const override
QString	description () const override
bool	exec (const qSlicerIO::IOProperties &ioProperties=qSlicerIO::IOProperties()) override
qSlicerIO::IOFileType	fileType () const override
QStringList	loadedNodes () const override
	Return the list of nodes created by exec().
	qSlicerStandardFileDialog (QObject *parent=nullptr)
void	setAction (IOAction action)
virtual void	setDescription (const QString &description)
virtual void	setFileType (qSlicerIO::IOFileType fileType)
	~qSlicerStandardFileDialog () override
Public Member Functions inherited from qSlicerFileDialog
virtual Q_INVOKABLE void	dropEvent (QDropEvent *event)
virtual Q_INVOKABLE bool	isMimeDataAccepted (const QMimeData *mimeData) const
	qSlicerFileDialog (QObject *parent=nullptr)
	~qSlicerFileDialog () override

Static Public Member Functions
static Q_INVOKABLE QString	getExistingDirectory (qSlicerIO::IOProperties ioProperties=qSlicerIO::IOProperties())
static Q_INVOKABLE QStringList	getOpenFileName (qSlicerIO::IOProperties ioProperties=qSlicerIO::IOProperties())
	Properties available with IOProperties: fileMode, multipleFiles, fileType.
Static Public Member Functions inherited from qSlicerFileDialog
static Q_INVOKABLE QStringList	nameFilters (qSlicerIO::IOFileType fileType=QString("NoFile"))

Protected Member Functions
qSlicerIOOptions *	options (const qSlicerIO::IOProperties &ioProperties) const

Static Protected Member Functions
static ctkFileDialog *	createFileDialog (const qSlicerIO::IOProperties &ioProperties=qSlicerIO::IOProperties(), QWidget *parent=nullptr)

Protected Attributes
QScopedPointer< qSlicerStandardFileDialogPrivate >	d_ptr

Additional Inherited Members
Public Types inherited from qSlicerFileDialog
enum	IOAction { Read , Write }
typedef QObject	Superclass

Detailed Description

Definition at line 105 of file qSlicerFileDialog.h.

Property Documentation

action

IOAction qSlicerStandardFileDialog::action

readwrite

This property controls which action the dialog is doing: read or write. Read by default.

Definition at line 112 of file qSlicerFileDialog.h.

description

QString qSlicerStandardFileDialog::description

readwrite

Definition at line 109 of file qSlicerFileDialog.h.

fileType

qSlicerIO::IOFileType qSlicerStandardFileDialog::fileType

readwrite

Definition at line 108 of file qSlicerFileDialog.h.

Constructor & Destructor Documentation

qSlicerStandardFileDialog()

qSlicerStandardFileDialog::qSlicerStandardFileDialog

(

QObject *

parent = nullptr

)

~qSlicerStandardFileDialog()

qSlicerStandardFileDialog::~qSlicerStandardFileDialog ( )

override

Member Function Documentation

action()

qSlicerFileDialog::IOAction qSlicerStandardFileDialog::action ( ) const

overridevirtual

Reimplemented to return the IOAction set by setAction()

See also

action, setAction()

Implements qSlicerFileDialog.

createFileDialog()

static ctkFileDialog * qSlicerStandardFileDialog::createFileDialog ( const qSlicerIO::IOProperties & ioProperties = qSlicerIO::IOProperties(), QWidget * parent = nullptr )

staticprotected

description()

QString qSlicerStandardFileDialog::description ( ) const

overridevirtual

Reimplemented to return the description set by setDescription()

See also

description, setDescription()

Implements qSlicerFileDialog.

exec()

bool qSlicerStandardFileDialog::exec ( const qSlicerIO::IOProperties & ioProperties = qSlicerIO::IOProperties() )

overridevirtual

run the dialog to select the file/files/directory Properties available with IOProperties: fileMode, multipleFiles, fileType.

Implements qSlicerFileDialog.

fileType()

qSlicerIO::IOFileType qSlicerStandardFileDialog::fileType ( ) const

overridevirtual

Reimplemented to return the fileType set by setFileType()

See also

fileType, setFileType()

Implements qSlicerFileDialog.

getExistingDirectory()

static Q_INVOKABLE QString qSlicerStandardFileDialog::getExistingDirectory ( qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties() )

static

getOpenFileName()

static Q_INVOKABLE QStringList qSlicerStandardFileDialog::getOpenFileName ( qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties() )

static

Properties available with IOProperties: fileMode, multipleFiles, fileType.

loadedNodes()

QStringList qSlicerStandardFileDialog::loadedNodes ( ) const

overridevirtual

Return the list of nodes created by exec().

Reimplemented from qSlicerFileDialog.

options()

qSlicerIOOptions * qSlicerStandardFileDialog::options ( const qSlicerIO::IOProperties & ioProperties ) const

protected

setAction()

void qSlicerStandardFileDialog::setAction

(

IOAction

action

)

Set the action of the file dialog. To be called by python.

See also

action, action()

setDescription()

virtual void qSlicerStandardFileDialog::setDescription ( const QString & description )

virtual

setFileType()

virtual void qSlicerStandardFileDialog::setFileType ( qSlicerIO::IOFileType fileType )

virtual

Member Data Documentation

d_ptr

QScopedPointer<qSlicerStandardFileDialogPrivate> qSlicerStandardFileDialog::d_ptr

protected

Definition at line 150 of file qSlicerFileDialog.h.

---

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

• Base/QTGUI/qSlicerFileDialog.h