#include <qquicktooltip_p.h>

Inheritance diagram for QQuickToolTipAttached:

Collaboration diagram for QQuickToolTipAttached:

Public Slots
void	show (const QString &text, int ms=-1)
	\qmlattachedmethod void QtQuick.Controls::ToolTip::show(string text, int timeout = -1)
void	hide ()
	\qmlattachedmethod void QtQuick.Controls::ToolTip::hide()
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	textChanged ()
void	delayChanged ()
void	timeoutChanged ()
void	visibleChanged ()
void	policyChanged ()
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
	QQuickToolTipAttached (QObject *parent=nullptr)
QString	text () const
	\qmlattachedproperty string QtQuick.Controls::ToolTip::text
void	setText (const QString &text)
int	delay () const
	\qmlattachedproperty int QtQuick.Controls::ToolTip::delay
void	setDelay (int delay)
int	timeout () const
	\qmlattachedproperty int QtQuick.Controls::ToolTip::timeout
void	setTimeout (int timeout)
bool	isVisible () const
	\qmlattachedproperty bool QtQuick.Controls::ToolTip::visible
void	setVisible (bool visible)
QQuickToolTip *	toolTip () const
	\qmlattachedproperty ToolTip QtQuick.Controls::ToolTip::toolTip
QQuickToolTip::Policy	policy () const
	\qmlattachedproperty enumeration QtQuick.Controls::ToolTip::policy
void	setVisiblePolicy (QQuickToolTip::Policy policy)
void	resetVisiblePolicy ()
Public Member Functions inherited from QtPrivate::QQuickAttachedPropertyPropagator
	QQuickAttachedPropertyPropagator (QObject *parent=nullptr)
	~QQuickAttachedPropertyPropagator ()
QList< QQuickAttachedPropertyPropagator * >	attachedChildren () const
QQuickAttachedPropertyPropagator *	attachedParent () 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< 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	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).
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`.
Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()
virtual	~QQmlParserStatus ()

Properties
QML_ANONYMOUSQString	text
int	delay
int	timeout
bool	visible
QQuickToolTip *	toolTip
QQuickToolTip::Policy	policy
Properties inherited from QObject
QString	objectName
	the name of this object

Private Member Functions
void	attachedParentChange (QQuickAttachedPropertyPropagator newParent, QQuickAttachedPropertyPropagator oldParent) override
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.

Additional Inherited Members
Static Public Member Functions inherited from QtPrivate::QQuickAttachedPropertyPropagator
static QQuickAttachedPropertyPropagator *	attachedObject (const QMetaObject attachedType, QObject attachee, bool create=false)
static QQuickAttachedPropertyPropagator *	fallbackAttachedObject (const QMetaObject attachedType, QObject attachee)
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 QtPrivate::QQuickAttachedPropertyPropagator
	QQuickAttachedPropertyPropagator (QQuickAttachedPropertyPropagatorPrivate &dd, QObject *parent)
void	initialize ()
virtual void	attachedParentChange (QQuickAttachedPropertyPropagator newParent, QQuickAttachedPropertyPropagator oldParent)
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 86 of file qquicktooltip_p.h.

Constructor & Destructor Documentation

◆ QQuickToolTipAttached()

QQuickToolTipAttached::QQuickToolTipAttached ( QObject * parent = nullptr )

explicit

Definition at line 541 of file qquicktooltip.cpp.

Member Function Documentation

◆ attachedParentChange()

void QQuickToolTipAttached::attachedParentChange	(	QQuickAttachedPropertyPropagator *	newParent,
		QQuickAttachedPropertyPropagator *	oldParent )

overrideprivate

Definition at line 773 of file qquicktooltip.cpp.

◆ classBegin()

void QQuickToolTipAttached::classBegin ( )

overrideprivatevirtual

Invoked after class creation, but before any properties have been set.

Implements QQmlParserStatus.

Definition at line 784 of file qquicktooltip.cpp.

◆ componentComplete()

void QQuickToolTipAttached::componentComplete ( )

overrideprivatevirtual

Invoked after the root component that caused this instantiation has completed construction.

At this point all static values and binding values have been assigned to the class.

Implements QQmlParserStatus.

Definition at line 790 of file qquicktooltip.cpp.

◆ delay()

int QQuickToolTipAttached::delay ( ) const

\qmlattachedproperty int QtQuick.Controls::ToolTip::delay

This attached property holds the delay (milliseconds) of the shared tool tip. The property can be attached to any item.

The default value is 0 if \l policy is ToolTip.Manual, otherwise it is \l QStyleHints::toolTipWakeUpDelay().

See also: {Attached Tool Tips}, {Delay and Timeout}

Definition at line 587 of file qquicktooltip.cpp.

◆ delayChanged

void QQuickToolTipAttached::delayChanged ( )

signal

◆ hide

void QQuickToolTipAttached::hide ( )

slot

\qmlattachedmethod void QtQuick.Controls::ToolTip::hide()

This attached method hides the shared tooltip. The method can be attached to any item.

See also: {Attached Tool Tips}

Definition at line 762 of file qquicktooltip.cpp.

◆ isVisible()

bool QQuickToolTipAttached::isVisible ( ) const

\qmlattachedproperty bool QtQuick.Controls::ToolTip::visible

This attached property holds whether the shared tool tip is visible. The property can be attached to any item.

See also: {Attached Tool Tips}

Definition at line 632 of file qquicktooltip.cpp.

◆ policy()

QQuickToolTip::Policy QQuickToolTipAttached::policy ( ) const

\qmlattachedproperty enumeration QtQuick.Controls::ToolTip::policy

Since: 6.12

This attached property controls whether the visibility of the \l {shared tool tip instance}{toolTip} is handled automatically. It only has an effect for items on which ToolTip.visible {has not} been set. Only items that set ToolTip.text will be made visible. It only has an effect for the following items and their derived types: \l Control, \l TextArea and \l TextField. All other types require \l visible to be manually set.

It also determines the default values for the delay and timeout properties of the shared tool tip instance (regardless of whether ToolTip.visible or ToolTip.text have been set).

This property is propagated to attached ToolTip children.

Available values: \value ToolTip.Automatic The shared tool tip will be shown when the attachee is hovered or long-pressed (if triggered by touch and the attachee is an \l AbstractButton or one of its derived types). If the visible property has been explicitly set, or the text property has not been set, this value has no effect, and the behavior will be equivalent to ToolTip.Manual.

The shared tool tip will also default to platform-specific values for its delay and timeout properties. \value ToolTip.Manual The shared tool tip will not be shown automatically, and the developer is responsible for setting the visible property.

The shared tool tip will not default to platform-specific values for its delay and timeout properties.

The default value is {ToolTip.Automatic}.

The property provides a way to opt-out of the default values for shared tool tips introduced in Qt 6.12. This is particularly relevant for legacy code that doesn't explicitly set the visible property before an item is interacted with. For applications that declaratively set the visible property and find the new default values for delay and timeout acceptable, policy is not needed.

See also: {Attached Tool Tips}

Definition at line 707 of file qquicktooltip.cpp.

◆ policyChanged

void QQuickToolTipAttached::policyChanged ( )

signal

◆ resetVisiblePolicy()

void QQuickToolTipAttached::resetVisiblePolicy ( )

Definition at line 724 of file qquicktooltip.cpp.

◆ setDelay()

void QQuickToolTipAttached::setDelay ( int delay )

Definition at line 594 of file qquicktooltip.cpp.

◆ setText()

void QQuickToolTipAttached::setText ( const QString & text )

Definition at line 561 of file qquicktooltip.cpp.

◆ setTimeout()

void QQuickToolTipAttached::setTimeout ( int timeout )

Definition at line 618 of file qquicktooltip.cpp.

◆ setVisible()

void QQuickToolTipAttached::setVisible ( bool visible )

Definition at line 642 of file qquicktooltip.cpp.

◆ setVisiblePolicy()

void QQuickToolTipAttached::setVisiblePolicy ( QQuickToolTip::Policy policy )

Definition at line 713 of file qquicktooltip.cpp.

◆ show

void QQuickToolTipAttached::show	(	const QString &	text,
		int	ms = -1 )

slot

\qmlattachedmethod void QtQuick.Controls::ToolTip::show(string text, int timeout = -1)

This attached method shows the shared tooltip with text and timeout (milliseconds). The method can be attached to any item.

See also: {Attached Tool Tips}

Definition at line 737 of file qquicktooltip.cpp.

◆ text()

QString QQuickToolTipAttached::text ( ) const

\qmlattachedproperty string QtQuick.Controls::ToolTip::text

This attached property holds the text of the shared tool tip. The property can be attached to any item.

See also: {Attached Tool Tips}

Definition at line 555 of file qquicktooltip.cpp.

◆ textChanged

void QQuickToolTipAttached::textChanged ( )

signal

◆ timeout()

int QQuickToolTipAttached::timeout ( ) const

\qmlattachedproperty int QtQuick.Controls::ToolTip::timeout

This attached property holds the timeout (milliseconds) of the shared tool tip. The property can be attached to any item.

The default value is based on the length of the text, and will always be at least 10 seconds long.

See also: {Attached Tool Tips}, {Delay and Timeout}

Definition at line 611 of file qquicktooltip.cpp.

◆ timeoutChanged

void QQuickToolTipAttached::timeoutChanged ( )

signal

◆ toolTip()

QQuickToolTip * QQuickToolTipAttached::toolTip ( ) const

\qmlattachedproperty ToolTip QtQuick.Controls::ToolTip::toolTip

This attached property holds the shared tool tip instance. The property can be attached to any item.

See also: {Attached Tool Tips}

Definition at line 656 of file qquicktooltip.cpp.

◆ visibleChanged

void QQuickToolTipAttached::visibleChanged ( )

signal

Property Documentation

◆ delay

int QQuickToolTipAttached::delay

readwrite

Definition at line 94 of file qquicktooltip_p.h.

◆ policy

QQuickToolTip::Policy QQuickToolTipAttached::policy

readwrite

Definition at line 98 of file qquicktooltip_p.h.

◆ text

QML_ANONYMOUSQString QQuickToolTipAttached::text

readwrite

Definition at line 93 of file qquicktooltip_p.h.

◆ timeout

int QQuickToolTipAttached::timeout

readwrite

Definition at line 95 of file qquicktooltip_p.h.

◆ toolTip

QQuickToolTip * QQuickToolTipAttached::toolTip

read

Definition at line 97 of file qquicktooltip_p.h.

◆ visible

bool QQuickToolTipAttached::visible

readwrite

Definition at line 96 of file qquicktooltip_p.h.

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

qtdeclarative/src/quicktemplates/qquicktooltip_p.h (f55a093c97b4e07e4578ddd2494d28ed9a118778)
qtdeclarative/src/quicktemplates/qquicktooltip.cpp (f55a093c97b4e07e4578ddd2494d28ed9a118778)

Public Slots

Signals

Public Member Functions

Properties

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickToolTipAttached()

Member Function Documentation

◆ attachedParentChange()

◆ classBegin()

◆ componentComplete()

◆ delay()

◆ delayChanged

◆ hide

◆ isVisible()

◆ policy()

◆ policyChanged

◆ resetVisiblePolicy()

◆ setDelay()

◆ setText()

◆ setTimeout()

◆ setVisible()

◆ setVisiblePolicy()

◆ show

◆ text()

◆ textChanged

◆ timeout()

◆ timeoutChanged

◆ toolTip()

◆ visibleChanged

Property Documentation

◆ delay

◆ policy

◆ text

◆ timeout

◆ toolTip

◆ visible