ToolTipArea Class Reference

#include <tooltiparea.h>

Inheritance diagram for ToolTipArea:

Properties
bool	active
bool	containsMouse
QVariant	icon
QVariant	image
bool	interactive
Plasma::Types::Location	location
QML_ELEMENTQQuickItem *	mainItem
QString	mainText
QString	subText
int	textFormat
int	timeout
Properties inherited from QQuickItem
	activeFocus
	activeFocusOnTab
	antialiasing
	baselineOffset
	childrenRect
	clip
	containmentMask
	enabled
	focus
	height
	implicitHeight
	implicitWidth
	opacity
	parent
	rotation
	scale
	smooth
	state
	transformOrigin
	visible
	width
	x
	y
	z
Properties inherited from QObject
	objectName

Signals
void	aboutToShow ()
void	activeChanged ()
void	containsMouseChanged ()
void	iconChanged ()
void	imageChanged ()
void	interactiveChanged ()
void	locationChanged ()
void	mainItemChanged ()
void	mainTextChanged ()
void	subTextChanged ()
void	textFormatChanged ()
void	toolTipVisibleChanged (bool toolTipVisible)

Public Slots
void	hideImmediately ()
void	hideToolTip ()
void	showToolTip ()

Additional Inherited Members
Public Types inherited from QQuickItem
enum	Flag
typedef	Flags
enum	ItemChange
enum	TransformOrigin
Public Types inherited from QObject
typedef	QObjectList
Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent)
Qt::MouseButtons	acceptedMouseButtons () const const
bool	acceptHoverEvents () const const
bool	acceptTouchEvents () const const
void	activeFocusChanged (bool)
bool	activeFocusOnTab () const const
void	activeFocusOnTabChanged (bool)
bool	antialiasing () const const
void	antialiasingChanged (bool)
qreal	baselineOffset () const const
void	baselineOffsetChanged (qreal)
QBindable< qreal >	bindableHeight ()
QBindable< qreal >	bindableWidth ()
QBindable< qreal >	bindableX ()
QBindable< qreal >	bindableY ()
virtual QRectF	boundingRect () const const
QQuickItem *	childAt (qreal x, qreal y) const const
QList< QQuickItem * >	childItems () const const
QRectF	childrenRect ()
void	childrenRectChanged (const QRectF &)
bool	clip () const const
void	clipChanged (bool)
virtual QRectF	clipRect () const const
QObject *	containmentMask () const const
void	containmentMaskChanged ()
virtual bool	contains (const QPointF &point) const const
QCursor	cursor () const const
void	dumpItemTree () const const
void	enabledChanged ()
void	ensurePolished ()
bool	filtersChildMouseEvents () const const
Flags	flags () const const
void	focusChanged (bool)
void	forceActiveFocus ()
void	forceActiveFocus (Qt::FocusReason reason)
void	grabMouse ()
QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize)
void	grabTouchPoints (const QList< int > &ids)
bool	hasActiveFocus () const const
bool	hasFocus () const const
qreal	height () const const
void	heightChanged ()
qreal	implicitHeight () const const
void	implicitHeightChanged ()
qreal	implicitWidth () const const
void	implicitWidthChanged ()
virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const const
bool	isAncestorOf (const QQuickItem *child) const const
bool	isEnabled () const const
bool	isFocusScope () const const
virtual bool	isTextureProvider () const const
bool	isVisible () const const
bool	keepMouseGrab () const const
bool	keepTouchGrab () const const
QPointF	mapFromGlobal (const QPointF &point) const const
QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const const
QPointF	mapFromScene (const QPointF &point) const const
QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const const
QRectF	mapRectFromScene (const QRectF &rect) const const
QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const const
QRectF	mapRectToScene (const QRectF &rect) const const
QPointF	mapToGlobal (const QPointF &point) const const
QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const const
QPointF	mapToScene (const QPointF &point) const const
QQuickItem *	nextItemInFocusChain (bool forward)
qreal	opacity () const const
void	opacityChanged ()
void	parentChanged (QQuickItem *)
QQuickItem *	parentItem () const const
void	polish ()
void	resetAntialiasing ()
void	resetHeight ()
void	resetWidth ()
qreal	rotation () const const
void	rotationChanged ()
qreal	scale () const const
void	scaleChanged ()
QQuickItem *	scopedFocusItem () const const
void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
void	setAcceptHoverEvents (bool enabled)
void	setAcceptTouchEvents (bool enabled)
void	setActiveFocusOnTab (bool)
void	setAntialiasing (bool)
void	setBaselineOffset (qreal)
void	setClip (bool)
void	setContainmentMask (QObject *mask)
void	setCursor (const QCursor &cursor)
void	setEnabled (bool)
void	setFiltersChildMouseEvents (bool filter)
void	setFlag (Flag flag, bool enabled)
void	setFlags (Flags flags)
void	setFocus (bool focus, Qt::FocusReason reason)
void	setFocus (bool)
void	setHeight (qreal)
void	setImplicitHeight (qreal)
void	setImplicitWidth (qreal)
void	setKeepMouseGrab (bool keep)
void	setKeepTouchGrab (bool keep)
void	setOpacity (qreal)
void	setParentItem (QQuickItem *parent)
void	setRotation (qreal)
void	setScale (qreal)
void	setSize (const QSizeF &size)
void	setSmooth (bool)
void	setState (const QString &)
void	setTransformOrigin (TransformOrigin)
void	setVisible (bool)
void	setWidth (qreal)
void	setX (qreal)
void	setY (qreal)
void	setZ (qreal)
QSizeF	size () const const
bool	smooth () const const
void	smoothChanged (bool)
void	stackAfter (const QQuickItem *sibling)
void	stackBefore (const QQuickItem *sibling)
QString	state () const const
void	stateChanged (const QString &)
virtual QSGTextureProvider *	textureProvider () const const
TransformOrigin	transformOrigin () const const
void	transformOriginChanged (TransformOrigin)
void	ungrabMouse ()
void	ungrabTouchPoints ()
void	unsetCursor ()
void	update ()
QQuickItem *	viewportItem () const const
void	visibleChanged ()
qreal	width () const const
void	widthChanged ()
QQuickWindow *	window () const const
void	windowChanged (QQuickWindow *window)
qreal	x () const const
void	xChanged ()
qreal	y () const const
void	yChanged ()
qreal	z () const const
void	zChanged ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const
Public Member Functions inherited from QQmlParserStatus
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QQuickItem
	Bottom
	BottomLeft
	BottomRight
	Center
	ItemAcceptsDrops
	ItemAcceptsInputMethod
	ItemActiveFocusHasChanged
	ItemAntialiasingHasChanged
	ItemChildAddedChange
	ItemChildRemovedChange
	ItemClipsChildrenToShape
	ItemDevicePixelRatioHasChanged
	ItemEnabledHasChanged
	ItemHasContents
	ItemIsFocusScope
	ItemIsViewport
	ItemObservesViewport
	ItemOpacityHasChanged
	ItemParentHasChanged
	ItemRotationHasChanged
	ItemSceneChange
	ItemVisibleHasChanged
	Left
	Right
	Top
	TopLeft
	TopRight
Protected Member Functions inherited from QQuickItem
virtual bool	childMouseEventFilter (QQuickItem *item, QEvent *event)
virtual void	classBegin () override
virtual void	componentComplete () override
virtual void	dragEnterEvent (QDragEnterEvent *event)
virtual void	dragLeaveEvent (QDragLeaveEvent *event)
virtual void	dragMoveEvent (QDragMoveEvent *event)
virtual void	dropEvent (QDropEvent *event)
virtual bool	event (QEvent *ev) override
virtual void	focusInEvent (QFocusEvent *)
virtual void	focusOutEvent (QFocusEvent *)
virtual void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry)
bool	heightValid () const const
virtual void	hoverEnterEvent (QHoverEvent *event)
virtual void	hoverLeaveEvent (QHoverEvent *event)
virtual void	hoverMoveEvent (QHoverEvent *event)
virtual void	inputMethodEvent (QInputMethodEvent *event)
bool	isComponentComplete () const const
virtual void	itemChange (ItemChange change, const ItemChangeData &value)
virtual void	keyPressEvent (QKeyEvent *event)
virtual void	keyReleaseEvent (QKeyEvent *event)
virtual void	mouseDoubleClickEvent (QMouseEvent *event)
virtual void	mouseMoveEvent (QMouseEvent *event)
virtual void	mousePressEvent (QMouseEvent *event)
virtual void	mouseReleaseEvent (QMouseEvent *event)
virtual void	mouseUngrabEvent ()
virtual void	releaseResources ()
virtual void	touchEvent (QTouchEvent *event)
virtual void	touchUngrabEvent ()
void	updateInputMethod (Qt::InputMethodQueries queries)
virtual QSGNode *	updatePaintNode (QSGNode *oldNode, UpdatePaintNodeData *updatePaintNodeData)
virtual void	updatePolish ()
virtual void	wheelEvent (QWheelEvent *event)
bool	widthValid () const const
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

An Item managing a Plasma-themed tooltip.

It is rendered in its own window. You can either specify icon, mainText and subText, or a custom Component that will be put inside the tooltip. By default the tooltip will be rendered when hovering over the parent item.

The item inside the ToolTipArea is loaded on demand and will be destroyed when the tooltip is being hidden.

Example usage:

import org.kde.plasma.core as PlasmaCore
import org.kde.kirigami 2.20 as Kirigami
 
Kirigami.Icon {
    PlasmaCore.ToolTipArea {
        mainText: i18n("Tooltip Title")
        subText: i18n("Some explanation.")
        icon: "plasma"
        // alternatively, you can specify your own component
        // to be loaded when the tooltip shows
        mainItem: YourCustomItem { }
    }
}

Import Statement

import org.kde.plasma.core 

Version

2.0

Definition at line 51 of file tooltiparea.h.

Property Documentation

active

bool ToolTipArea::active

write

Property that controls if a tooltips will show on mouse over.

The default is true.

Definition at line 106 of file tooltiparea.h.

containsMouse

bool ToolTipArea::containsMouse

read

Returns whether the mouse is inside the item.

Definition at line 89 of file tooltiparea.h.

icon

QVariant ToolTipArea::icon

readwrite

An icon for this tooltip, accepted values are an icon name, a QIcon, QImage or QPixmap.

Definition at line 84 of file tooltiparea.h.

image

QVariant ToolTipArea::image

readwrite

TODO: single property for images? An image for this tooltip, accepted values are an icon name, a QIcon, QImage or QPixmap.

Definition at line 100 of file tooltiparea.h.

interactive

bool ToolTipArea::interactive

write

If interactive is false (default), the tooltip will automatically hide itself as soon as the mouse leaves the tooltiparea, if is true, if the mouse leaves tooltiparea and goes over the tooltip itself, the tooltip won't hide, so it will be possible to interact with tooltip contents.

Definition at line 114 of file tooltiparea.h.

location

Plasma::Types::Location ToolTipArea::location

readwrite

Plasma Location of the dialog window.

Useful if this dialog is a popup for a panel

Definition at line 94 of file tooltiparea.h.

mainItem

QQuickItem * ToolTipArea::mainItem

readwrite

The item shown inside the tooltip.

Definition at line 59 of file tooltiparea.h.

mainText

QString ToolTipArea::mainText

readwrite

The main text of this tooltip.

Definition at line 64 of file tooltiparea.h.

subText

QString ToolTipArea::subText

readwrite

The description of this tooltip.

Definition at line 69 of file tooltiparea.h.

textFormat

int ToolTipArea::textFormat

readwrite

how to handle the text format of the tooltip subtext:

• Text.AutoText (default)
• Text.PlainText
• Text.StyledText
• Text.RichText Note: in the default implementation the main text is always plain text

Definition at line 79 of file tooltiparea.h.

timeout

int ToolTipArea::timeout

write

Timeout in milliseconds after which the tooltip will hide itself.

Set this value to -1 to never hide the tooltip automatically.

Definition at line 120 of file tooltiparea.h.

Member Function Documentation

aboutToShow

void ToolTipArea::aboutToShow ( )

signal

Emitted just before the tooltip dialog is shown.

Since

5.45

hideImmediately

void ToolTipArea::hideImmediately ( )

slot

Hides the tooltip immediately, in comparison to hideToolTip.

Since

5.84

Definition at line 293 of file tooltiparea.cpp.

hideToolTip

void ToolTipArea::hideToolTip ( )

slot

Hides the tooltip after a grace period if shown.

Does not affect whether the tooltip area is active.

Definition at line 287 of file tooltiparea.cpp.

showToolTip

void ToolTipArea::showToolTip ( )

slot

Shows the tooltip.

Since

5.73

Definition at line 116 of file tooltiparea.cpp.

toolTipVisibleChanged

void ToolTipArea::toolTipVisibleChanged ( bool toolTipVisible )

signal

Emitted when the tooltip's visibility changes.

Since

5.88

---

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

• tooltiparea.h
• tooltiparea.cpp