#include <qquicklabsplatformfiledialog_p.h>

Inheritance diagram for QQuickLabsPlatformFileDialog:

Collaboration diagram for QQuickLabsPlatformFileDialog:

Public Types
enum	FileMode { OpenFile , OpenFiles , SaveFile }

Public Types inherited from QQuickLabsPlatformDialog
enum	StandardCode { Rejected , Accepted }

Signals
void	fileModeChanged ()

void	fileChanged ()

void	filesChanged ()

void	currentFileChanged ()

void	currentFilesChanged ()

void	folderChanged ()

void	optionsChanged ()

void	nameFiltersChanged ()

void	defaultSuffixChanged ()

void	acceptLabelChanged ()

void	rejectLabelChanged ()

Signals inherited from QQuickLabsPlatformDialog
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
	QQuickLabsPlatformFileDialog (QObject *parent=nullptr)
	A native file dialog.

FileMode	fileMode () const
	\qmlproperty enumeration Qt.labs.platform::FileDialog::fileMode

void	setFileMode (FileMode fileMode)

QUrl	file () const
	\qmlproperty url Qt.labs.platform::FileDialog::file

void	setFile (const QUrl &file)

QList< QUrl >	files () const
	\qmlproperty list<url> Qt.labs.platform::FileDialog::files

void	setFiles (const QList< QUrl > &files)

QUrl	currentFile () const
	\qmlproperty url Qt.labs.platform::FileDialog::currentFile

void	setCurrentFile (const QUrl &file)

QList< QUrl >	currentFiles () const
	\qmlproperty list<url> Qt.labs.platform::FileDialog::currentFiles

void	setCurrentFiles (const QList< QUrl > &files)

QUrl	folder () const
	\qmlproperty url Qt.labs.platform::FileDialog::folder

void	setFolder (const QUrl &folder)

QFileDialogOptions::FileDialogOptions	options () const
	\qmlproperty flags Qt.labs.platform::FileDialog::options

void	setOptions (QFileDialogOptions::FileDialogOptions options)

void	resetOptions ()

QStringList	nameFilters () const
	\qmlproperty list<string> Qt.labs.platform::FileDialog::nameFilters

void	setNameFilters (const QStringList &filters)

void	resetNameFilters ()

QQuickLabsPlatformFileNameFilter *	selectedNameFilter () const
	\qmlproperty int Qt.labs.platform::FileDialog::selectedNameFilter.index \qmlproperty string Qt.labs.platform::FileDialog::selectedNameFilter.name \qmlproperty list<string> Qt.labs.platform::FileDialog::selectedNameFilter.extensions

QString	defaultSuffix () const
	\qmlproperty string Qt.labs.platform::FileDialog::defaultSuffix

void	setDefaultSuffix (const QString &suffix)

void	resetDefaultSuffix ()

QString	acceptLabel () const
	\qmlproperty string Qt.labs.platform::FileDialog::acceptLabel

void	setAcceptLabel (const QString &label)

void	resetAcceptLabel ()

QString	rejectLabel () const
	\qmlproperty string Qt.labs.platform::FileDialog::rejectLabel

void	setRejectLabel (const QString &label)

void	resetRejectLabel ()

Public Member Functions inherited from QQuickLabsPlatformDialog
	QQuickLabsPlatformDialog (QPlatformTheme::DialogType type, QObject *parent=nullptr)
	The base class of native dialogs.

	~QQuickLabsPlatformDialog ()

QPlatformDialogHelper *	handle () const

QQmlListProperty< QObject >	data ()

QWindow *	parentWindow () const
	\qmlproperty Window Qt.labs.platform::Dialog::parentWindow

void	setParentWindow (QWindow *window)

QString	title () const
	\qmlproperty string Qt.labs.platform::Dialog::title

void	setTitle (const QString &title)

Qt::WindowFlags	flags () const
	\qmlproperty Qt::WindowFlags Qt.labs.platform::Dialog::flags

void	setFlags (Qt::WindowFlags flags)

Qt::WindowModality	modality () const
	\qmlproperty Qt::WindowModality Qt.labs.platform::Dialog::modality

void	setModality (Qt::WindowModality modality)

bool	isVisible () const
	\qmlproperty bool Qt.labs.platform::Dialog::visible

void	setVisible (bool visible)

int	result () const
	\qmlproperty int Qt.labs.platform::Dialog::result

void	setResult (int 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 Qt.labs.platform::Dialog::accept()

Protected Member Functions inherited from QQuickLabsPlatformDialog
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	file

QList< QUrl >	files

QUrl	currentFile

QList< QUrl >	currentFiles

QUrl	folder

QFileDialogOptions::FileDialogOptions	options

QStringList	nameFilters

QQuickLabsPlatformFileNameFilter *	selectedNameFilter

QString	defaultSuffix

QString	acceptLabel

QString	rejectLabel

Properties inherited from QQuickLabsPlatformDialog
QQmlListProperty< QObject >	data
	\qmldefault \qmlproperty list<QtObject> Qt.labs.platform::Dialog::data

QWindow *	parentWindow

QString	title

Qt::WindowFlags	flags

Qt::WindowModality	modality

bool	visible

int	result

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QQuickLabsPlatformDialog
void	open ()
	\qmlmethod void Qt.labs.platform::Dialog::open()

void	close ()
	\qmlmethod void Qt.labs.platform::Dialog::close()

virtual void	accept ()
	\qmlmethod void Qt.labs.platform::Dialog::accept()

virtual void	reject ()
	\qmlmethod void Qt.labs.platform::Dialog::reject()

virtual void	done (int result)
	\qmlmethod void Qt.labs.platform::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 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 26 of file qquicklabsplatformfiledialog_p.h.

Member Enumeration Documentation

◆ FileMode

enum QQuickLabsPlatformFileDialog::FileMode

Enumerator
OpenFile
OpenFiles
SaveFile

Definition at line 47 of file qquicklabsplatformfiledialog_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformFileDialog()

QQuickLabsPlatformFileDialog::QQuickLabsPlatformFileDialog ( QObject * parent = nullptr )

explicit

A native file dialog.

\qmltype FileDialog
\inherits Dialog

! \instantiates QQuickLabsPlatformFileDialog \inqmlmodule Qt.labs.platform

Since: 5.8

The FileDialog type provides a QML API for native platform 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 file and \l files properties are updated only after the final selection has been made by accepting the dialog.

MenuItem {
    text: "Open..."
    onTriggered: fileDialog.open()
}
 
FileDialog {
    id: fileDialog
    currentFile: document.source
    folder: StandardPaths.writableLocation(StandardPaths.DocumentsLocation)
}
 
MyDocument {
    id: document
    source: fileDialog.file
}

Definition at line 68 of file qquicklabsplatformfiledialog.cpp.

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

Here is the call graph for this function:

Member Function Documentation

◆ accept()

void QQuickLabsPlatformFileDialog::accept ( )

overrideprotectedvirtual

\qmlmethod void Qt.labs.platform::Dialog::accept()

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

See also: reject()

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 512 of file qquicklabsplatformfiledialog.cpp.

References QQuickLabsPlatformDialog::accept(), QQuickLabsPlatformDialog::handle(), and setFiles().

Here is the call graph for this function:

◆ acceptLabel()

QString QQuickLabsPlatformFileDialog::acceptLabel ( ) const

\qmlproperty string Qt.labs.platform::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 418 of file qquicklabsplatformfiledialog.cpp.

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

Here is the call graph for this function:

◆ acceptLabelChanged

void QQuickLabsPlatformFileDialog::acceptLabelChanged ( )

signal

Referenced by setAcceptLabel().

Here is the caller graph for this function:

◆ currentFile()

QUrl QQuickLabsPlatformFileDialog::currentFile ( ) const

\qmlproperty url Qt.labs.platform::FileDialog::currentFile

This property holds the currently selected file in the dialog.

Unlike the \l file property, the currentFile property is updated while the user is selecting files in the dialog, even before the final selection has been made.

See also: file, currentFiles

Definition at line 183 of file qquicklabsplatformfiledialog.cpp.

References currentFiles, and QList< T >::value().

Here is the call graph for this function:

◆ currentFileChanged

void QQuickLabsPlatformFileDialog::currentFileChanged ( )

signal

Referenced by onCreate().

Here is the caller graph for this function:

◆ currentFiles()

QList< QUrl > QQuickLabsPlatformFileDialog::currentFiles ( ) const

\qmlproperty list<url> Qt.labs.platform::FileDialog::currentFiles

This property holds the currently selected files in the dialog.

Unlike the \l files property, the currentFiles property is updated while the user is selecting files in the dialog, even before the final selection has been made.

See also: files, currentFile

Definition at line 204 of file qquicklabsplatformfiledialog.cpp.

References QQuickLabsPlatformDialog::handle(), and QFileDialogOptions::initiallySelectedFiles().

Here is the call graph for this function:

◆ currentFilesChanged

void QQuickLabsPlatformFileDialog::currentFilesChanged ( )

signal

Referenced by onCreate().

Here is the caller graph for this function:

◆ defaultSuffix()

QString QQuickLabsPlatformFileDialog::defaultSuffix ( ) const

\qmlproperty string Qt.labs.platform::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 386 of file qquicklabsplatformfiledialog.cpp.

References QFileDialogOptions::defaultSuffix().

Here is the call graph for this function:

◆ defaultSuffixChanged

void QQuickLabsPlatformFileDialog::defaultSuffixChanged ( )

signal

Referenced by setDefaultSuffix().

Here is the caller graph for this function:

◆ file()

QUrl QQuickLabsPlatformFileDialog::file ( ) const

\qmlproperty url Qt.labs.platform::FileDialog::file

This property holds the final accepted file.

Unlike the \l currentFile property, the file property is not updated while the user is selecting files in the dialog, but only after the final selection has been made. That is, when the user has clicked \uicontrol OK to accept a file. Alternatively, the \l {Dialog::}{accepted()} signal can be handled to get the final selection.

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

Definition at line 132 of file qquicklabsplatformfiledialog.cpp.

References QList< T >::value().

Here is the call graph for this function:

◆ fileChanged

void QQuickLabsPlatformFileDialog::fileChanged ( )

signal

Referenced by setFiles().

Here is the caller graph for this function:

◆ fileMode()

QQuickLabsPlatformFileDialog::FileMode QQuickLabsPlatformFileDialog::fileMode ( ) const

\qmlproperty enumeration Qt.labs.platform::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 88 of file qquicklabsplatformfiledialog.cpp.

◆ fileModeChanged

void QQuickLabsPlatformFileDialog::fileModeChanged ( )

signal

Referenced by setFileMode().

Here is the caller graph for this function:

◆ files()

QList< QUrl > QQuickLabsPlatformFileDialog::files ( ) const

\qmlproperty list<url> Qt.labs.platform::FileDialog::files

This property holds the final accepted files.

Unlike the \l currentFiles property, the files property is not updated while the user is selecting files in the dialog, but only after the final selection has been made. That is, when the user has clicked \uicontrol OK to accept files. Alternatively, the \l {Dialog::}{accepted()} signal can be handled to get the final selection.

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

Definition at line 155 of file qquicklabsplatformfiledialog.cpp.

◆ filesChanged

void QQuickLabsPlatformFileDialog::filesChanged ( )

signal

Referenced by setFiles().

Here is the caller graph for this function:

◆ folder()

QUrl QQuickLabsPlatformFileDialog::folder ( ) const

\qmlproperty url Qt.labs.platform::FileDialog::folder

This property holds the folder where files are selected. For selecting a folder, use FolderDialog instead.

See also: FolderDialog

Definition at line 228 of file qquicklabsplatformfiledialog.cpp.

References QQuickLabsPlatformDialog::handle(), and QFileDialogOptions::initialDirectory().

Here is the call graph for this function:

◆ folderChanged

void QQuickLabsPlatformFileDialog::folderChanged ( )

signal

Referenced by onCreate().

Here is the caller graph for this function:

◆ nameFilters()

QStringList QQuickLabsPlatformFileDialog::nameFilters ( ) const

\qmlproperty list<string> Qt.labs.platform::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)"]
}

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 299 of file qquicklabsplatformfiledialog.cpp.

References QFileDialogOptions::nameFilters().

Here is the call graph for this function:

◆ nameFiltersChanged

void QQuickLabsPlatformFileDialog::nameFiltersChanged ( )

signal

Referenced by setNameFilters().

Here is the caller graph for this function:

◆ onCreate()

void QQuickLabsPlatformFileDialog::onCreate ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 474 of file qquicklabsplatformfiledialog.cpp.

References QObject::connect(), QPlatformFileDialogHelper::currentChanged(), currentFileChanged(), currentFilesChanged(), dialog, QPlatformFileDialogHelper::directoryEntered(), and folderChanged().

Here is the call graph for this function:

◆ onHide()

void QQuickLabsPlatformFileDialog::onHide ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 504 of file qquicklabsplatformfiledialog.cpp.

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

Here is the call graph for this function:

◆ onShow()

void QQuickLabsPlatformFileDialog::onShow ( QPlatformDialogHelper * dialog )

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 485 of file qquicklabsplatformfiledialog.cpp.

References QObject::connect(), dialog, QPlatformFileDialogHelper::filterSelected(), QQuickLabsPlatformFileNameFilter::index, QFileDialogOptions::initialDirectory(), QUrl::isValid(), QFileDialogOptions::nameFilters(), QFileDialogOptions::setInitiallySelectedNameFilter(), QFileDialogOptions::setWindowTitle(), QQuickLabsPlatformDialog::title, and QQuickLabsPlatformFileNameFilter::update().

Here is the call graph for this function:

◆ options()

QFileDialogOptions::FileDialogOptions QQuickLabsPlatformFileDialog::options ( ) const

\qmlproperty flags Qt.labs.platform::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.

Definition at line 259 of file qquicklabsplatformfiledialog.cpp.

References QFileDialogOptions::options().

Here is the call graph for this function:

◆ optionsChanged

void QQuickLabsPlatformFileDialog::optionsChanged ( )

signal

Referenced by setOptions().

Here is the caller graph for this function:

◆ rejectLabel()

QString QQuickLabsPlatformFileDialog::rejectLabel ( ) const

\qmlproperty string Qt.labs.platform::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 449 of file qquicklabsplatformfiledialog.cpp.

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

Here is the call graph for this function:

◆ rejectLabelChanged

void QQuickLabsPlatformFileDialog::rejectLabelChanged ( )

signal

Referenced by setRejectLabel().

Here is the caller graph for this function:

◆ resetAcceptLabel()

void QQuickLabsPlatformFileDialog::resetAcceptLabel ( )

Definition at line 432 of file qquicklabsplatformfiledialog.cpp.

References setAcceptLabel().

Here is the call graph for this function:

◆ resetDefaultSuffix()

void QQuickLabsPlatformFileDialog::resetDefaultSuffix ( )

Definition at line 400 of file qquicklabsplatformfiledialog.cpp.

References setDefaultSuffix().

Here is the call graph for this function:

◆ resetNameFilters()

void QQuickLabsPlatformFileDialog::resetNameFilters ( )

Definition at line 319 of file qquicklabsplatformfiledialog.cpp.

References setNameFilters().

Here is the call graph for this function:

◆ resetOptions()

void QQuickLabsPlatformFileDialog::resetOptions ( )

Definition at line 273 of file qquicklabsplatformfiledialog.cpp.

References setOptions().

Here is the call graph for this function:

◆ resetRejectLabel()

void QQuickLabsPlatformFileDialog::resetRejectLabel ( )

Definition at line 463 of file qquicklabsplatformfiledialog.cpp.

References setRejectLabel().

Here is the call graph for this function:

◆ selectedNameFilter()

QQuickLabsPlatformFileNameFilter * QQuickLabsPlatformFileDialog::selectedNameFilter ( ) const

\qmlproperty int Qt.labs.platform::FileDialog::selectedNameFilter.index \qmlproperty string Qt.labs.platform::FileDialog::selectedNameFilter.name \qmlproperty list<string> Qt.labs.platform::FileDialog::selectedNameFilter.extensions

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"]}. \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 367 of file qquicklabsplatformfiledialog.cpp.

References QQuickLabsPlatformFileNameFilter::setOptions().

Here is the call graph for this function:

◆ setAcceptLabel()

void QQuickLabsPlatformFileDialog::setAcceptLabel ( const QString & label )

Definition at line 423 of file qquicklabsplatformfiledialog.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 QQuickLabsPlatformFileDialog::setCurrentFile ( const QUrl & file )

Definition at line 188 of file qquicklabsplatformfiledialog.cpp.

References file, and setCurrentFiles().

Here is the call graph for this function:

◆ setCurrentFiles()

void QQuickLabsPlatformFileDialog::setCurrentFiles ( const QList< QUrl > & files )

Definition at line 211 of file qquicklabsplatformfiledialog.cpp.

References file, files, QQuickLabsPlatformDialog::handle(), and QFileDialogOptions::setInitiallySelectedFiles().

Referenced by setCurrentFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultSuffix()

void QQuickLabsPlatformFileDialog::setDefaultSuffix ( const QString & suffix )

Definition at line 391 of file qquicklabsplatformfiledialog.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:

◆ setFile()

void QQuickLabsPlatformFileDialog::setFile ( const QUrl & file )

Definition at line 137 of file qquicklabsplatformfiledialog.cpp.

References file, and setFiles().

Here is the call graph for this function:

◆ setFileMode()

void QQuickLabsPlatformFileDialog::setFileMode ( FileMode fileMode )

Definition at line 93 of file qquicklabsplatformfiledialog.cpp.

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

Here is the call graph for this function:

◆ setFiles()

void QQuickLabsPlatformFileDialog::setFiles ( const QList< QUrl > & files )

Definition at line 160 of file qquicklabsplatformfiledialog.cpp.

References emit, fileChanged(), files, filesChanged(), and QList< T >::value().

Referenced by accept(), and setFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFolder()

void QQuickLabsPlatformFileDialog::setFolder ( const QUrl & folder )

Definition at line 235 of file qquicklabsplatformfiledialog.cpp.

References folder, QQuickLabsPlatformDialog::handle(), and QFileDialogOptions::setInitialDirectory().

Here is the call graph for this function:

◆ setNameFilters()

void QQuickLabsPlatformFileDialog::setNameFilters ( const QStringList & filters )

Definition at line 304 of file qquicklabsplatformfiledialog.cpp.

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

Referenced by resetNameFilters().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptions()

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

Definition at line 264 of file qquicklabsplatformfiledialog.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 QQuickLabsPlatformFileDialog::setRejectLabel ( const QString & label )

Definition at line 454 of file qquicklabsplatformfiledialog.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:

◆ useNativeDialog()

bool QQuickLabsPlatformFileDialog::useNativeDialog ( ) const

overrideprotectedvirtual

Reimplemented from QQuickLabsPlatformDialog.

Definition at line 468 of file qquicklabsplatformfiledialog.cpp.

References QFileDialogOptions::DontUseNativeDialog, QFileDialogOptions::testOption(), and QQuickLabsPlatformDialog::useNativeDialog().

Here is the call graph for this function:

Property Documentation

◆ acceptLabel

QString QQuickLabsPlatformFileDialog::acceptLabel

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ currentFile

QUrl QQuickLabsPlatformFileDialog::currentFile

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ currentFiles

QList<QUrl> QQuickLabsPlatformFileDialog::currentFiles

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

Referenced by currentFile().

◆ defaultSuffix

QString QQuickLabsPlatformFileDialog::defaultSuffix

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ file

QUrl QQuickLabsPlatformFileDialog::file

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

Referenced by setCurrentFile(), setCurrentFiles(), and setFile().

◆ fileMode

FileMode QQuickLabsPlatformFileDialog::fileMode

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ files

QList<QUrl> QQuickLabsPlatformFileDialog::files

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

Referenced by setCurrentFiles(), and setFiles().

◆ folder

QUrl QQuickLabsPlatformFileDialog::folder

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

Referenced by setFolder().

◆ nameFilters

QStringList QQuickLabsPlatformFileDialog::nameFilters

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ options

QFileDialogOptions::FileDialogOptions QQuickLabsPlatformFileDialog::options

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

Referenced by setOptions().

◆ rejectLabel

QString QQuickLabsPlatformFileDialog::rejectLabel

readwrite

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

◆ selectedNameFilter

QQuickLabsPlatformFileNameFilter * QQuickLabsPlatformFileDialog::selectedNameFilter

read

Definition at line 162 of file qquicklabsplatformfiledialog_p.h.

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

qtdeclarative/src/labs/platform/qquicklabsplatformfiledialog_p.h
qtdeclarative/src/labs/platform/qquicklabsplatformfiledialog.cpp

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FileMode

Constructor & Destructor Documentation

◆ QQuickLabsPlatformFileDialog()

Member Function Documentation

◆ accept()

◆ acceptLabel()

◆ acceptLabelChanged

◆ currentFile()

◆ currentFileChanged

◆ currentFiles()

◆ currentFilesChanged

◆ defaultSuffix()

◆ defaultSuffixChanged

◆ file()

◆ fileChanged

◆ fileMode()

◆ fileModeChanged

◆ files()

◆ filesChanged

◆ folder()

◆ folderChanged

◆ nameFilters()

◆ nameFiltersChanged

◆ onCreate()

◆ onHide()

◆ onShow()

◆ options()

◆ optionsChanged

◆ rejectLabel()

◆ rejectLabelChanged

◆ resetAcceptLabel()

◆ resetDefaultSuffix()

◆ resetNameFilters()

◆ resetOptions()

◆ resetRejectLabel()

◆ selectedNameFilter()

◆ setAcceptLabel()

◆ setCurrentFile()

◆ setCurrentFiles()

◆ setDefaultSuffix()

◆ setFile()

◆ setFileMode()

◆ setFiles()

◆ setFolder()

◆ setNameFilters()

◆ setOptions()

◆ setRejectLabel()

◆ useNativeDialog()

Property Documentation

◆ acceptLabel

◆ currentFile

◆ currentFiles

◆ defaultSuffix

◆ file

◆ fileMode

◆ files

◆ folder

◆ nameFilters

◆ options

◆ rejectLabel

◆ selectedNameFilter