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

#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 ()
 
- 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)
 
QQuickToolTiptoolTip () const
 \qmlattachedproperty ToolTip QtQuick.Controls::ToolTip::toolTip
 
- 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 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.
 

Properties

QString text
 
int delay
 
int timeout
 
bool visible
 
QQuickToolTiptoolTip
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- 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
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 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< QObjectDatad_ptr
 

Detailed Description

Definition at line 77 of file qquicktooltip_p.h.

Constructor & Destructor Documentation

◆ QQuickToolTipAttached()

QQuickToolTipAttached::QQuickToolTipAttached ( QObject * parent = nullptr)
explicit

Definition at line 373 of file qquicktooltip.cpp.

Member Function Documentation

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

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

Definition at line 413 of file qquicktooltip.cpp.

References d.

◆ delayChanged

void QQuickToolTipAttached::delayChanged ( )
signal

Referenced by setDelay().

+ Here is the caller graph for this function:

◆ 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 530 of file qquicktooltip.cpp.

References QQuickPopup::close(), d, and QObject::parent().

Referenced by setVisible().

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

◆ 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 467 of file qquicktooltip.cpp.

References d, and QObject::parent().

Referenced by setDelay(), setText(), and setTimeout().

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

◆ setDelay()

void QQuickToolTipAttached::setDelay ( int delay)

Definition at line 419 of file qquicktooltip.cpp.

References d, delay, delayChanged(), emit, and isVisible().

+ Here is the call graph for this function:

◆ setText()

void QQuickToolTipAttached::setText ( const QString & text)

Definition at line 392 of file qquicktooltip.cpp.

References d, emit, isVisible(), text, and textChanged().

+ Here is the call graph for this function:

◆ setTimeout()

void QQuickToolTipAttached::setTimeout ( int timeout)

Definition at line 446 of file qquicktooltip.cpp.

References d, emit, isVisible(), timeout, and timeoutChanged().

+ Here is the call graph for this function:

◆ setVisible()

void QQuickToolTipAttached::setVisible ( bool visible)

Definition at line 477 of file qquicktooltip.cpp.

References d, hide(), show(), and visible.

+ Here is the call graph for this function:

◆ 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 508 of file qquicktooltip.cpp.

References d, QObject::parent(), QQuickToolTip::setDelay(), QQuickToolTip::setTimeout(), and text.

+ Here is the call graph for this function:

◆ 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 386 of file qquicktooltip.cpp.

References d.

◆ textChanged

void QQuickToolTipAttached::textChanged ( )
signal

Referenced by setText().

+ Here is the caller graph for this function:

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

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

Definition at line 440 of file qquicktooltip.cpp.

References d.

◆ timeoutChanged

void QQuickToolTipAttached::timeoutChanged ( )
signal

Referenced by setTimeout().

+ Here is the caller graph for this function:

◆ 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 494 of file qquicktooltip.cpp.

References d.

◆ visibleChanged

void QQuickToolTipAttached::visibleChanged ( )
signal

Referenced by QQuickToolTip::itemChange().

+ Here is the caller graph for this function:

Property Documentation

◆ delay

int QQuickToolTipAttached::delay
readwrite

Definition at line 81 of file qquicktooltip_p.h.

Referenced by setDelay().

◆ text

QString QQuickToolTipAttached::text
readwrite

Definition at line 80 of file qquicktooltip_p.h.

Referenced by setText(), and show().

◆ timeout

int QQuickToolTipAttached::timeout
readwrite

Definition at line 82 of file qquicktooltip_p.h.

Referenced by setTimeout().

◆ toolTip

QQuickToolTip * QQuickToolTipAttached::toolTip
read

Definition at line 84 of file qquicktooltip_p.h.

◆ visible

bool QQuickToolTipAttached::visible
readwrite

Definition at line 83 of file qquicktooltip_p.h.

Referenced by setVisible().


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