Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QFileDialogOptions Class Reference

#include <qplatformdialoghelper.h>

+ Collaboration diagram for QFileDialogOptions:

Public Types

enum  ViewMode { Detail , List }
 
enum  FileMode {
  AnyFile , ExistingFile , Directory , ExistingFiles ,
  DirectoryOnly
}
 
enum  AcceptMode { AcceptOpen , AcceptSave }
 
enum  DialogLabel {
  LookIn , FileName , FileType , Accept ,
  Reject , DialogLabelCount
}
 
enum  FileDialogOption {
  ShowDirsOnly = 0x00000001 , DontResolveSymlinks = 0x00000002 , DontConfirmOverwrite = 0x00000004 , DontUseNativeDialog = 0x00000008 ,
  ReadOnly = 0x00000010 , HideNameFilterDetails = 0x00000020 , DontUseCustomDirectoryIcons = 0x00000040
}
 

Public Member Functions

QSharedPointer< QFileDialogOptionsclone () const
 
QString windowTitle () const
 
void setWindowTitle (const QString &)
 
void setOption (FileDialogOption option, bool on=true)
 
bool testOption (FileDialogOption option) const
 
void setOptions (FileDialogOptions options)
 
FileDialogOptions options () const
 
QDir::Filters filter () const
 
void setFilter (QDir::Filters filters)
 
void setViewMode (ViewMode mode)
 
ViewMode viewMode () const
 
void setFileMode (FileMode mode)
 
FileMode fileMode () const
 
void setAcceptMode (AcceptMode mode)
 
AcceptMode acceptMode () const
 
void setSidebarUrls (const QList< QUrl > &urls)
 
QList< QUrlsidebarUrls () const
 
bool useDefaultNameFilters () const
 
void setUseDefaultNameFilters (bool d)
 
void setNameFilters (const QStringList &filters)
 
QStringList nameFilters () const
 
void setMimeTypeFilters (const QStringList &filters)
 
QStringList mimeTypeFilters () const
 
void setDefaultSuffix (const QString &suffix)
 
QString defaultSuffix () const
 
void setHistory (const QStringList &paths)
 
QStringList history () const
 
void setLabelText (DialogLabel label, const QString &text)
 
QString labelText (DialogLabel label) const
 
bool isLabelExplicitlySet (DialogLabel label)
 
QUrl initialDirectory () const
 
void setInitialDirectory (const QUrl &)
 
QString initiallySelectedMimeTypeFilter () const
 
void setInitiallySelectedMimeTypeFilter (const QString &)
 
QString initiallySelectedNameFilter () const
 
void setInitiallySelectedNameFilter (const QString &)
 
QList< QUrlinitiallySelectedFiles () const
 
void setInitiallySelectedFiles (const QList< QUrl > &)
 
void setSupportedSchemes (const QStringList &schemes)
 
QStringList supportedSchemes () const
 

Static Public Member Functions

static QSharedPointer< QFileDialogOptionscreate ()
 
static QString defaultNameFilterString ()
 

Protected Member Functions

 QFileDialogOptions (QFileDialogOptionsPrivate *dd)
 
 ~QFileDialogOptions ()
 

Detailed Description

Definition at line 263 of file qplatformdialoghelper.h.

Member Enumeration Documentation

◆ AcceptMode

Enumerator
AcceptOpen 
AcceptSave 

Definition at line 278 of file qplatformdialoghelper.h.

◆ DialogLabel

Enumerator
LookIn 
FileName 
FileType 
Accept 
Reject 
DialogLabelCount 

Definition at line 281 of file qplatformdialoghelper.h.

◆ FileDialogOption

Enumerator
ShowDirsOnly 
DontResolveSymlinks 
DontConfirmOverwrite 
DontUseNativeDialog 
ReadOnly 
HideNameFilterDetails 
DontUseCustomDirectoryIcons 

Definition at line 285 of file qplatformdialoghelper.h.

◆ FileMode

Enumerator
AnyFile 
ExistingFile 
Directory 
ExistingFiles 
DirectoryOnly 

Definition at line 275 of file qplatformdialoghelper.h.

◆ ViewMode

Enumerator
Detail 
List 

Definition at line 272 of file qplatformdialoghelper.h.

Constructor & Destructor Documentation

◆ QFileDialogOptions()

QFileDialogOptions::QFileDialogOptions ( QFileDialogOptionsPrivate * dd)
protected

Definition at line 451 of file qplatformdialoghelper.cpp.

◆ ~QFileDialogOptions()

QFileDialogOptions::~QFileDialogOptions ( )
protected

Definition at line 456 of file qplatformdialoghelper.cpp.

Member Function Documentation

◆ acceptMode()

QFileDialogOptions::AcceptMode QFileDialogOptions::acceptMode ( ) const

Definition at line 546 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::acceptMode.

Referenced by QFileDialogPrivate::createWidgets(), QQuickFileDialogImpl::setOptions(), QQuickFolderDialogImpl::setOptions(), QWidgetPlatformFileDialog::show(), and QIOSFileDialog::show().

+ Here is the caller graph for this function:

◆ clone()

QSharedPointer< QFileDialogOptions > QFileDialogOptions::clone ( ) const

Definition at line 474 of file qplatformdialoghelper.cpp.

References QSharedPointer< T >::create().

+ Here is the call graph for this function:

◆ create()

QSharedPointer< QFileDialogOptions > QFileDialogOptions::create ( )
static

Definition at line 469 of file qplatformdialoghelper.cpp.

References QSharedPointer< T >::create().

+ Here is the call graph for this function:

◆ defaultNameFilterString()

QString QFileDialogOptions::defaultNameFilterString ( )
static
Since
5.6
Returns
The translated default name filter string (\gui{All Files (*)}).
See also
defaultNameFilters(), nameFilters()

Definition at line 600 of file qplatformdialoghelper.cpp.

References QCoreApplication::translate().

Referenced by nameFilters(), QFileDialogPrivate::retranslateStrings(), and setNameFilters().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ defaultSuffix()

QString QFileDialogOptions::defaultSuffix ( ) const

◆ fileMode()

QFileDialogOptions::FileMode QFileDialogOptions::fileMode ( ) const

Definition at line 536 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::fileMode.

Referenced by QFileDialogPrivate::createWidgets(), QWindowsXpNativeFileDialog::doExec(), QQuickFileDialogImpl::setOptions(), QQuickFolderDialogImpl::setOptions(), and QWidgetPlatformFileDialog::show().

+ Here is the caller graph for this function:

◆ filter()

QDir::Filters QFileDialogOptions::filter ( ) const

Definition at line 511 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::filters.

Referenced by QFileDialogPrivate::createWidgets(), setInitiallySelectedMimeTypeFilter(), and setInitiallySelectedNameFilter().

+ Here is the caller graph for this function:

◆ history()

QStringList QFileDialogOptions::history ( ) const

Definition at line 632 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::history.

Referenced by QFileDialogPrivate::createWidgets(), and QFileDialogPrivate::helperDone().

+ Here is the caller graph for this function:

◆ initialDirectory()

◆ initiallySelectedFiles()

QList< QUrl > QFileDialogOptions::initiallySelectedFiles ( ) const

◆ initiallySelectedMimeTypeFilter()

QString QFileDialogOptions::initiallySelectedMimeTypeFilter ( ) const

◆ initiallySelectedNameFilter()

QString QFileDialogOptions::initiallySelectedNameFilter ( ) const

Definition at line 673 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::initiallySelectedNameFilter.

Referenced by QFileDialogPrivate::createWidgets(), QFileDialogPrivate::helperPrepareShow(), QCocoaFileDialogHelper::selectedNameFilter(), and QQuickFileDialogImpl::setOptions().

+ Here is the caller graph for this function:

◆ isLabelExplicitlySet()

bool QFileDialogOptions::isLabelExplicitlySet ( DialogLabel label)

Definition at line 648 of file qplatformdialoghelper.cpp.

References DialogLabelCount, QString::isEmpty(), and QFileDialogOptionsPrivate::labels.

Referenced by QWidgetPlatformFileDialog::show(), QQuickPlatformFileDialog::show(), QQuickPlatformFolderDialog::show(), QFileDialogPrivate::updateCancelButtonText(), QFileDialogPrivate::updateFileNameLabel(), QFileDialogPrivate::updateFileTypeLabel(), QFileDialogPrivate::updateLookInLabel(), and QFileDialogPrivate::updateOkButtonText().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ labelText()

◆ mimeTypeFilters()

QStringList QFileDialogOptions::mimeTypeFilters ( ) const

Definition at line 610 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::mimeTypeFilters.

Referenced by QFileDialogPrivate::createWidgets().

+ Here is the caller graph for this function:

◆ nameFilters()

QStringList QFileDialogOptions::nameFilters ( ) const

◆ options()

◆ setAcceptMode()

void QFileDialogOptions::setAcceptMode ( QFileDialogOptions::AcceptMode mode)

◆ setDefaultSuffix()

void QFileDialogOptions::setDefaultSuffix ( const QString & suffix)

Definition at line 615 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::defaultSuffix, QString::remove(), QString::size(), and QString::startsWith().

Referenced by QQuickLabsPlatformFileDialog::setDefaultSuffix(), and QQuickFileDialog::setDefaultSuffix().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setFileMode()

void QFileDialogOptions::setFileMode ( QFileDialogOptions::FileMode mode)

◆ setFilter()

void QFileDialogOptions::setFilter ( QDir::Filters filters)

Definition at line 516 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::filters, and filters.

◆ setHistory()

void QFileDialogOptions::setHistory ( const QStringList & paths)

Definition at line 627 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::history.

Referenced by QFileDialogPrivate::helperPrepareShow().

+ Here is the caller graph for this function:

◆ setInitialDirectory()

void QFileDialogOptions::setInitialDirectory ( const QUrl & directory)

Definition at line 658 of file qplatformdialoghelper.cpp.

References directory, and QFileDialogOptionsPrivate::initialDirectory.

Referenced by QQuickFolderDialog::QQuickFolderDialog(), QQuickFileDialog::setCurrentFolder(), QQuickLabsPlatformFolderDialog::setCurrentFolder(), QQuickFolderDialog::setCurrentFolder(), and QQuickLabsPlatformFileDialog::setFolder().

+ Here is the caller graph for this function:

◆ setInitiallySelectedFiles()

void QFileDialogOptions::setInitiallySelectedFiles ( const QList< QUrl > & files)

Definition at line 688 of file qplatformdialoghelper.cpp.

References files, and QFileDialogOptionsPrivate::initiallySelectedFiles.

Referenced by QFileDialogPrivate::helperPrepareShow(), and QQuickLabsPlatformFileDialog::setCurrentFiles().

+ Here is the caller graph for this function:

◆ setInitiallySelectedMimeTypeFilter()

void QFileDialogOptions::setInitiallySelectedMimeTypeFilter ( const QString & filter)

Definition at line 668 of file qplatformdialoghelper.cpp.

References filter(), and QFileDialogOptionsPrivate::initiallySelectedMimeTypeFilter.

+ Here is the call graph for this function:

◆ setInitiallySelectedNameFilter()

void QFileDialogOptions::setInitiallySelectedNameFilter ( const QString & filter)

Definition at line 678 of file qplatformdialoghelper.cpp.

References filter(), and QFileDialogOptionsPrivate::initiallySelectedNameFilter.

Referenced by QFileDialogPrivate::helperPrepareShow(), QQuickLabsPlatformFileDialog::onShow(), QQuickFileDialog::onShow(), and QCocoaFileDialogHelper::selectNameFilter().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setLabelText()

◆ setMimeTypeFilters()

void QFileDialogOptions::setMimeTypeFilters ( const QStringList & filters)

◆ setNameFilters()

void QFileDialogOptions::setNameFilters ( const QStringList & filters)

Definition at line 580 of file qplatformdialoghelper.cpp.

References defaultNameFilterString(), filters, QFileDialogOptionsPrivate::nameFilters, and QFileDialogOptionsPrivate::useDefaultNameFilters.

Referenced by QQuickLabsPlatformFileDialog::setNameFilters(), QQuickFileDialog::setNameFilters(), and QFileDialogPrivate::useNameFilter().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setOption()

void QFileDialogOptions::setOption ( QFileDialogOptions::FileDialogOption option,
bool on = true )

Definition at line 489 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::options, and setOptions().

+ Here is the call graph for this function:

◆ setOptions()

void QFileDialogOptions::setOptions ( FileDialogOptions options)

Definition at line 500 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::options, and options().

Referenced by setOption(), QQuickLabsPlatformFileDialog::setOptions(), QQuickLabsPlatformFolderDialog::setOptions(), QQuickFileDialog::setOptions(), and QQuickFolderDialog::setOptions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSidebarUrls()

void QFileDialogOptions::setSidebarUrls ( const QList< QUrl > & urls)

Definition at line 551 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::sidebarUrls.

Referenced by QFileDialogPrivate::helperPrepareShow().

+ Here is the caller graph for this function:

◆ setSupportedSchemes()

void QFileDialogOptions::setSupportedSchemes ( const QStringList & schemes)

◆ setUseDefaultNameFilters()

void QFileDialogOptions::setUseDefaultNameFilters ( bool d)

◆ setViewMode()

void QFileDialogOptions::setViewMode ( QFileDialogOptions::ViewMode mode)

Definition at line 521 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::viewMode.

◆ setWindowTitle()

void QFileDialogOptions::setWindowTitle ( const QString & title)

Definition at line 484 of file qplatformdialoghelper.cpp.

References title, and QFileDialogOptionsPrivate::windowTitle.

Referenced by QFileDialogPrivate::helperPrepareShow(), QQuickLabsPlatformFileDialog::onShow(), QQuickLabsPlatformFolderDialog::onShow(), QQuickFileDialog::onShow(), and QQuickFolderDialog::onShow().

+ Here is the caller graph for this function:

◆ sidebarUrls()

QList< QUrl > QFileDialogOptions::sidebarUrls ( ) const

Definition at line 556 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::sidebarUrls.

Referenced by QFileDialogPrivate::createWidgets(), and QFileDialogPrivate::helperDone().

+ Here is the caller graph for this function:

◆ supportedSchemes()

QStringList QFileDialogOptions::supportedSchemes ( ) const

◆ testOption()

bool QFileDialogOptions::testOption ( QFileDialogOptions::FileDialogOption option) const

Definition at line 495 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::options.

Referenced by QQuickLabsPlatformFileDialog::useNativeDialog(), QQuickLabsPlatformFolderDialog::useNativeDialog(), QQuickFileDialog::useNativeDialog(), and QQuickFolderDialog::useNativeDialog().

+ Here is the caller graph for this function:

◆ useDefaultNameFilters()

bool QFileDialogOptions::useDefaultNameFilters ( ) const
Since
5.7

The bool property useDefaultNameFilters indicates that no name filters have been set or that they are equivalent to \gui{All Files (*)}. If it is true, the platform can choose to hide the filter combo box.

See also
defaultNameFilterString().

Definition at line 570 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::useDefaultNameFilters.

Referenced by QFileDialogPrivate::retranslateStrings().

+ Here is the caller graph for this function:

◆ viewMode()

QFileDialogOptions::ViewMode QFileDialogOptions::viewMode ( ) const

Definition at line 526 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::viewMode.

Referenced by QFileDialogPrivate::createWidgets(), and QFileDialogPrivate::helperDone().

+ Here is the caller graph for this function:

◆ windowTitle()

QString QFileDialogOptions::windowTitle ( ) const

Definition at line 479 of file qplatformdialoghelper.cpp.

References QFileDialogOptionsPrivate::windowTitle.

Referenced by QWidgetPlatformFileDialog::show(), QQuickPlatformFileDialog::show(), and QQuickPlatformFolderDialog::show().

+ Here is the caller graph for this function:

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