#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 ()

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< QUrl >	selectedFiles () const
	\qmlproperty list<url> QtQuick.Dialogs::FileDialog::selectedFiles

QUrl	currentFile () const
	\qmlproperty url QtQuick.Dialogs::FileDialog::currentFile

void	setCurrentFile (const QUrl &file)

QList< QUrl >	currentFiles () 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 ()

QQuickFileNameFilter *	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

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 ()

QPlatformDialogHelper *	handle () const

QQmlListProperty< QObject >	data ()

QWindow *	parentWindow () const
	\qmlproperty Window QtQuick.Dialogs::Dialog::parentWindow

void	setParentWindow (QWindow *window)

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)

StandardCode	result () const
	\qmlproperty StandardCode QtQuick.Dialogs::Dialog::result

void	setResult (StandardCode result)

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< QString >	bindableObjectName ()

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	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).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

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::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), 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 (const QString &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 >
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 QObjectList &	children () 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< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () 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 ()

virtual void	classBegin ()=0
	Invoked after class creation, but before any properties have been set.

virtual void	componentComplete ()=0
	Invoked after the root component that caused this instantiation has completed construction.

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 ()

void	destroy ()

virtual bool	useNativeDialog () const

virtual void	onCreate (QPlatformDialogHelper *dialog)

virtual void	onShow (QPlatformDialogHelper *dialog)

virtual void	onHide (QPlatformDialogHelper *dialog)

QWindow *	findParentWindow () const

Protected Member Functions inherited from QObject
QObject *	sender () 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< QUrl >	selectedFiles

QUrl	currentFile

QList< QUrl >	currentFiles

QUrl	currentFolder

QFileDialogOptions::FileDialogOptions	options

QStringList	nameFilters

QQuickFileNameFilter *	selectedNameFilter

QString	defaultSuffix

QString	acceptLabel

QString	rejectLabel

Properties inherited from QQuickAbstractDialog
QQmlListProperty< QObject >	data
	\qmldefault \qmlproperty list<QtObject> QtQuick.Dialogs::Dialog::data

QWindow *	parentWindow

QString	title

Qt::WindowFlags	flags

Qt::WindowModality	modality

bool	visible

StandardCode	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	accept ()
	\qmlmethod void QtQuick.Dialogs::Dialog::accept()

virtual void	reject ()
	\qmlmethod void QtQuick.Dialogs::Dialog::reject()

virtual void	done (StandardCode result)
	\qmlmethod void QtQuick.Dialogs::Dialog::done(StandardCode 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 Attributes inherited from QQuickAbstractDialog
bool	m_visibleRequested = false

bool	m_visible = false

bool	m_complete = false

bool	m_firstShow = true

StandardCode	m_result = Rejected

QWindow *	m_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< QPlatformDialogHelper >	m_handle

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 27 of file qquickfiledialog_p.h.

Member Enumeration Documentation

◆ FileMode

enum QQuickFileDialog::FileMode

Enumerator
OpenFile
OpenFiles
SaveFile

Definition at line 50 of file qquickfiledialog_p.h.

Constructor & Destructor Documentation

◆ QQuickFileDialog()

QQuickFileDialog::QQuickFileDialog ( QObject * parent = nullptr )

explicit

A file dialog.

\qmltype FileDialog
\inherits Dialog

! \instantiates QQuickFileDialog \inqmlmodule QtQuick.Dialogs

Since: 6.2

The FileDialog type provides a QML API for file dialogs.

To show a file dialog, construct an instance of FileDialog, set the desired properties, and call \l {Dialog::}{open()}. The \l currentFile or \l currentFiles properties can be used to determine the currently selected file(s) in the dialog. The \l selectedFile and \l selectedFiles properties are updated only after the final selection has been made by accepting the dialog.

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 58 of file qquickfiledialog.cpp.

References QFileDialogOptions::AcceptOpen, QFileDialogOptions::ExistingFile, m_options, QFileDialogOptions::setAcceptMode(), and QFileDialogOptions::setFileMode().

Here is the call graph for this function:

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 581 of file qquickfiledialog.cpp.

References QQuickAbstractDialog::accept(), and QQuickAbstractDialog::handle().

Here is the call graph for this function:

◆ 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 444 of file qquickfiledialog.cpp.

References QFileDialogOptions::Accept, and QFileDialogOptions::labelText().

Here is the call graph for this function:

◆ acceptLabelChanged

void QQuickFileDialog::acceptLabelChanged ( )

signal

Referenced by setAcceptLabel().

Here is the caller graph for this function:

◆ 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

Definition at line 195 of file qquickfiledialog.cpp.

References selectedFile.

◆ 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

Definition at line 213 of file qquickfiledialog.cpp.

References selectedFiles.

◆ 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 231 of file qquickfiledialog.cpp.

References QDir::currentPath(), QUrl::fromLocalFile(), QQuickAbstractDialog::handle(), QFileDialogOptions::initialDirectory(), and QUrl::isValid().

Here is the call graph for this function:

◆ currentFolderChanged

void QQuickFileDialog::currentFolderChanged ( )

signal

Referenced by onCreate().

Here is the caller graph for this function:

◆ 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 412 of file qquickfiledialog.cpp.

References QFileDialogOptions::defaultSuffix().

Here is the call graph for this function:

◆ defaultSuffixChanged

void QQuickFileDialog::defaultSuffixChanged ( )

signal

Referenced by setDefaultSuffix().

Here is the caller graph for this function:

◆ 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 78 of file qquickfiledialog.cpp.

◆ fileModeChanged

void QQuickFileDialog::fileModeChanged ( )

signal

Referenced by setFileMode().

Here is the caller graph for this function:

◆ 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.

FileDialog {
    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 314 of file qquickfiledialog.cpp.

References QFileDialogOptions::nameFilters().

Here is the call graph for this function:

◆ nameFiltersChanged

void QQuickFileDialog::nameFiltersChanged ( )

signal

Referenced by setNameFilters().

Here is the caller graph for this function:

◆ onCreate()

void QQuickFileDialog::onCreate ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Called at the end of \l create().

Reimplemented from QQuickAbstractDialog.

Definition at line 507 of file qquickfiledialog.cpp.

References QObject::connect(), QPlatformFileDialogHelper::currentChanged(), currentFolderChanged(), dialog, QPlatformFileDialogHelper::directoryEntered(), QFileDialogOptions::initiallySelectedFiles(), QList< T >::isEmpty(), and selectedFiles.

Here is the call graph for this function:

◆ onHide()

void QQuickFileDialog::onHide ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 558 of file qquickfiledialog.cpp.

References dialog, disconnect(), QPlatformFileDialogHelper::filterSelected(), and QQuickFileNameFilter::update().

Here is the call graph for this function:

◆ 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 526 of file qquickfiledialog.cpp.

References QObject::connect(), dialog, QPlatformFileDialogHelper::filterSelected(), QList< T >::first(), QQuickFileNameFilter::index, QFileDialogOptions::initialDirectory(), QFileDialogOptions::initiallySelectedFiles(), QList< T >::isEmpty(), QUrl::isValid(), QQuickAbstractDialog::m_firstShow, QFileDialogOptions::nameFilters(), QQuickAbstractDialog::onShow(), selectedFile, selectedNameFilter, QFileDialogOptions::setInitiallySelectedNameFilter(), QFileDialogOptions::setWindowTitle(), QQuickAbstractDialog::title, QQuickFileNameFilter::update(), and QQmlFile::urlToLocalFileOrQrc().

Here is the call graph for this function:

◆ 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 270 of file qquickfiledialog.cpp.

References QFileDialogOptions::options().

Here is the call graph for this function:

◆ optionsChanged

void QQuickFileDialog::optionsChanged ( )

signal

Referenced by setOptions().

Here is the caller graph for this function:

◆ 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 475 of file qquickfiledialog.cpp.

References QFileDialogOptions::labelText(), and QFileDialogOptions::Reject.

Here is the call graph for this function:

◆ rejectLabelChanged

void QQuickFileDialog::rejectLabelChanged ( )

signal

Referenced by setRejectLabel().

Here is the caller graph for this function:

◆ resetAcceptLabel()

void QQuickFileDialog::resetAcceptLabel ( )

Definition at line 458 of file qquickfiledialog.cpp.

References setAcceptLabel().

Here is the call graph for this function:

◆ resetDefaultSuffix()

void QQuickFileDialog::resetDefaultSuffix ( )

Definition at line 426 of file qquickfiledialog.cpp.

References setDefaultSuffix().

Here is the call graph for this function:

◆ resetNameFilters()

void QQuickFileDialog::resetNameFilters ( )

Definition at line 336 of file qquickfiledialog.cpp.

References setNameFilters().

Here is the call graph for this function:

◆ resetOptions()

void QQuickFileDialog::resetOptions ( )

Definition at line 284 of file qquickfiledialog.cpp.

References setOptions().

Here is the call graph for this function:

◆ resetRejectLabel()

void QQuickFileDialog::resetRejectLabel ( )

Definition at line 489 of file qquickfiledialog.cpp.

References setRejectLabel().

Here is the call graph for this function:

◆ 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 127 of file qquickfiledialog.cpp.

References QList< T >::value().

Here is the call graph for this function:

◆ 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 148 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

FileDialog {
    id: fileDialog
    selectedNameFilter.index: 1
    nameFilters: ["Text files (*.txt)", "HTML files (*.html *.htm)"]
}
 
MyDocument {
    id: document
    fileType: fileDialog.selectedNameFilter.extensions[0]
}

See also: nameFilters

Definition at line 393 of file qquickfiledialog.cpp.

References QQuickFileNameFilter::setOptions().

Here is the call graph for this function:

◆ setAcceptLabel()

void QQuickFileDialog::setAcceptLabel ( const QString & label )

Definition at line 449 of file qquickfiledialog.cpp.

References QFileDialogOptions::Accept, acceptLabelChanged(), emit, QFileDialogOptions::labelText(), and QFileDialogOptions::setLabelText().

Referenced by resetAcceptLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentFile()

void QQuickFileDialog::setCurrentFile ( const QUrl & file )

Definition at line 200 of file qquickfiledialog.cpp.

References file.

◆ setCurrentFiles()

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

Definition at line 218 of file qquickfiledialog.cpp.

References currentFiles.

◆ setCurrentFolder()

void QQuickFileDialog::setCurrentFolder ( const QUrl & currentFolder )

Definition at line 244 of file qquickfiledialog.cpp.

References currentFolder, QQuickAbstractDialog::handle(), qCDebug, and QFileDialogOptions::setInitialDirectory().

Here is the call graph for this function:

◆ setDefaultSuffix()

void QQuickFileDialog::setDefaultSuffix ( const QString & suffix )

Definition at line 417 of file qquickfiledialog.cpp.

References QFileDialogOptions::defaultSuffix(), defaultSuffixChanged(), emit, and QFileDialogOptions::setDefaultSuffix().

Referenced by resetDefaultSuffix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFileMode()

void QQuickFileDialog::setFileMode ( FileMode fileMode )

Definition at line 83 of file qquickfiledialog.cpp.

References QFileDialogOptions::AcceptOpen, QFileDialogOptions::AcceptSave, QFileDialogOptions::AnyFile, emit, QFileDialogOptions::ExistingFile, QFileDialogOptions::ExistingFiles, fileModeChanged(), OpenFile, OpenFiles, qCDebug, SaveFile, QFileDialogOptions::setAcceptMode(), and QFileDialogOptions::setFileMode().

Here is the call graph for this function:

◆ setNameFilters()

void QQuickFileDialog::setNameFilters ( const QStringList & filters )

Definition at line 319 of file qquickfiledialog.cpp.

References emit, filters, QQuickFileNameFilter::index, QFileDialogOptions::nameFilters(), nameFiltersChanged(), qCDebug, QFileDialogOptions::setNameFilters(), and QQuickFileNameFilter::update().

Referenced by resetNameFilters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptions()

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

Definition at line 275 of file qquickfiledialog.cpp.

References emit, QFileDialogOptions::options(), options, optionsChanged(), and QFileDialogOptions::setOptions().

Referenced by resetOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRejectLabel()

void QQuickFileDialog::setRejectLabel ( const QString & label )

Definition at line 480 of file qquickfiledialog.cpp.

References emit, QFileDialogOptions::labelText(), QFileDialogOptions::Reject, rejectLabelChanged(), and QFileDialogOptions::setLabelText().

Referenced by resetRejectLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSelectedFile()

void QQuickFileDialog::setSelectedFile ( const QUrl & selectedFile )

Definition at line 132 of file qquickfiledialog.cpp.

References selectedFile.

◆ useNativeDialog()

bool QQuickFileDialog::useNativeDialog ( ) const

overrideprotectedvirtual

Reimplemented from QQuickAbstractDialog.

Definition at line 494 of file qquickfiledialog.cpp.

References QFileDialogOptions::DontUseNativeDialog, qCDebug, QFileDialogOptions::testOption(), and QQuickAbstractDialog::useNativeDialog().

Here is the call graph for this function:

Property Documentation

◆ acceptLabel

QString QQuickFileDialog::acceptLabel

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ currentFile

QUrl QQuickFileDialog::currentFile

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ currentFiles

QList<QUrl> QQuickFileDialog::currentFiles

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by setCurrentFiles().

◆ currentFolder

QUrl QQuickFileDialog::currentFolder

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by setCurrentFolder().

◆ defaultSuffix

QString QQuickFileDialog::defaultSuffix

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ fileMode

FileMode QQuickFileDialog::fileMode

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ nameFilters

QStringList QQuickFileDialog::nameFilters

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ options

QFileDialogOptions::FileDialogOptions QQuickFileDialog::options

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by setOptions().

◆ rejectLabel

QString QQuickFileDialog::rejectLabel

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

◆ selectedFile

QUrl QQuickFileDialog::selectedFile

readwrite

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by currentFile(), onShow(), and setSelectedFile().

◆ selectedFiles

QList<QUrl> QQuickFileDialog::selectedFiles

read

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by currentFiles(), and onCreate().

◆ selectedNameFilter

QQuickFileNameFilter * QQuickFileDialog::selectedNameFilter

read

Definition at line 128 of file qquickfiledialog_p.h.

Referenced by onShow().

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

qtdeclarative/src/quickdialogs/quickdialogs/qquickfiledialog_p.h
qtdeclarative/src/quickdialogs/quickdialogs/qquickfiledialog.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FileMode

Constructor & Destructor Documentation

◆ QQuickFileDialog()

Member Function Documentation

◆ accept()

◆ acceptLabel()

◆ acceptLabelChanged

◆ currentFile()

◆ currentFileChanged

◆ currentFiles()

◆ currentFilesChanged

◆ currentFolder()

◆ currentFolderChanged

◆ defaultSuffix()

◆ defaultSuffixChanged

◆ fileMode()

◆ fileModeChanged

◆ nameFilters()

◆ nameFiltersChanged

◆ onCreate()

◆ onHide()

◆ onShow()

◆ options()

◆ optionsChanged

◆ rejectLabel()

◆ rejectLabelChanged

◆ resetAcceptLabel()

◆ resetDefaultSuffix()

◆ resetNameFilters()

◆ resetOptions()

◆ resetRejectLabel()

◆ selectedFile()

◆ selectedFileChanged

◆ selectedFiles()

◆ selectedFilesChanged

◆ selectedNameFilter()

◆ setAcceptLabel()

◆ setCurrentFile()

◆ setCurrentFiles()

◆ setCurrentFolder()

◆ setDefaultSuffix()

◆ setFileMode()

◆ setNameFilters()

◆ setOptions()

◆ setRejectLabel()

◆ setSelectedFile()

◆ useNativeDialog()

Property Documentation

◆ acceptLabel

◆ currentFile

◆ currentFiles

◆ currentFolder

◆ defaultSuffix

◆ fileMode

◆ nameFilters

◆ options

◆ rejectLabel

◆ selectedFile

◆ selectedFiles

◆ selectedNameFilter