The QPlatformDialogHelper class allows for platform-specific customization of dialogs. More...

#include <qplatformdialoghelper.h>

Inheritance diagram for QPlatformDialogHelper:

Collaboration diagram for QPlatformDialogHelper:

Public Types
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 }

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

Public Member Functions
	QPlatformDialogHelper ()

	~QPlatformDialogHelper ()

virtual QVariant	styleHint (StyleHint hint) const

virtual void	exec ()=0

virtual bool	show (Qt::WindowFlags windowFlags, Qt::WindowModality windowModality, QWindow *parent)=0

virtual void	hide ()=0

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.

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

Static Public Member Functions
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)

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

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

The QPlatformDialogHelper class allows for platform-specific customization of dialogs.

Since: 5.0

Definition at line 44 of file qplatformdialoghelper.h.

Member Enumeration Documentation

◆ ButtonLayout

enum QPlatformDialogHelper::ButtonLayout

Enumerator
UnknownLayout
WinLayout
MacLayout
KdeLayout
GnomeLayout
AndroidLayout

Definition at line 110 of file qplatformdialoghelper.h.

◆ ButtonRole

enum QPlatformDialogHelper::ButtonRole

Enumerator
InvalidRole
AcceptRole
RejectRole
DestructiveRole
ActionRole
HelpRole
YesRole
NoRole
ResetRole
ApplyRole
NRoles
RoleMask
AlternateRole
Stretch
Reverse
EOL

Definition at line 85 of file qplatformdialoghelper.h.

◆ DialogCode

enum QPlatformDialogHelper::DialogCode

Enumerator
Rejected
Accepted

Definition at line 51 of file qplatformdialoghelper.h.

◆ StandardButton

enum QPlatformDialogHelper::StandardButton

Enumerator
NoButton
Ok
Save
SaveAll
Open
Yes
YesToAll
No
NoToAll
Abort
Retry
Ignore
Close
Cancel
Discard
Help
Apply
Reset
RestoreDefaults
FirstButton
LastButton
LowestBit
HighestBit

Definition at line 53 of file qplatformdialoghelper.h.

◆ StyleHint

enum QPlatformDialogHelper::StyleHint

This enum type specifies platform-specific style hints.

\value DialogIsQtWindow Indicates that a platform-specific dialog is implemented as in-process Qt window. It allows to prevent blocking the dialog by an invisible proxy Qt dialog.

See also: styleHint()

Enumerator
DialogIsQtWindow

Definition at line 48 of file qplatformdialoghelper.h.

Constructor & Destructor Documentation

◆ QPlatformDialogHelper()

QPlatformDialogHelper::QPlatformDialogHelper ( )

Definition at line 125 of file qplatformdialoghelper.cpp.

◆ ~QPlatformDialogHelper()

QPlatformDialogHelper::~QPlatformDialogHelper ( )

Definition at line 131 of file qplatformdialoghelper.cpp.

Member Function Documentation

◆ accept

void QPlatformDialogHelper::accept ( )

signal

◆ buttonLayout()

const int * QPlatformDialogHelper::buttonLayout	(	Qt::Orientation	orientation = Qt::Horizontal,
		ButtonLayout	policy = UnknownLayout )

static

Definition at line 1021 of file qplatformdialoghelper.cpp.

◆ buttonRole()

QPlatformDialogHelper::ButtonRole QPlatformDialogHelper::buttonRole ( QPlatformDialogHelper::StandardButton button )

static

Definition at line 978 of file qplatformdialoghelper.cpp.

◆ defaultStyleHint()

QVariant QPlatformDialogHelper::defaultStyleHint ( QPlatformDialogHelper::StyleHint hint )

static

Definition at line 140 of file qplatformdialoghelper.cpp.

◆ exec()

virtual void QPlatformDialogHelper::exec ( )

pure virtual

◆ hide()

virtual void QPlatformDialogHelper::hide ( )

pure virtual

◆ reject

void QPlatformDialogHelper::reject ( )

signal

◆ show()

virtual bool QPlatformDialogHelper::show	(	Qt::WindowFlags	windowFlags,
		Qt::WindowModality	windowModality,
		QWindow *	parent )

pure virtual

◆ styleHint()

QVariant QPlatformDialogHelper::styleHint ( StyleHint hint ) const

virtual

Definition at line 135 of file qplatformdialoghelper.cpp.

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

qtbase/src/gui/kernel/qplatformdialoghelper.h (bafeffff9d1b9b2c8108e74cb6857899f7dd5b5e)
qtbase/src/gui/kernel/qplatformdialoghelper.cpp (bafeffff9d1b9b2c8108e74cb6857899f7dd5b5e)

Public Types

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ButtonLayout

◆ ButtonRole

◆ DialogCode

◆ StandardButton

◆ StyleHint

Constructor & Destructor Documentation

◆ QPlatformDialogHelper()

◆ ~QPlatformDialogHelper()

Member Function Documentation

◆ accept

◆ buttonLayout()

◆ buttonRole()

◆ defaultStyleHint()

◆ exec()

◆ hide()

◆ reject

◆ show()

◆ styleHint()