Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
qSlicerScriptedFileDialog Class Reference

#include <Base/QTGUI/qSlicerScriptedFileDialog.h>

Inheritance diagram for qSlicerScriptedFileDialog:
Collaboration diagram for qSlicerScriptedFileDialog:

Public Types

typedef qSlicerStandardFileDialog Superclass
 
- Public Types inherited from qSlicerFileDialog
enum  IOAction { Read , Write }
 
typedef QObject Superclass
 

Public Slots

void acceptMimeData (bool accept)
 

Public Member Functions

Q_INVOKABLE QDropEvent * dropEvent () const
 
void dropEvent (QDropEvent *event) override
 Reimplemented to propagate to python methods.
 
bool exec (const qSlicerIO::IOProperties &ioProperties=qSlicerIO::IOProperties()) override
 Reimplemented to propagate to python methods.
 
Q_INVOKABLE const qSlicerIO::IOPropertiesioProperties () const
 
bool isMimeDataAccepted (const QMimeData *mimeData) const override
 Reimplemented to propagate to python methods.
 
Q_INVOKABLE const QMimeData * mimeData () const
 
QString pythonSource () const
 
 qSlicerScriptedFileDialog (QObject *parent=nullptr)
 
Q_INVOKABLE PyObjectself () const
 Convenience method allowing to retrieve the associated scripted instance.
 
bool setPythonSource (const QString &filePath, const QString &className=QLatin1String(""), bool missingClassIsExpected=true)
 
 ~qSlicerScriptedFileDialog () override
 
- Public Member Functions inherited from qSlicerStandardFileDialog
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
 qSlicerFileDialog (QObject *parent=nullptr)
 
 ~qSlicerFileDialog () override
 

Protected Attributes

QScopedPointer< qSlicerScriptedFileDialogPrivate > d_ptr
 
- Protected Attributes inherited from qSlicerStandardFileDialog
QScopedPointer< qSlicerStandardFileDialogPrivate > d_ptr
 

Additional Inherited Members

- Properties inherited from qSlicerStandardFileDialog
IOAction action
 
QString description
 
qSlicerIO::IOFileType fileType
 
- Properties inherited from qSlicerFileDialog
QString description
 
QStringList loadedNodes
 
- Static Public Member Functions inherited from qSlicerStandardFileDialog
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 inherited from qSlicerStandardFileDialog
qSlicerIOOptionsoptions (const qSlicerIO::IOProperties &ioProperties) const
 
- Static Protected Member Functions inherited from qSlicerStandardFileDialog
static ctkFileDialog * createFileDialog (const qSlicerIO::IOProperties &ioProperties=qSlicerIO::IOProperties(), QWidget *parent=nullptr)
 

Detailed Description

Definition at line 35 of file qSlicerScriptedFileDialog.h.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerScriptedFileDialog()

qSlicerScriptedFileDialog::qSlicerScriptedFileDialog ( QObject * parent = nullptr)

◆ ~qSlicerScriptedFileDialog()

qSlicerScriptedFileDialog::~qSlicerScriptedFileDialog ( )
override

Member Function Documentation

◆ acceptMimeData

void qSlicerScriptedFileDialog::acceptMimeData ( bool accept)
slot

◆ dropEvent() [1/2]

Q_INVOKABLE QDropEvent * qSlicerScriptedFileDialog::dropEvent ( ) const

Return the dropEvent when dropEvent() is being called.

See also
dropEvent()

◆ dropEvent() [2/2]

void qSlicerScriptedFileDialog::dropEvent ( QDropEvent * event)
overridevirtual

Reimplemented to propagate to python methods.

Reimplemented from qSlicerFileDialog.

◆ exec()

bool qSlicerScriptedFileDialog::exec ( const qSlicerIO::IOProperties & ioProperties = qSlicerIO::IOProperties())
overridevirtual

Reimplemented to propagate to python methods.

Implements qSlicerFileDialog.

◆ ioProperties()

Q_INVOKABLE const qSlicerIO::IOProperties & qSlicerScriptedFileDialog::ioProperties ( ) const

Return the ioProperties when exec() is being called.

See also
exec()

◆ isMimeDataAccepted()

bool qSlicerScriptedFileDialog::isMimeDataAccepted ( const QMimeData * mimeData) const
overridevirtual

Reimplemented to propagate to python methods.

Reimplemented from qSlicerFileDialog.

◆ mimeData()

Q_INVOKABLE const QMimeData * qSlicerScriptedFileDialog::mimeData ( ) const

Return the dragEnterEvent when dragEnterEvent() is being called.

See also
dragEnterEvent()

◆ pythonSource()

QString qSlicerScriptedFileDialog::pythonSource ( ) const

◆ self()

Q_INVOKABLE PyObject * qSlicerScriptedFileDialog::self ( ) const

Convenience method allowing to retrieve the associated scripted instance.

◆ setPythonSource()

bool qSlicerScriptedFileDialog::setPythonSource ( const QString & filePath,
const QString & className = QLatin1String(""),
bool missingClassIsExpected = true )
Warning
Setting the source is a no-op. See detailed comment in the source code. If missingClassIsExpected is true (default) then missing class is expected and not treated as an error.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerScriptedFileDialogPrivate> qSlicerScriptedFileDialog::d_ptr
protected

Definition at line 76 of file qSlicerScriptedFileDialog.h.


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