#include <qquickoverlay_p.h>

Inheritance diagram for QQuickOverlayAttached:

Collaboration diagram for QQuickOverlayAttached:

Signals
void	overlayChanged ()

void	modalChanged ()

void	modelessChanged ()

void	pressed ()

void	released ()

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
	QQuickOverlayAttached (QObject *parent=nullptr)
	\qmlattachedsignal QtQuick.Controls::Overlay::pressed()

QQuickOverlay *	overlay () const
	\qmlattachedproperty Overlay QtQuick.Controls::Overlay::overlay \readonly

QQmlComponent *	modal () const
	\qmlattachedproperty Component QtQuick.Controls::Overlay::modal

void	setModal (QQmlComponent *modal)

QQmlComponent *	modeless () const
	\qmlattachedproperty Component QtQuick.Controls::Overlay::modeless

void	setModeless (QQmlComponent *modeless)

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

Properties
QQuickOverlay *	overlay

QQmlComponent *	modal

QQmlComponent *	modeless

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
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 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

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 79 of file qquickoverlay_p.h.

Constructor & Destructor Documentation

◆ QQuickOverlayAttached()

QQuickOverlayAttached::QQuickOverlayAttached ( QObject * parent = nullptr )

explicit

\qmlattachedsignal QtQuick.Controls::Overlay::pressed()

This attached signal is emitted when the overlay is pressed by the user while a popup is visible.

The signal can be attached to any item, popup, or window. When attached to an item or a popup, the signal is only emitted if the item or popup is in a window.

\qmlattachedsignal QtQuick.Controls::Overlay::released()

This attached signal is emitted when the overlay is released by the user while a popup is visible.

The signal can be attached to any item, popup, or window. When attached to an item or a popup, the signal is only emitted if the item or popup is in a window.

Definition at line 654 of file qquickoverlay.cpp.

References QObjectPrivate::connect(), d, item, QObject::parent(), qobject_cast< QQuickItem * >(), QQuickOverlayAttachedPrivate::setWindow(), QGraphicsItem::window(), and QQuickPopup::windowChanged().

Here is the call graph for this function:

Member Function Documentation

◆ modal()

QQmlComponent * QQuickOverlayAttached::modal ( ) const

\qmlattachedproperty Component QtQuick.Controls::Overlay::modal

This attached property holds a component to use as a visual item that implements background dimming for modal popups. It is created for and stacked below visible modal popups.

The property can be attached to any popup.

For example, to change the color of the background dimming for a modal popup, the following code can be used:

Popup {
    id: popup
    width: 400
    height: 400
    modal: true
    visible: true
 
    Overlay.modal: Rectangle {
        color: "#aacfdbe7"
    }
}

See also: Popup::modal

Definition at line 700 of file qquickoverlay.cpp.

References d.

◆ modalChanged

void QQuickOverlayAttached::modalChanged ( )

signal

Referenced by setModal().

Here is the caller graph for this function:

◆ modeless()

QQmlComponent * QQuickOverlayAttached::modeless ( ) const

\qmlattachedproperty Component QtQuick.Controls::Overlay::modeless

This attached property holds a component to use as a visual item that implements background dimming for modeless popups. It is created for and stacked below visible dimming popups.

The property can be attached to any popup.

For example, to change the color of the background dimming for a modeless popup, the following code can be used:

Popup {
    id: popup
    width: 400
    height: 400
    dim: true
    visible: true
 
    Overlay.modeless: Rectangle {
        color: "#aacfdbe7"
    }
}

See also: Popup::dim

Definition at line 732 of file qquickoverlay.cpp.

References d.

◆ modelessChanged

void QQuickOverlayAttached::modelessChanged ( )

signal

Referenced by setModeless().

Here is the caller graph for this function:

◆ overlay()

QQuickOverlay * QQuickOverlayAttached::overlay ( ) const

\qmlattachedproperty Overlay QtQuick.Controls::Overlay::overlay \readonly

This attached property holds the window overlay item.

The property can be attached to any item, popup, or window. When attached to an item or a popup, the value is null if the item or popup is not in a window.

Definition at line 678 of file qquickoverlay.cpp.

References d, and QQuickOverlay::overlay().

Here is the call graph for this function:

◆ overlayChanged

void QQuickOverlayAttached::overlayChanged ( )

signal

◆ pressed

void QQuickOverlayAttached::pressed ( )

signal

Referenced by QQuickOverlayAttachedPrivate::setWindow().

Here is the caller graph for this function:

◆ released

void QQuickOverlayAttached::released ( )

signal

Referenced by QQuickOverlayAttachedPrivate::setWindow().

Here is the caller graph for this function:

◆ setModal()

void QQuickOverlayAttached::setModal ( QQmlComponent * modal )

Definition at line 706 of file qquickoverlay.cpp.

References d, emit, modal, and modalChanged().

Here is the call graph for this function:

◆ setModeless()

void QQuickOverlayAttached::setModeless ( QQmlComponent * modeless )

Definition at line 738 of file qquickoverlay.cpp.

References d, emit, modeless, and modelessChanged().

Here is the call graph for this function:

Property Documentation

◆ modal

QQmlComponent * QQuickOverlayAttached::modal

readwrite

Definition at line 72 of file qquickoverlay_p.h.

Referenced by QQuickPopupPrivate::createOverlay(), and setModal().

◆ modeless

QQmlComponent * QQuickOverlayAttached::modeless

readwrite

Definition at line 72 of file qquickoverlay_p.h.

Referenced by QQuickPopupPrivate::createOverlay(), and setModeless().

◆ overlay

QQuickOverlay * QQuickOverlayAttached::overlay

read

Definition at line 72 of file qquickoverlay_p.h.

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

qtdeclarative/src/quicktemplates/qquickoverlay_p.h
qtdeclarative/src/quicktemplates/qquickoverlay.cpp

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickOverlayAttached()

Member Function Documentation

◆ modal()

◆ modalChanged

◆ modeless()

◆ modelessChanged

◆ overlay()

◆ overlayChanged

◆ pressed

◆ released

◆ setModal()

◆ setModeless()

Property Documentation

◆ modal

◆ modeless

◆ overlay