Slicer  5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Properties | Public Member Functions | Static Public Member Functions
qSlicerFileDialog Class Referenceabstract

#include <Base/QTGUI/qSlicerFileDialog.h>

Inheritance diagram for qSlicerFileDialog:
Inheritance graph
[legend]
Collaboration diagram for qSlicerFileDialog:
Collaboration graph
[legend]

Public Types

enum  IOAction { Read, Write }
 
typedef QObject Superclass
 

Properties

QString description
 

Public Member Functions

virtual qSlicerFileDialog::IOAction action () const =0
 
virtual QString description () const =0
 
virtual void dropEvent (QDropEvent *event)
 
virtual bool exec (const qSlicerIO::IOProperties &ioProperties=qSlicerIO::IOProperties())=0
 
virtual qSlicerIO::IOFileType fileType () const =0
 
virtual bool isMimeDataAccepted (const QMimeData *mimeData) const
 
virtual QStringList loadedNodes () const
 
 qSlicerFileDialog (QObject *parent=nullptr)
 
 ~qSlicerFileDialog () override
 

Static Public Member Functions

static QStringList nameFilters (qSlicerIO::IOFileType fileType=QString("NoFile"))
 

Detailed Description

Definition at line 43 of file qSlicerFileDialog.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file qSlicerFileDialog.h.

Member Enumeration Documentation

◆ IOAction

Enumerator
Read 
Write 

Definition at line 60 of file qSlicerFileDialog.h.

Property Documentation

◆ description

QString qSlicerFileDialog::description
read

Definition at line 47 of file qSlicerFileDialog.h.

Constructor & Destructor Documentation

◆ qSlicerFileDialog()

qSlicerFileDialog::qSlicerFileDialog ( QObject *  parent = nullptr)

◆ ~qSlicerFileDialog()

qSlicerFileDialog::~qSlicerFileDialog ( )
override

Member Function Documentation

◆ action()

virtual qSlicerFileDialog::IOAction qSlicerFileDialog::action ( ) const
pure virtual

◆ description()

virtual QString qSlicerFileDialog::description ( ) const
pure virtual

Unique name of the reader/writer

See also
filetype()

Implemented in qSlicerStandardFileDialog, qSlicerDataDialog, qSlicerModelsDialog, qSlicerSaveDataDialog, and qSlicerExportNodeDialog.

◆ dropEvent()

virtual void qSlicerFileDialog::dropEvent ( QDropEvent *  event)
virtual

Handle drop events: populate the dialog with the dropped mime data. Can be reimplemented in subclass to support drag&drop. Do nothing by default. If it does something, acceptProposedAction() or accept() must be called.

See also
isMimeDataAccepted()

Reimplemented in qSlicerScriptedFileDialog, and qSlicerDataDialog.

◆ exec()

virtual bool qSlicerFileDialog::exec ( const qSlicerIO::IOProperties ioProperties = qSlicerIO::IOProperties())
pure virtual

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

Implemented in qSlicerStandardFileDialog, qSlicerScriptedFileDialog, qSlicerDataDialog, qSlicerExportNodeDialog, qSlicerModelsDialog, and qSlicerSaveDataDialog.

◆ fileType()

virtual qSlicerIO::IOFileType qSlicerFileDialog::fileType ( ) const
pure virtual

◆ isMimeDataAccepted()

virtual bool qSlicerFileDialog::isMimeDataAccepted ( const QMimeData *  mimeData) const
virtual

Accept or ignore mimedata. Returns false by default. Can be reimplemented in subclass to support drag&drop.

See also
dropEvent()

Reimplemented in qSlicerScriptedFileDialog, and qSlicerDataDialog.

◆ loadedNodes()

virtual QStringList qSlicerFileDialog::loadedNodes ( ) const
virtual

Return the list of nodes created by exec(). To be reimplemented.

See also
qSlicerFileReader::loadedNodes()

Reimplemented in qSlicerStandardFileDialog, and qSlicerModelsDialog.

◆ nameFilters()

static QStringList qSlicerFileDialog::nameFilters ( qSlicerIO::IOFileType  fileType = QString("NoFile"))
static

TBD: move in qSlicerCoreIOManager or qSlicerIOManager ? Return the namefilters of all the readers in IOManager corresponding to fileType


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