Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQuickFileDialog Class Reference

#include <qquickfiledialog_p.h>

Inheritance diagram for QQuickFileDialog:
Collaboration diagram for QQuickFileDialog:

Public Types

enum  FileMode { OpenFile , OpenFiles , SaveFile }
Public Types inherited from QQuickAbstractDialog
enum  StandardCode { Rejected , Accepted }

Signals

void fileModeChanged ()
void selectedFileChanged ()
void selectedFilesChanged ()
void currentFileChanged ()
void currentFilesChanged ()
void currentFolderChanged ()
void optionsChanged ()
void nameFiltersChanged ()
void defaultSuffixChanged ()
void acceptLabelChanged ()
void rejectLabelChanged ()
Signals inherited from QQuickAbstractDialog
void accepted ()
void rejected ()
void parentWindowChanged ()
void titleChanged ()
void flagsChanged ()
void modalityChanged ()
void visibleChanged ()
void resultChanged ()
 Q_REVISION (6, 10) void popupTypeChanged()
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.

Public Member Functions

 QQuickFileDialog (QObject *parent=nullptr)
 A file dialog.
FileMode fileMode () const
 \qmlproperty enumeration QtQuick.Dialogs::FileDialog::fileMode
void setFileMode (FileMode fileMode)
QUrl selectedFile () const
 \qmlproperty url QtQuick.Dialogs::FileDialog::selectedFile
void setSelectedFile (const QUrl &selectedFile)
QList< QUrlselectedFiles () const
 \qmlproperty list<url> QtQuick.Dialogs::FileDialog::selectedFiles
QUrl currentFile () const
 \qmlproperty url QtQuick.Dialogs::FileDialog::currentFile
void setCurrentFile (const QUrl &file)
QList< QUrlcurrentFiles () const
 \qmlproperty list<url> QtQuick.Dialogs::FileDialog::currentFiles
void setCurrentFiles (const QList< QUrl > &currentFiles)
QUrl currentFolder () const
 \qmlproperty url QtQuick.Dialogs::FileDialog::currentFolder
void setCurrentFolder (const QUrl &currentFolder)
QFileDialogOptions::FileDialogOptions options () const
 \qmlproperty flags QtQuick.Dialogs::FileDialog::options
void setOptions (QFileDialogOptions::FileDialogOptions options)
void resetOptions ()
QStringList nameFilters () const
 \qmlproperty list<string> QtQuick.Dialogs::FileDialog::nameFilters
void setNameFilters (const QStringList &filters)
void resetNameFilters ()
QQuickFileNameFilterselectedNameFilter () const
 \qmlproperty int QtQuick.Dialogs::FileDialog::selectedNameFilter.index \qmlproperty string QtQuick.Dialogs::FileDialog::selectedNameFilter.name \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.extensions \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.globs
QString defaultSuffix () const
 \qmlproperty string QtQuick.Dialogs::FileDialog::defaultSuffix
void setDefaultSuffix (const QString &suffix)
void resetDefaultSuffix ()
QString acceptLabel () const
 \qmlproperty string QtQuick.Dialogs::FileDialog::acceptLabel
void setAcceptLabel (const QString &label)
void resetAcceptLabel ()
QString rejectLabel () const
 \qmlproperty string QtQuick.Dialogs::FileDialog::rejectLabel
void setRejectLabel (const QString &label)
void resetRejectLabel ()
Public Member Functions inherited from QQuickAbstractDialog
 QQuickAbstractDialog (QQuickDialogType type, QObject *parent=nullptr)
 The base class of native dialogs.
 ~QQuickAbstractDialog ()
QPlatformDialogHelperhandle () const
QQmlListProperty< QObjectdata ()
QWindowparentWindow () const
 \qmlproperty Window QtQuick.Dialogs::Dialog::parentWindow
void setParentWindow (QWindow *window)
void resetParentWindow ()
QString title () const
 \qmlproperty string QtQuick.Dialogs::Dialog::title
void setTitle (const QString &title)
Qt::WindowFlags flags () const
 \qmlproperty Qt::WindowFlags QtQuick.Dialogs::Dialog::flags
void setFlags (Qt::WindowFlags flags)
Qt::WindowModality modality () const
 \qmlproperty Qt::WindowModality QtQuick.Dialogs::Dialog::modality
void setModality (Qt::WindowModality modality)
bool isVisible () const
 \qmlproperty bool QtQuick.Dialogs::Dialog::visible
void setVisible (bool visible)
int result () const
 \qmlproperty int QtQuick.Dialogs::Dialog::result
void setResult (int result)
QQuickPopup::PopupType popupType () const
 \qmlproperty enumeration QtQuick.Dialogs::Dialog::popupType
void setPopupType (QQuickPopup::PopupType popupType)
void resetPopupType ()
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QStringbindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThreadthread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectListchildren () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
virtual ~QQmlParserStatus ()

Protected Member Functions

bool useNativeDialog () const override
void onCreate (QPlatformDialogHelper *dialog) override
void onShow (QPlatformDialogHelper *dialog) override
void onHide (QPlatformDialogHelper *dialog) override
void accept () override
 \qmlmethod void QtQuick.Dialogs::Dialog::accept()
Protected Member Functions inherited from QQuickAbstractDialog
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
bool create (CreateOptions=CreateOptions::TryAllDialogTypes)
void destroy ()
virtual int dialogCode () const
QQuickItemfindParentItem () const
QWindowwindowForOpen () const
void deferredOpen (QWindow *window)
Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties

FileMode fileMode
QUrl selectedFile
QList< QUrlselectedFiles
QUrl currentFile
QList< QUrlcurrentFiles
QUrl currentFolder
QFileDialogOptions::FileDialogOptions options
QStringList nameFilters
QQuickFileNameFilterselectedNameFilter
QString defaultSuffix
QString acceptLabel
QString rejectLabel
Properties inherited from QQuickAbstractDialog
QQmlListProperty< QObjectdata
 \qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data
QWindowparentWindow
QString title
Qt::WindowFlags flags
Qt::WindowModality modality
QQuickPopup::PopupType popupType
bool visible
int result
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Slots inherited from QQuickAbstractDialog
void open ()
 \qmlmethod void QtQuick.Dialogs::Dialog::open()
void close ()
 \qmlmethod void QtQuick.Dialogs::Dialog::close()
virtual void reject ()
 \qmlmethod void QtQuick.Dialogs::Dialog::reject()
virtual void done (int result)
 \qmlmethod void QtQuick.Dialogs::Dialog::done(int result)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
Protected Types inherited from QQuickAbstractDialog
enum class  CreateOptions { TryAllDialogTypes = 0 , DontTryNativeDialog = 1 }
Protected Attributes inherited from QQuickAbstractDialog
int m_result = Rejected
QWindowm_parentWindow = nullptr
QString m_title
Qt::WindowFlags m_flags = Qt::Dialog
Qt::WindowModality m_modality = Qt::WindowModal
QQuickDialogType m_type = QQuickDialogType::FileDialog
QList< QObject * > m_data
std::unique_ptr< QPlatformDialogHelperm_handle
QQuickPopup::PopupType m_popupType = QQuickPopup::Window
bool m_visibleRequested = false
bool m_visible = false
bool m_complete = false
bool m_parentWindowExplicitlySet = false
bool m_firstShow = true
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 28 of file qquickfiledialog_p.h.

Member Enumeration Documentation

◆ FileMode

Enumerator
OpenFile 
OpenFiles 
SaveFile 

Definition at line 51 of file qquickfiledialog_p.h.

Constructor & Destructor Documentation

◆ QQuickFileDialog()

QQuickFileDialog::QQuickFileDialog ( QObject * parent = nullptr)
explicit

A file dialog.

\qmltype FileDialog
\inherits Dialog

! \nativetype QQuickFileDialog \inqmlmodule QtQuick.Dialogs

Since
6.2

The FileDialog type provides a QML API for file dialogs.

{The file dialog type allow dialogs to copy the native look and feel of the platform}

To show a file dialog, construct an instance of FileDialog, set the desired properties, and call \l {Dialog::}{open()}. The \l currentFolder property can be used to determine the folder in which the dialog opens. The \l selectedFile and \l selectedFiles properties can be used to determine which file(s) are selected when the dialog opens, and are also updated when the user selects a file in the dialog and when the dialog is accepted.

import QtCore
import QtQuick
import QtQuick.Controls
import QtQuick.Dialogs
ApplicationWindow {
width: 640
height: 480
visible: true
header: ToolBar {
Button {
text: qsTr("Choose Image...")
onClicked: fileDialog.open()
}
}
Image {
id: image
anchors.fill: parent
fillMode: Image.PreserveAspectFit
}
FileDialog {
id: fileDialog
currentFolder: StandardPaths.standardLocations(StandardPaths.PicturesLocation)[0]
onAccepted: image.source = selectedFile
}
}

Definition at line 62 of file qquickfiledialog.cpp.

Member Function Documentation

◆ accept()

void QQuickFileDialog::accept ( )
overrideprotectedvirtual

\qmlmethod void QtQuick.Dialogs::Dialog::accept()

Closes the dialog and emits the \l accepted() signal.

See also
reject()

Reimplemented from QQuickAbstractDialog.

Definition at line 590 of file qquickfiledialog.cpp.

◆ acceptLabel()

QString QQuickFileDialog::acceptLabel ( ) const

\qmlproperty string QtQuick.Dialogs::FileDialog::acceptLabel

This property holds the label text shown on the button that accepts the dialog.

When set to an empty string, the default label of the underlying platform is used. The default label is typically \uicontrol Open or \uicontrol Save depending on which \l fileMode the dialog is used in.

The default value is an empty string.

See also
rejectLabel

Definition at line 448 of file qquickfiledialog.cpp.

◆ acceptLabelChanged

void QQuickFileDialog::acceptLabelChanged ( )
signal

◆ currentFile()

QUrl QQuickFileDialog::currentFile ( ) const

\qmlproperty url QtQuick.Dialogs::FileDialog::currentFile

Deprecated
[6.3] Use \l selectedFile instead.

This property holds the currently selected file in the dialog.

See also
selectedFile, currentFiles, currentFolder
Deprecated
[6.3] Use \l selectedFile instead.

This property holds the currently selected file in the dialog.

See also
selectedFile, currentFiles, currentFolder

Definition at line 199 of file qquickfiledialog.cpp.

◆ currentFileChanged

void QQuickFileDialog::currentFileChanged ( )
signal

◆ currentFiles()

QList< QUrl > QQuickFileDialog::currentFiles ( ) const

\qmlproperty list<url> QtQuick.Dialogs::FileDialog::currentFiles

Deprecated
[6.3] Use \l selectedFiles instead.

This property holds the currently selected files in the dialog.

See also
selectedFiles, currentFile, currentFolder
Deprecated
[6.3] Use \l selectedFiles instead.

This property holds the currently selected files in the dialog.

See also
selectedFiles, currentFile, currentFolder

Definition at line 217 of file qquickfiledialog.cpp.

◆ currentFilesChanged

void QQuickFileDialog::currentFilesChanged ( )
signal

◆ currentFolder()

QUrl QQuickFileDialog::currentFolder ( ) const

\qmlproperty url QtQuick.Dialogs::FileDialog::currentFolder

This property holds the folder where files are selected. It can be set to control the initial directory that is shown when the dialog is opened.

For selecting a folder, use \l FolderDialog instead.

Definition at line 235 of file qquickfiledialog.cpp.

◆ currentFolderChanged

void QQuickFileDialog::currentFolderChanged ( )
signal

◆ defaultSuffix()

QString QQuickFileDialog::defaultSuffix ( ) const

\qmlproperty string QtQuick.Dialogs::FileDialog::defaultSuffix

This property holds a suffix that is added to selected files that have no suffix specified. The suffix is typically used to indicate the file type (e.g. "txt" indicates a text file).

If the first character is a dot ('.'), it is removed.

Definition at line 416 of file qquickfiledialog.cpp.

◆ defaultSuffixChanged

void QQuickFileDialog::defaultSuffixChanged ( )
signal

◆ fileMode()

QQuickFileDialog::FileMode QQuickFileDialog::fileMode ( ) const

\qmlproperty enumeration QtQuick.Dialogs::FileDialog::fileMode

This property holds the mode of the dialog.

Available values: \value FileDialog.OpenFile The dialog is used to select an existing file (default). \value FileDialog.OpenFiles The dialog is used to select multiple existing files. \value FileDialog.SaveFile The dialog is used to select any file. The file does not have to exist.

Definition at line 82 of file qquickfiledialog.cpp.

◆ fileModeChanged

void QQuickFileDialog::fileModeChanged ( )
signal

◆ nameFilters()

QStringList QQuickFileDialog::nameFilters ( ) const

\qmlproperty list<string> QtQuick.Dialogs::FileDialog::nameFilters

This property holds the filters that restrict the types of files that can be selected.

nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
}

Different platforms may restrict the files that can be selected in different ways. For example, macOS will disable file entries that do not match the filters, whereas Windows will hide them.

Note
{.} is not a portable filter, because the historical assumption that the file extension determines the file type is not consistent on every operating system. It is possible to have a file with no dot in its name (for example, Makefile). In a native Windows file dialog, {.} will match such files, while in other types of file dialogs it may not. So it is better to use {*} if you mean to select any file.
See also
selectedNameFilter

Definition at line 318 of file qquickfiledialog.cpp.

◆ nameFiltersChanged

void QQuickFileDialog::nameFiltersChanged ( )
signal

◆ onCreate()

void QQuickFileDialog::onCreate ( QPlatformDialogHelper * dialog)
overrideprotectedvirtual

Called at the end of \l create().

Reimplemented from QQuickAbstractDialog.

Definition at line 511 of file qquickfiledialog.cpp.

◆ onHide()

void QQuickFileDialog::onHide ( QPlatformDialogHelper * dialog)
overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 567 of file qquickfiledialog.cpp.

◆ onShow()

void QQuickFileDialog::onShow ( QPlatformDialogHelper * dialog)
overrideprotectedvirtual

Called by \l open(), after the call to \l create() and before the handle/helper's show function is called.

Reimplemented from QQuickAbstractDialog.

Definition at line 530 of file qquickfiledialog.cpp.

◆ options()

QFileDialogOptions::FileDialogOptions QQuickFileDialog::options ( ) const

\qmlproperty flags QtQuick.Dialogs::FileDialog::options

This property holds the various options that affect the look and feel of the dialog.

By default, all options are disabled.

Options should be set before showing the dialog. Setting them while the dialog is visible is not guaranteed to have an immediate effect on the dialog (depending on the option and on the platform).

Available options: \value FileDialog.DontResolveSymlinks Don't resolve symlinks in the file dialog. By default symlinks are resolved. \value FileDialog.DontConfirmOverwrite Don't ask for confirmation if an existing file is selected. By default confirmation is requested. \value FileDialog.ReadOnly Indicates that the dialog doesn't allow creating directories. \value FileDialog.HideNameFilterDetails Indicates if the file name filter details are hidden or not. \value FileDialog.DontUseNativeDialog Forces the dialog to use a non-native quick implementation.

Definition at line 274 of file qquickfiledialog.cpp.

Referenced by testing.tools.test_runner._TestCaseRunner::_NewImageArtifact(), testing.tools.test_runner._TestCaseRunner::_RegenerateIfNeeded(), testing.tools.test_runner.TestRunner::IsSkiaGoldEnabled(), testing.tools.test_runner._TestCaseRunner::TestPixel(), and testing.tools.test_runner._TestCaseRunner::TestText().

Here is the caller graph for this function:

◆ optionsChanged

void QQuickFileDialog::optionsChanged ( )
signal

◆ rejectLabel()

QString QQuickFileDialog::rejectLabel ( ) const

\qmlproperty string QtQuick.Dialogs::FileDialog::rejectLabel

This property holds the label text shown on the button that rejects the dialog.

When set to an empty string, the default label of the underlying platform is used. The default label is typically \uicontrol Cancel.

The default value is an empty string.

See also
acceptLabel

Definition at line 479 of file qquickfiledialog.cpp.

◆ rejectLabelChanged

void QQuickFileDialog::rejectLabelChanged ( )
signal

◆ resetAcceptLabel()

void QQuickFileDialog::resetAcceptLabel ( )

Definition at line 462 of file qquickfiledialog.cpp.

◆ resetDefaultSuffix()

void QQuickFileDialog::resetDefaultSuffix ( )

Definition at line 430 of file qquickfiledialog.cpp.

◆ resetNameFilters()

void QQuickFileDialog::resetNameFilters ( )

Definition at line 340 of file qquickfiledialog.cpp.

◆ resetOptions()

void QQuickFileDialog::resetOptions ( )

Definition at line 288 of file qquickfiledialog.cpp.

◆ resetRejectLabel()

void QQuickFileDialog::resetRejectLabel ( )

Definition at line 493 of file qquickfiledialog.cpp.

◆ selectedFile()

QUrl QQuickFileDialog::selectedFile ( ) const

\qmlproperty url QtQuick.Dialogs::FileDialog::selectedFile

This property holds the last file that was selected in the dialog.

It can be set to control the file that is selected when the dialog is opened.

If there are multiple selected files, this property refers to the first file.

The value of this property is updated each time the user selects a file in the dialog, and when the dialog is accepted. Handle the \l {Dialog::}{accepted()} signal to get the final selection.

See also
selectedFiles, {Dialog::}{accepted()}, currentFolder

Definition at line 131 of file qquickfiledialog.cpp.

◆ selectedFileChanged

void QQuickFileDialog::selectedFileChanged ( )
signal

◆ selectedFiles()

QList< QUrl > QQuickFileDialog::selectedFiles ( ) const

\qmlproperty list<url> QtQuick.Dialogs::FileDialog::selectedFiles

This property holds the last files that were selected in the dialog.

The value of this property is updated each time the user selects files in the dialog, and when the dialog is accepted. Handle the \l {Dialog::}{accepted()} signal to get the final selection.

See also
{Dialog::}{accepted()}, currentFolder

Definition at line 152 of file qquickfiledialog.cpp.

◆ selectedFilesChanged

void QQuickFileDialog::selectedFilesChanged ( )
signal

◆ selectedNameFilter()

QQuickFileNameFilter * QQuickFileDialog::selectedNameFilter ( ) const

\qmlproperty int QtQuick.Dialogs::FileDialog::selectedNameFilter.index \qmlproperty string QtQuick.Dialogs::FileDialog::selectedNameFilter.name \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.extensions \qmlproperty list<string> QtQuick.Dialogs::FileDialog::selectedNameFilter.globs

These properties hold the currently selected name filter.

\table \header

  • Name
  • Description \row
  • index : int
  • This property determines which \l {nameFilters}{name filter} is selected. The specified filter is selected when the dialog is opened. The value is updated when the user selects another filter. \row
  • [read-only] name : string
  • This property holds the name of the selected filter. In the example below, the name of the first filter is {"Text files"} and the second is {"HTML files"}. \row
  • [read-only] extensions : list<string>
  • This property holds the list of extensions of the selected filter. In the example below, the list of extensions of the first filter is {["txt"]} and the second is {["html", "htm"]}. \row
  • [read-only] globs : list<string>
  • This property holds the list of globs of the selected filter. In the example below, the list of globs of the first filter is {["*.txt"]} and the second is {["*.html", "*.htm"]}.

This property is useful in conjunction with \l {FolderListModel}'s \l {FolderListModel::}{nameFilters} property, for example. \endtable

id: fileDialog
nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
}
MyDocument {
id: document
fileType: fileDialog.selectedNameFilter.extensions[0]
}
QQuickFileNameFilter * selectedNameFilter
GLenum GLuint id
static FileType fileType(const QFileInfo &fi)
See also
nameFilters

Definition at line 397 of file qquickfiledialog.cpp.

◆ setAcceptLabel()

void QQuickFileDialog::setAcceptLabel ( const QString & label)

Definition at line 453 of file qquickfiledialog.cpp.

◆ setCurrentFile()

void QQuickFileDialog::setCurrentFile ( const QUrl & file)

Definition at line 204 of file qquickfiledialog.cpp.

◆ setCurrentFiles()

void QQuickFileDialog::setCurrentFiles ( const QList< QUrl > & currentFiles)

Definition at line 222 of file qquickfiledialog.cpp.

◆ setCurrentFolder()

void QQuickFileDialog::setCurrentFolder ( const QUrl & currentFolder)

Definition at line 248 of file qquickfiledialog.cpp.

◆ setDefaultSuffix()

void QQuickFileDialog::setDefaultSuffix ( const QString & suffix)

Definition at line 421 of file qquickfiledialog.cpp.

◆ setFileMode()

void QQuickFileDialog::setFileMode ( FileMode fileMode)

Definition at line 87 of file qquickfiledialog.cpp.

◆ setNameFilters()

void QQuickFileDialog::setNameFilters ( const QStringList & filters)

Definition at line 323 of file qquickfiledialog.cpp.

◆ setOptions()

void QQuickFileDialog::setOptions ( QFileDialogOptions::FileDialogOptions options)

Definition at line 279 of file qquickfiledialog.cpp.

◆ setRejectLabel()

void QQuickFileDialog::setRejectLabel ( const QString & label)

Definition at line 484 of file qquickfiledialog.cpp.

◆ setSelectedFile()

void QQuickFileDialog::setSelectedFile ( const QUrl & selectedFile)

Definition at line 136 of file qquickfiledialog.cpp.

◆ useNativeDialog()

bool QQuickFileDialog::useNativeDialog ( ) const
overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 498 of file qquickfiledialog.cpp.

Property Documentation

◆ acceptLabel

QString QQuickFileDialog::acceptLabel
readwrite

Definition at line 41 of file qquickfiledialog_p.h.

◆ currentFile

QUrl QQuickFileDialog::currentFile
readwrite

Definition at line 34 of file qquickfiledialog_p.h.

◆ currentFiles

QList<QUrl> QQuickFileDialog::currentFiles
readwrite

Definition at line 35 of file qquickfiledialog_p.h.

◆ currentFolder

QUrl QQuickFileDialog::currentFolder
readwrite

Definition at line 36 of file qquickfiledialog_p.h.

◆ defaultSuffix

QString QQuickFileDialog::defaultSuffix
readwrite

Definition at line 40 of file qquickfiledialog_p.h.

◆ fileMode

FileMode QQuickFileDialog::fileMode
readwrite

Definition at line 31 of file qquickfiledialog_p.h.

◆ nameFilters

QStringList QQuickFileDialog::nameFilters
readwrite

Definition at line 38 of file qquickfiledialog_p.h.

◆ options

◆ rejectLabel

QString QQuickFileDialog::rejectLabel
readwrite

Definition at line 42 of file qquickfiledialog_p.h.

◆ selectedFile

QUrl QQuickFileDialog::selectedFile
readwrite

Definition at line 32 of file qquickfiledialog_p.h.

◆ selectedFiles

QList<QUrl> QQuickFileDialog::selectedFiles
read

Definition at line 33 of file qquickfiledialog_p.h.

◆ selectedNameFilter

QQuickFileNameFilter * QQuickFileDialog::selectedNameFilter
read

Definition at line 39 of file qquickfiledialog_p.h.


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