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
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
QQuickToolTip Class Reference

#include <qquicktooltip_p.h>

+ Inheritance diagram for QQuickToolTip:
+ Collaboration diagram for QQuickToolTip:

Public Slots

 Q_REVISION (2, 5) void show(const QString &text
 
- Public Slots inherited from QQuickPopup
void open ()
 \qmlmethod void QtQuick.Controls::Popup::open()
 
void close ()
 \qmlmethod void QtQuick.Controls::Popup::close()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void textChanged ()
 
void delayChanged ()
 
void timeoutChanged ()
 
- Signals inherited from QQuickPopup
void opened ()
 
void closed ()
 
void aboutToShow ()
 
void aboutToHide ()
 
void xChanged ()
 
void yChanged ()
 
void zChanged ()
 
void widthChanged ()
 
void heightChanged ()
 
void implicitWidthChanged ()
 
void implicitHeightChanged ()
 
void contentWidthChanged ()
 
void contentHeightChanged ()
 
void availableWidthChanged ()
 
void availableHeightChanged ()
 
void marginsChanged ()
 
void topMarginChanged ()
 
void leftMarginChanged ()
 
void rightMarginChanged ()
 
void bottomMarginChanged ()
 
void paddingChanged ()
 
void topPaddingChanged ()
 
void leftPaddingChanged ()
 
void rightPaddingChanged ()
 
void bottomPaddingChanged ()
 
void fontChanged ()
 
void localeChanged ()
 
void parentChanged ()
 
void backgroundChanged ()
 
void contentItemChanged ()
 
void contentChildrenChanged ()
 
void clipChanged ()
 
void focusChanged ()
 
void activeFocusChanged ()
 
void modalChanged ()
 
void dimChanged ()
 
void visibleChanged ()
 
void opacityChanged ()
 
void scaleChanged ()
 
void closePolicyChanged ()
 
void enterChanged ()
 
void exitChanged ()
 
void windowChanged (QQuickWindow *window)
 
 Q_REVISION (2, 1) void spacingChanged()
 
 Q_REVISION (2, 3) void openedChanged()
 
 Q_REVISION (2, 3) void mirroredChanged()
 
 Q_REVISION (2, 3) void enabledChanged()
 
 Q_REVISION (2, 3) void paletteChanged()
 
 Q_REVISION (2, 3) void paletteCreated()
 
 Q_REVISION (2, 5) void horizontalPaddingChanged()
 
 Q_REVISION (2, 5) void verticalPaddingChanged()
 
 Q_REVISION (2, 5) void implicitContentWidthChanged()
 
 Q_REVISION (2, 5) void implicitContentHeightChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundWidthChanged()
 
 Q_REVISION (2, 5) void implicitBackgroundHeightChanged()
 
 Q_REVISION (2, 5) void topInsetChanged()
 
 Q_REVISION (2, 5) void leftInsetChanged()
 
 Q_REVISION (2, 5) void rightInsetChanged()
 
 Q_REVISION (2, 5) void bottomInsetChanged()
 
- 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

 QQuickToolTip (QQuickItem *parent=nullptr)
 
QString text () const
 \qmlproperty string QtQuick.Controls::ToolTip::text
 
void setText (const QString &text)
 
int delay () const
 \qmlproperty int QtQuick.Controls::ToolTip::delay
 
void setDelay (int delay)
 
int timeout () const
 \qmlproperty int QtQuick.Controls::ToolTip::timeout
 
void setTimeout (int timeout)
 
void setVisible (bool visible) override
 
 Q_REVISION (2, 5) void hide()
 
- 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.
 
- Public Member Functions inherited from QQmlParserStatus
 QQmlParserStatus ()
 
virtual ~QQmlParserStatus ()
 

Static Public Member Functions

static QQuickToolTipAttached * qmlAttachedProperties (QObject *object)
 
- 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)
 

Public Attributes

int ms = -1)
 

Protected Member Functions

QFont defaultFont () const override
 
void itemChange (QQuickItem::ItemChange change, const QQuickItem::ItemChangeData &data) override
 
void timerEvent (QTimerEvent *event) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
- Protected Member Functions inherited from QQuickPopup
 QQuickPopup (QQuickPopupPrivate &dd, QObject *parent)
 
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.
 
bool isComponentComplete () const
 
virtual bool childMouseEventFilter (QQuickItem *child, QEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void keyReleaseEvent (QKeyEvent *event)
 
virtual void mousePressEvent (QMouseEvent *event)
 
virtual void mouseMoveEvent (QMouseEvent *event)
 
virtual void mouseReleaseEvent (QMouseEvent *event)
 
virtual void mouseDoubleClickEvent (QMouseEvent *event)
 
virtual void mouseUngrabEvent ()
 
virtual bool overlayEvent (QQuickItem *item, QEvent *event)
 
virtual void contentItemChange (QQuickItem *newItem, QQuickItem *oldItem)
 
virtual void contentSizeChange (const QSizeF &newSize, const QSizeF &oldSize)
 
virtual void fontChange (const QFont &newFont, const QFont &oldFont)
 
virtual void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)
 
virtual void localeChange (const QLocale &newLocale, const QLocale &oldLocale)
 
virtual void marginsChange (const QMarginsF &newMargins, const QMarginsF &oldMargins)
 
virtual void paddingChange (const QMarginsF &newPadding, const QMarginsF &oldPadding)
 
virtual void spacingChange (qreal newSpacing, qreal oldSpacing)
 
virtual void insetChange (const QMarginsF &newInset, const QMarginsF &oldInset)
 
QString accessibleName () const
 
void maybeSetAccessibleName (const QString &name)
 
QVariant accessibleProperty (const char *propertyName)
 
bool setAccessibleProperty (const char *propertyName, const QVariant &value)
 
- 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 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)
 

Properties

int delay
 
int timeout
 
QString text
 
- Properties inherited from QQuickPopup
qreal x
 
qreal y
 
qreal z
 
qreal width
 
qreal height
 
qreal implicitWidth
 
qreal implicitHeight
 
qreal contentWidth
 
qreal contentHeight
 
qreal availableWidth
 
qreal availableHeight
 
qreal margins
 
qreal topMargin
 
qreal leftMargin
 
qreal rightMargin
 
qreal bottomMargin
 
qreal padding
 
qreal topPadding
 
qreal leftPadding
 
qreal rightPadding
 
qreal bottomPadding
 
QLocale locale
 
QFont font
 
QQuickItem * parent
 
QQuickItem * background
 
QQuickItem * contentItem
 
bool clip
 
bool focus
 
bool activeFocus
 
bool modal
 
bool dim
 
bool visible
 
qreal opacity
 
qreal scale
 
ClosePolicy closePolicy
 
TransformOrigin transformOrigin
 
QQuickTransition * enter
 
QQuickTransition * exit
 
qreal spacing
 
bool opened
 
bool mirrored
 
bool enabled
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
 
- Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 
 
 
 \macro Q_CLASSINFO(Name, Value)
 

Detailed Description

Definition at line 26 of file qquicktooltip_p.h.

Constructor & Destructor Documentation

◆ QQuickToolTip()

QQuickToolTip::QQuickToolTip ( QQuickItem * parent = nullptr)
explicit

Definition at line 144 of file qquicktooltip.cpp.

References d.

Member Function Documentation

◆ defaultFont()

QFont QQuickToolTip::defaultFont ( ) const
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 283 of file qquicktooltip.cpp.

References QQuickTheme::font(), and QQuickTheme::ToolTip.

+ Here is the call graph for this function:

◆ delay()

int QQuickToolTip::delay ( ) const

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

This property holds the delay (milliseconds) after which the tool tip is shown. A tooltip with a negative delay is shown immediately. The default value is 0.

See also
{Delay and Timeout}

Definition at line 184 of file qquicktooltip.cpp.

References d.

◆ delayChanged

void QQuickToolTip::delayChanged ( )
signal

Referenced by setDelay().

+ Here is the caller graph for this function:

◆ itemChange()

void QQuickToolTip::itemChange ( QQuickItem::ItemChange change,
const QQuickItem::ItemChangeData & data )
overrideprotectedvirtual

Reimplemented from QQuickPopup.

Definition at line 288 of file qquicktooltip.cpp.

References d, emit, QQuickPopup::itemChange(), QQuickItem::ItemVisibleHasChanged, and QQuickToolTipAttached::visibleChanged().

+ Here is the call graph for this function:

◆ Q_REVISION() [1/2]

QQuickToolTip::Q_REVISION ( 2 ,
5  )

◆ Q_REVISION [2/2]

QQuickToolTip::Q_REVISION ( 2 ,
5  ) const &
slot

◆ qmlAttachedProperties()

QQuickToolTipAttached * QQuickToolTip::qmlAttachedProperties ( QObject * object)
static

Definition at line 248 of file qquicktooltip.cpp.

References item, qmlWarning(), and qobject_cast< QQuickItem * >().

+ Here is the call graph for this function:

◆ setDelay()

void QQuickToolTip::setDelay ( int delay)

Definition at line 190 of file qquicktooltip.cpp.

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

Referenced by QQuickToolTipAttached::show().

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

◆ setText()

void QQuickToolTip::setText ( const QString & text)

Definition at line 164 of file qquicktooltip.cpp.

References d, emit, QQuickPopup::maybeSetAccessibleName(), text, and textChanged().

+ Here is the call graph for this function:

◆ setTimeout()

void QQuickToolTip::setTimeout ( int timeout)

Definition at line 215 of file qquicktooltip.cpp.

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

Referenced by QQuickToolTipAttached::show().

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

◆ setVisible()

void QQuickToolTip::setVisible ( bool visible)
overridevirtual

Reimplemented from QQuickPopup.

Definition at line 231 of file qquicktooltip.cpp.

References d, QQuickPopup::setVisible(), and QQuickPopup::visible.

+ Here is the call graph for this function:

◆ text()

QString QQuickToolTip::text ( ) const

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

This property holds the text shown on the tool tip.

Definition at line 158 of file qquicktooltip.cpp.

References d.

◆ textChanged

void QQuickToolTip::textChanged ( )
signal

Referenced by setText().

+ Here is the caller graph for this function:

◆ timeout()

int QQuickToolTip::timeout ( ) const

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

This property holds the timeout (milliseconds) after which the tool tip is hidden. A tooltip with a negative timeout does not hide automatically. The default value is -1.

See also
{Delay and Timeout}

Definition at line 209 of file qquicktooltip.cpp.

References d.

◆ timeoutChanged

void QQuickToolTip::timeoutChanged ( )
signal

Referenced by setTimeout().

+ Here is the caller graph for this function:

◆ timerEvent()

void QQuickToolTip::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 302 of file qquicktooltip.cpp.

References d, QQuickPopup::setVisible(), and QObject::timerEvent().

+ Here is the call graph for this function:

Member Data Documentation

◆ ms

int QQuickToolTip::ms = -1)

Definition at line 58 of file qquicktooltip_p.h.

Property Documentation

◆ delay

int QQuickToolTip::delay
readwrite

Definition at line 29 of file qquicktooltip_p.h.

Referenced by setDelay().

◆ text

QString QQuickToolTip::text
readwrite

Definition at line 31 of file qquicktooltip_p.h.

Referenced by setText().

◆ timeout

int QQuickToolTip::timeout
readwrite

Definition at line 30 of file qquicktooltip_p.h.

Referenced by setTimeout().

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