#include <qquicklabsplatformsystemtrayicon_p.h>

Inheritance diagram for QQuickLabsPlatformSystemTrayIcon:

Collaboration diagram for QQuickLabsPlatformSystemTrayIcon:

Public Slots
void	show ()
	\qmlmethod void Qt.labs.platform::SystemTrayIcon::show()
void	hide ()
	\qmlmethod void Qt.labs.platform::SystemTrayIcon::hide()
void	showMessage (const QString &title, const QString &message, QPlatformSystemTrayIcon::MessageIcon iconType=QPlatformSystemTrayIcon::Information, int msecs=10000)
	\qmlmethod void Qt.labs.platform::SystemTrayIcon::showMessage(string title, string message, MessageIcon icon, int msecs)
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	activated (QPlatformSystemTrayIcon::ActivationReason reason)
void	messageClicked ()
void	visibleChanged ()
void	tooltipChanged ()
void	menuChanged ()
	Q_REVISION (1, 1) void geometryChanged()
	Q_REVISION (1, 1) void iconChanged()
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
	QQuickLabsPlatformSystemTrayIcon (QObject *parent=nullptr)
	A system tray icon.
	~QQuickLabsPlatformSystemTrayIcon ()
QPlatformSystemTrayIcon *	handle () const
bool	isAvailable () const
	\readonly \qmlproperty bool Qt.labs.platform::SystemTrayIcon::available
bool	supportsMessages () const
	\readonly \qmlproperty bool Qt.labs.platform::SystemTrayIcon::supportsMessages
bool	isVisible () const
	\qmlproperty bool Qt.labs.platform::SystemTrayIcon::visible
void	setVisible (bool visible)
QString	tooltip () const
	\qmlproperty string Qt.labs.platform::SystemTrayIcon::tooltip
void	setTooltip (const QString &tooltip)
QQuickLabsPlatformMenu *	menu () const
	\qmlproperty Menu Qt.labs.platform::SystemTrayIcon::menu
void	setMenu (QQuickLabsPlatformMenu *menu)
QRect	geometry () const
QQuickLabsPlatformIcon	icon () const
void	setIcon (const QQuickLabsPlatformIcon &icon)
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 ()

Protected Member Functions
void	init ()
void	cleanup ()
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.
QQuickLabsPlatformIconLoader *	iconLoader () const
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)

Properties
bool	available
bool	supportsMessages
bool	visible
QString	tooltip
QQuickLabsPlatformMenu *	menu
QRect	geometry
QQuickLabsPlatformIcon	icon
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 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 34 of file qquicklabsplatformsystemtrayicon_p.h.

Constructor & Destructor Documentation

◆ QQuickLabsPlatformSystemTrayIcon()

QT_BEGIN_NAMESPACE QQuickLabsPlatformSystemTrayIcon::QQuickLabsPlatformSystemTrayIcon ( QObject * parent = nullptr )

explicit

A system tray icon.

\qmltype SystemTrayIcon
\inherits QtObject

! \nativetype QQuickLabsPlatformSystemTrayIcon \inqmlmodule Qt.labs.platform

Since: 5.8

The SystemTrayIcon type provides an icon for an application in the system tray.

Many desktop platforms provide a special system tray or notification area, where applications can display icons and notification messages.

} {System tray icon}

The following example shows how to create a system tray icon, and how to make use of the \l activated() signal:

SystemTrayIcon {
    visible: true
    icon.source: "qrc:/images/tray-icon.png"
 
    onActivated: {
        window.show()
        window.raise()
        window.requestActivate()
    }
}

Definition at line 136 of file qquicklabsplatformsystemtrayicon.cpp.

◆ ~QQuickLabsPlatformSystemTrayIcon()

QQuickLabsPlatformSystemTrayIcon::~QQuickLabsPlatformSystemTrayIcon ( )

Definition at line 155 of file qquicklabsplatformsystemtrayicon.cpp.

References cleanup().

Here is the call graph for this function:

Member Function Documentation

◆ activated

void QQuickLabsPlatformSystemTrayIcon::activated ( QPlatformSystemTrayIcon::ActivationReason reason )

signal

◆ classBegin()

void QQuickLabsPlatformSystemTrayIcon::classBegin ( )

overrideprotectedvirtual

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

Implements QQmlParserStatus.

Definition at line 379 of file qquicklabsplatformsystemtrayicon.cpp.

◆ cleanup()

void QQuickLabsPlatformSystemTrayIcon::cleanup ( )

protected

Definition at line 371 of file qquicklabsplatformsystemtrayicon.cpp.

References QQuickLabsPlatformIconLoader::setEnabled().

Referenced by ~QQuickLabsPlatformSystemTrayIcon(), and setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ componentComplete()

void QQuickLabsPlatformSystemTrayIcon::componentComplete ( )

overrideprotectedvirtual

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 383 of file qquicklabsplatformsystemtrayicon.cpp.

References init().

Here is the call graph for this function:

◆ geometry()

QRect QQuickLabsPlatformSystemTrayIcon::geometry ( ) const

Since: Qt.labs.platform 1.1 (Qt 5.12) \qmlproperty rect Qt.labs.platform::SystemTrayIcon::geometry

This property holds the geometry of the system tray icon.

Definition at line 283 of file qquicklabsplatformsystemtrayicon.cpp.

◆ handle()

QPlatformSystemTrayIcon * QQuickLabsPlatformSystemTrayIcon::handle ( ) const

Definition at line 166 of file qquicklabsplatformsystemtrayicon.cpp.

◆ hide

void QQuickLabsPlatformSystemTrayIcon::hide ( )

slot

\qmlmethod void Qt.labs.platform::SystemTrayIcon::hide()

Hides the system tray icon.

Definition at line 335 of file qquicklabsplatformsystemtrayicon.cpp.

References setVisible().

Here is the call graph for this function:

◆ icon()

QQuickLabsPlatformIcon QQuickLabsPlatformSystemTrayIcon::icon ( ) const

Since: Qt.labs.platform 1.1 (Qt 5.12) \qmlproperty url Qt.labs.platform::SystemTrayIcon::icon.source \qmlproperty string Qt.labs.platform::SystemTrayIcon::icon.name \qmlproperty bool Qt.labs.platform::SystemTrayIcon::icon.mask

This property holds the system tray icon.

SystemTrayIcon {
    icon.mask: true
    icon.source: "qrc:/images/tray-icon.png"
}

Definition at line 303 of file qquicklabsplatformsystemtrayicon.cpp.

References QQuickLabsPlatformIconLoader::icon().

Here is the call graph for this function:

◆ iconLoader()

QQuickLabsPlatformIconLoader * QQuickLabsPlatformSystemTrayIcon::iconLoader ( ) const

protected

Definition at line 390 of file qquicklabsplatformsystemtrayicon.cpp.

References QQuickLabsPlatformIconLoader::setEnabled().

Referenced by setIcon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

void QQuickLabsPlatformSystemTrayIcon::init ( )

protected

Definition at line 358 of file qquicklabsplatformsystemtrayicon.cpp.

References QQuickLabsPlatformIconLoader::setEnabled().

Referenced by componentComplete(), and setVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAvailable()

bool QQuickLabsPlatformSystemTrayIcon::isAvailable ( ) const

\readonly \qmlproperty bool Qt.labs.platform::SystemTrayIcon::available

This property holds whether the system tray is available.

Definition at line 177 of file qquicklabsplatformsystemtrayicon.cpp.

◆ isVisible()

bool QQuickLabsPlatformSystemTrayIcon::isVisible ( ) const

\qmlproperty bool Qt.labs.platform::SystemTrayIcon::visible

This property holds whether the system tray icon is visible.

The default value is false.

Definition at line 202 of file qquicklabsplatformsystemtrayicon.cpp.

◆ menu()

QQuickLabsPlatformMenu * QQuickLabsPlatformSystemTrayIcon::menu ( ) const

\qmlproperty Menu Qt.labs.platform::SystemTrayIcon::menu

This property holds a menu for the system tray icon.

Definition at line 250 of file qquicklabsplatformsystemtrayicon.cpp.

◆ menuChanged

void QQuickLabsPlatformSystemTrayIcon::menuChanged ( )

signal

◆ messageClicked

void QQuickLabsPlatformSystemTrayIcon::messageClicked ( )

signal

◆ Q_REVISION [1/2]

QQuickLabsPlatformSystemTrayIcon::Q_REVISION	(	1	,
		1	)

signal

◆ Q_REVISION [2/2]

QQuickLabsPlatformSystemTrayIcon::Q_REVISION	(	1	,
		1	)

signal

◆ setIcon()

void QQuickLabsPlatformSystemTrayIcon::setIcon ( const QQuickLabsPlatformIcon & icon )

Definition at line 311 of file qquicklabsplatformsystemtrayicon.cpp.

References QQuickLabsPlatformIconLoader::icon(), iconLoader(), QQuickLabsPlatformIcon::operator==(), and QQuickLabsPlatformIconLoader::setIcon().

Here is the call graph for this function:

◆ setMenu()

void QQuickLabsPlatformSystemTrayIcon::setMenu ( QQuickLabsPlatformMenu * menu )

Definition at line 255 of file qquicklabsplatformsystemtrayicon.cpp.

◆ setTooltip()

void QQuickLabsPlatformSystemTrayIcon::setTooltip ( const QString & tooltip )

Definition at line 233 of file qquicklabsplatformsystemtrayicon.cpp.

◆ setVisible()

void QQuickLabsPlatformSystemTrayIcon::setVisible ( bool visible )

Definition at line 207 of file qquicklabsplatformsystemtrayicon.cpp.

References cleanup(), and init().

Referenced by hide(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show

void QQuickLabsPlatformSystemTrayIcon::show ( )

slot

\qmlmethod void Qt.labs.platform::SystemTrayIcon::show()

Shows the system tray icon.

Definition at line 325 of file qquicklabsplatformsystemtrayicon.cpp.

References setVisible().

Here is the call graph for this function:

◆ showMessage

void QQuickLabsPlatformSystemTrayIcon::showMessage	(	const QString &	title,
		const QString &	msg,
		QPlatformSystemTrayIcon::MessageIcon	icon = QPlatformSystemTrayIcon::Information,
		int	msecs = 10000 )

slot

\qmlmethod void Qt.labs.platform::SystemTrayIcon::showMessage(string title, string message, MessageIcon icon, int msecs)

Shows a system tray message with the given title, message and icon for the time specified in msecs.

Note: System tray messages are dependent on the system configuration and user preferences, and may not appear at all. Therefore, it should not be relied upon as the sole means for providing critical information.

See also: supportsMessages, messageClicked()

Definition at line 352 of file qquicklabsplatformsystemtrayicon.cpp.

◆ supportsMessages()

bool QQuickLabsPlatformSystemTrayIcon::supportsMessages ( ) const

\readonly \qmlproperty bool Qt.labs.platform::SystemTrayIcon::supportsMessages

This property holds whether the system tray icon supports notification messages.

See also: showMessage()

Definition at line 190 of file qquicklabsplatformsystemtrayicon.cpp.

◆ tooltip()

QString QQuickLabsPlatformSystemTrayIcon::tooltip ( ) const

\qmlproperty string Qt.labs.platform::SystemTrayIcon::tooltip

This property holds the tooltip of the system tray icon.

Definition at line 228 of file qquicklabsplatformsystemtrayicon.cpp.

◆ tooltipChanged

void QQuickLabsPlatformSystemTrayIcon::tooltipChanged ( )

signal

◆ visibleChanged

void QQuickLabsPlatformSystemTrayIcon::visibleChanged ( )

signal

Property Documentation

◆ available

bool QQuickLabsPlatformSystemTrayIcon::available

read

Definition at line 40 of file qquicklabsplatformsystemtrayicon_p.h.

◆ geometry

QRect QQuickLabsPlatformSystemTrayIcon::geometry

read

Definition at line 45 of file qquicklabsplatformsystemtrayicon_p.h.

◆ icon

QQuickLabsPlatformIcon QQuickLabsPlatformSystemTrayIcon::icon

readwrite

Definition at line 46 of file qquicklabsplatformsystemtrayicon_p.h.

◆ menu

QQuickLabsPlatformMenu * QQuickLabsPlatformSystemTrayIcon::menu

readwrite

Definition at line 44 of file qquicklabsplatformsystemtrayicon_p.h.

◆ supportsMessages

bool QQuickLabsPlatformSystemTrayIcon::supportsMessages

read

Definition at line 41 of file qquicklabsplatformsystemtrayicon_p.h.

◆ tooltip

QString QQuickLabsPlatformSystemTrayIcon::tooltip

readwrite

Definition at line 43 of file qquicklabsplatformsystemtrayicon_p.h.

◆ visible

bool QQuickLabsPlatformSystemTrayIcon::visible

readwrite

Definition at line 42 of file qquicklabsplatformsystemtrayicon_p.h.

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

qtdeclarative/src/labs/platform/qquicklabsplatformsystemtrayicon_p.h (8c94259cf15bae652662e9af90f5d9a93689bc60)
qtdeclarative/src/labs/platform/qquicklabsplatformsystemtrayicon.cpp (8c94259cf15bae652662e9af90f5d9a93689bc60)

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QQuickLabsPlatformSystemTrayIcon()

◆ ~QQuickLabsPlatformSystemTrayIcon()

Member Function Documentation

◆ activated

◆ classBegin()

◆ cleanup()

◆ componentComplete()

◆ geometry()

◆ handle()

◆ hide

◆ icon()

◆ iconLoader()

◆ init()

◆ isAvailable()

◆ isVisible()

◆ menu()

◆ menuChanged

◆ messageClicked

◆ Q_REVISION [1/2]

◆ Q_REVISION [2/2]

◆ setIcon()

◆ setMenu()

◆ setTooltip()

◆ setVisible()

◆ show

◆ showMessage

◆ supportsMessages()

◆ tooltip()

◆ tooltipChanged

◆ visibleChanged

Property Documentation

◆ available

◆ geometry

◆ icon

◆ menu

◆ supportsMessages

◆ tooltip

◆ visible