\inmodule QtGui More...

#include <qplatformsystemtrayicon.h>

Inheritance diagram for QPlatformSystemTrayIcon:

Collaboration diagram for QPlatformSystemTrayIcon:

Public Types
enum	ActivationReason { Unknown , Context , DoubleClick , Trigger , MiddleClick }
	This enum describes the reason the system tray was activated. More...

enum	MessageIcon { NoIcon , Information , Warning , Critical }
	This enum describes the icon that is shown when a balloon message is displayed. More...

Signals
void	activated (QPlatformSystemTrayIcon::ActivationReason reason)
	This signal is emitted when the user activates the system tray icon.

void	contextMenuRequested (QPoint globalPos, const QPlatformScreen *screen)
	This signal is emitted when the context menu is requested.

void	messageClicked ()
	This signal is emitted when the message displayed using showMessage() was clicked by the user.

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
	QPlatformSystemTrayIcon ()

	~QPlatformSystemTrayIcon ()

virtual void	init ()=0
	This method is called to initialize the platform dependent implementation.

virtual void	cleanup ()=0
	This method is called to cleanup the platform dependent implementation.

virtual void	updateIcon (const QIcon &icon)=0
	This method is called when the icon did change.

virtual void	updateToolTip (const QString &tooltip)=0
	This method is called when the tooltip text did change.

virtual void	updateMenu (QPlatformMenu *menu)=0
	This method is called when the system tray menu did change.

virtual QRect	geometry () const =0
	This method returns the geometry of the platform dependent system tray icon on the screen.

virtual void	showMessage (const QString &title, const QString &msg, const QIcon &icon, MessageIcon iconType, int msecs)=0
	Shows a balloon message for the entry with the given title, message msg and icon for the time specified in msecs.

virtual bool	isSystemTrayAvailable () const =0
	Returns `true` if the system tray is available on the platform.

virtual bool	supportsMessages () const =0
	Returns `true` if the system tray supports messages on the platform.

virtual QPlatformMenu *	createMenu () const
	This method allows platforms to use a different QPlatformMenu for system tray menus than what would normally be used for e.g.

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

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

Properties inherited from QObject
QString	objectName
	the name of this object

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

\inmodule QtGui

The QPlatformSystemTrayIcon class abstracts the system tray icon and interaction.

See also: QSystemTrayIcon

Definition at line 21 of file qplatformsystemtrayicon.h.

Member Enumeration Documentation

◆ ActivationReason

enum QPlatformSystemTrayIcon::ActivationReason

This enum describes the reason the system tray was activated.

\value Unknown Unknown reason \value Context The context menu for the system tray entry was requested \value DoubleClick The system tray entry was double clicked \value Trigger The system tray entry was clicked \value MiddleClick The system tray entry was clicked with the middle mouse button

See also: activated()

Enumerator
Unknown
Context
DoubleClick
Trigger
MiddleClick

Definition at line 25 of file qplatformsystemtrayicon.h.

◆ MessageIcon

enum QPlatformSystemTrayIcon::MessageIcon

This enum describes the icon that is shown when a balloon message is displayed.

\value NoIcon No icon is shown. \value Information An information icon is shown. \value Warning A standard warning icon is shown. \value Critical A critical warning icon is shown.

See also: updateIcon(), showMessage(), QMessageBox

Enumerator
NoIcon
Information
Warning
Critical

Definition at line 34 of file qplatformsystemtrayicon.h.

Constructor & Destructor Documentation

◆ QPlatformSystemTrayIcon()

QPlatformSystemTrayIcon::QPlatformSystemTrayIcon ( )

Definition at line 50 of file qplatformsystemtrayicon.cpp.

◆ ~QPlatformSystemTrayIcon()

QPlatformSystemTrayIcon::~QPlatformSystemTrayIcon ( )

Definition at line 54 of file qplatformsystemtrayicon.cpp.

Member Function Documentation

◆ activated

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

signal

This signal is emitted when the user activates the system tray icon.

reason specifies the reason for activation.

See also: QSystemTrayIcon::ActivationReason, contextMenuRequested()

Referenced by QQuickLabsPlatformSystemTrayIcon::QQuickLabsPlatformSystemTrayIcon(), QStatusNotifierItemAdaptor::Activate(), QStatusNotifierItemAdaptor::ContextMenu(), QStatusNotifierItemAdaptor::SecondaryActivate(), and QWindowsSystemTrayIcon::winEvent().

Here is the caller graph for this function:

◆ cleanup()

void QPlatformSystemTrayIcon::cleanup ( )

pure virtual

This method is called to cleanup the platform dependent implementation.

Implemented in QDBusTrayIcon, QWindowsSystemTrayIcon, and QWidgetPlatformSystemTrayIcon.

Referenced by QQuickLabsPlatformSystemTrayIcon::cleanup().

Here is the caller graph for this function:

◆ contextMenuRequested

void QPlatformSystemTrayIcon::contextMenuRequested	(	QPoint	globalPos,
		const QPlatformScreen *	screen )

signal

This signal is emitted when the context menu is requested.

In particular, on platforms where createMenu() returns nullptr, its emission will cause QSystemTrayIcon to show a QMenu-based menu.

See also: activated()

Since: 5.10

Referenced by QWindowsSystemTrayIcon::winEvent().

Here is the caller graph for this function:

◆ createMenu()

QPlatformMenu * QPlatformSystemTrayIcon::createMenu ( ) const

virtual

This method allows platforms to use a different QPlatformMenu for system tray menus than what would normally be used for e.g.

menu bars. The default implementation falls back to a platform menu created by the platform theme, which may be null on platforms without native menus.