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
QWindowsFileDialogHelper Class Reference

Helper for native Windows file dialogs. More...

Inheritance diagram for QWindowsFileDialogHelper:
Collaboration diagram for QWindowsFileDialogHelper:

Public Member Functions

 QWindowsFileDialogHelper ()
bool supportsNonModalDialog (const QWindow *=nullptr) const override
bool defaultNameFilterDisables () const override
void setDirectory (const QUrl &directory) override
QUrl directory () const override
void selectFile (const QUrl &filename) override
QList< QUrlselectedFiles () const override
void setFilter () override
void selectNameFilter (const QString &filter) override
QString selectedNameFilter () const override
 QWindowsFileDialogHelper ()
bool supportsNonModalDialog (const QWindow *=nullptr) const override
bool defaultNameFilterDisables () const override
void setDirectory (const QUrl &directory) override
QUrl directory () const override
void selectFile (const QUrl &filename) override
QList< QUrlselectedFiles () const override
void setFilter () override
void selectNameFilter (const QString &filter) override
QString selectedNameFilter () const override
Public Member Functions inherited from QWindowsDialogHelperBase< QPlatformFileDialogHelper >
 ~QWindowsDialogHelperBase ()
void exec () override
bool show (Qt::WindowFlags windowFlags, Qt::WindowModality windowModality, QWindow *parent) override
void hide () override
Public Member Functions inherited from QPlatformFileDialogHelper
virtual void selectMimeTypeFilter (const QString &filter)
virtual QString selectedMimeTypeFilter () const
virtual bool isSupportedUrl (const QUrl &url) const
const QSharedPointer< QFileDialogOptions > & options () const
void setOptions (const QSharedPointer< QFileDialogOptions > &options)
Public Member Functions inherited from QPlatformDialogHelper
 QPlatformDialogHelper ()
 ~QPlatformDialogHelper ()
virtual QVariant styleHint (StyleHint hint) const
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.

Private Member Functions

QWindowsNativeDialogBasecreateNativeDialog () override
QWindowsNativeDialogBasecreateNativeDialog () override

Additional Inherited Members

Public Types inherited from QWindowsDialogHelperBase< QPlatformFileDialogHelper >
using QWindowsNativeDialogBasePtr
Public Types inherited from QPlatformDialogHelper
enum  StyleHint { DialogIsQtWindow }
 This enum type specifies platform-specific style hints. More...
enum  DialogCode { Rejected , Accepted }
enum  StandardButton {
  NoButton = 0x00000000 , Ok = 0x00000400 , Save = 0x00000800 , SaveAll = 0x00001000 ,
  Open = 0x00002000 , Yes = 0x00004000 , YesToAll = 0x00008000 , No = 0x00010000 ,
  NoToAll = 0x00020000 , Abort = 0x00040000 , Retry = 0x00080000 , Ignore = 0x00100000 ,
  Close = 0x00200000 , Cancel = 0x00400000 , Discard = 0x00800000 , Help = 0x01000000 ,
  Apply = 0x02000000 , Reset = 0x04000000 , RestoreDefaults = 0x08000000 , FirstButton = Ok ,
  LastButton = RestoreDefaults , LowestBit = 10 , HighestBit = 27
}
enum  ButtonRole {
  InvalidRole = -1 , AcceptRole , RejectRole , DestructiveRole ,
  ActionRole , HelpRole , YesRole , NoRole ,
  ResetRole , ApplyRole , NRoles , RoleMask = 0x0FFFFFFF ,
  AlternateRole = 0x10000000 , Stretch = 0x20000000 , Reverse = 0x40000000 , EOL = InvalidRole
}
enum  ButtonLayout {
  UnknownLayout = -1 , WinLayout , MacLayout , KdeLayout ,
  GnomeLayout , AndroidLayout
}
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QPlatformFileDialogHelper
void fileSelected (const QUrl &file)
void filesSelected (const QList< QUrl > &files)
void currentChanged (const QUrl &path)
void directoryEntered (const QUrl &directory)
void filterSelected (const QString &filter)
Signals inherited from QPlatformDialogHelper
void accept ()
void reject ()
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.
Static Public Member Functions inherited from QPlatformFileDialogHelper
static QStringList cleanFilterList (const QString &filter)
Static Public Member Functions inherited from QPlatformDialogHelper
static QVariant defaultStyleHint (QPlatformDialogHelper::StyleHint hint)
static const int * buttonLayout (Qt::Orientation orientation=Qt::Horizontal, ButtonLayout policy=UnknownLayout)
static ButtonRole buttonRole (StandardButton button)
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)
Static Public Attributes inherited from QPlatformFileDialogHelper
static const char filterRegExp []
Protected Member Functions inherited from QWindowsDialogHelperBase< QPlatformFileDialogHelper >
 QWindowsDialogHelperBase ()=default
QWindowsNativeDialogBasenativeDialog () const
bool hasNativeDialog () const
void timerEvent (QTimerEvent *) override
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 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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Helper for native Windows file dialogs.

For Qt 4 compatibility, do not create native non-modal dialogs on widgets, but only on QQuickWindows, which do not have a fallback.

Definition at line 1489 of file qwindowsdialoghelpers.cpp.

Constructor & Destructor Documentation

◆ QWindowsFileDialogHelper() [1/2]

QWindowsFileDialogHelper::QWindowsFileDialogHelper ( )
inline

Definition at line 1492 of file qwindowsdialoghelpers.cpp.

◆ QWindowsFileDialogHelper() [2/2]

QWindowsFileDialogHelper::QWindowsFileDialogHelper ( )
inline

Definition at line 1492 of file qwindowsdialoghelpers.cpp.

Member Function Documentation

◆ createNativeDialog() [1/2]

QWindowsNativeDialogBase * QWindowsFileDialogHelper::createNativeDialog ( )
overrideprivatevirtual

Implements QWindowsDialogHelperBase< QPlatformFileDialogHelper >.

Definition at line 1513 of file qwindowsdialoghelpers.cpp.

References QWindowsNativeFileDialogBase::updateDirectory(), and QWindowsNativeFileDialogBase::updateSelectedNameFilter().

Here is the call graph for this function:

◆ createNativeDialog() [2/2]

QWindowsNativeDialogBase * QWindowsFileDialogHelper::createNativeDialog ( )
overrideprivatevirtual

◆ defaultNameFilterDisables() [1/2]

bool QWindowsFileDialogHelper::defaultNameFilterDisables ( ) const
inlineoverridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1494 of file qwindowsdialoghelpers.cpp.

◆ defaultNameFilterDisables() [2/2]

bool QWindowsFileDialogHelper::defaultNameFilterDisables ( ) const
inlineoverridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1494 of file qwindowsdialoghelpers.cpp.

◆ directory() [1/2]

QUrl QWindowsFileDialogHelper::directory ( ) const
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1577 of file qwindowsdialoghelpers.cpp.

◆ directory() [2/2]

QUrl QWindowsFileDialogHelper::directory ( ) const
overridevirtual

◆ selectedFiles() [1/2]

QList< QUrl > QWindowsFileDialogHelper::selectedFiles ( ) const
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1590 of file qwindowsdialoghelpers.cpp.

◆ selectedFiles() [2/2]

QList< QUrl > QWindowsFileDialogHelper::selectedFiles ( ) const
overridevirtual

◆ selectedNameFilter() [1/2]

QString QWindowsFileDialogHelper::selectedNameFilter ( ) const
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1607 of file qwindowsdialoghelpers.cpp.

◆ selectedNameFilter() [2/2]

QString QWindowsFileDialogHelper::selectedNameFilter ( ) const
overridevirtual

◆ selectFile() [1/2]

void QWindowsFileDialogHelper::selectFile ( const QUrl & filename)
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1582 of file qwindowsdialoghelpers.cpp.

◆ selectFile() [2/2]

void QWindowsFileDialogHelper::selectFile ( const QUrl & filename)
overridevirtual

◆ selectNameFilter() [1/2]

void QWindowsFileDialogHelper::selectNameFilter ( const QString & filter)
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1600 of file qwindowsdialoghelpers.cpp.

References QWindowsNativeFileDialogBase::updateSelectedNameFilter().

Here is the call graph for this function:

◆ selectNameFilter() [2/2]

void QWindowsFileDialogHelper::selectNameFilter ( const QString & filter)
overridevirtual

◆ setDirectory() [1/2]

void QWindowsFileDialogHelper::setDirectory ( const QUrl & directory)
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1568 of file qwindowsdialoghelpers.cpp.

References QWindowsNativeFileDialogBase::updateDirectory().

Here is the call graph for this function:

◆ setDirectory() [2/2]

void QWindowsFileDialogHelper::setDirectory ( const QUrl & directory)
overridevirtual

◆ setFilter() [1/2]

void QWindowsFileDialogHelper::setFilter ( )
overridevirtual

Implements QPlatformFileDialogHelper.

Definition at line 1595 of file qwindowsdialoghelpers.cpp.

◆ setFilter() [2/2]

void QWindowsFileDialogHelper::setFilter ( )
overridevirtual

◆ supportsNonModalDialog() [1/2]

bool QWindowsFileDialogHelper::supportsNonModalDialog ( const QWindow * = nullptr) const
inlineoverridevirtual

◆ supportsNonModalDialog() [2/2]

bool QWindowsFileDialogHelper::supportsNonModalDialog ( const QWindow * = nullptr) const
inlineoverridevirtual

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