Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QDBusTrayIcon Class Reference

#include <qdbustrayicon_p.h>

Inheritance diagram for QDBusTrayIcon:
Collaboration diagram for QDBusTrayIcon:

Signals

void categoryChanged ()
void statusChanged (QString arg)
void tooltipChanged ()
void iconChanged ()
void attention ()
void menuChanged ()
Signals inherited from QPlatformSystemTrayIcon
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

 QDBusTrayIcon ()
virtual ~QDBusTrayIcon ()
QDBusMenuConnectiondBusConnection ()
void init () override
 This method is called to initialize the platform dependent implementation.
void cleanup () override
 This method is called to cleanup the platform dependent implementation.
void updateIcon (const QIcon &icon) override
 This method is called when the icon did change.
void updateToolTip (const QString &tooltip) override
 This method is called when the tooltip text did change.
void updateMenu (QPlatformMenu *menu) override
 This method is called when the system tray menu did change.
QPlatformMenucreateMenu () const override
 This method allows platforms to use a different QPlatformMenu for system tray menus than what would normally be used for e.g.
void showMessage (const QString &title, const QString &msg, const QIcon &icon, MessageIcon iconType, int msecs) override
 Shows a balloon message for the entry with the given title, message msg and icon for the time specified in msecs.
bool isSystemTrayAvailable () const override
 Returns true if the system tray is available on the platform.
bool supportsMessages () const override
 Returns true if the system tray supports messages on the platform.
QRect geometry () const override
 This method returns the geometry of the platform dependent system tray icon on the screen.
QString category () const
QString status () const
QString tooltip () const
QString iconName () const
const QIconicon () const
bool isRequestingAttention () const
QString attentionTitle () const
QString attentionMessage () const
QString attentionIconName () const
const QIconattentionIcon () const
QString instanceId () const
QDBusPlatformMenumenu ()
Public Member Functions inherited from QPlatformSystemTrayIcon
 QPlatformSystemTrayIcon ()
 ~QPlatformSystemTrayIcon ()
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 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).
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 category
QString status
QString tooltip
QString iconName
QIcon icon
bool isRequestingAttention
QString attentionTitle
QString attentionMessage
QString attentionIconName
QIcon attentionIcon
QDBusPlatformMenumenu
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Types inherited from QPlatformSystemTrayIcon
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...
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
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 36 of file qdbustrayicon_p.h.

Constructor & Destructor Documentation

◆ QDBusTrayIcon()

QDBusTrayIcon::QDBusTrayIcon ( )

Definition at line 89 of file qdbustrayicon.cpp.

References attention(), iconChanged(), instanceCount, menuChanged(), and tooltipChanged().

Here is the call graph for this function:

◆ ~QDBusTrayIcon()

QDBusTrayIcon::~QDBusTrayIcon ( )
virtual

Definition at line 120 of file qdbustrayicon.cpp.

Member Function Documentation

◆ attention

void QDBusTrayIcon::attention ( )
signal

Referenced by QDBusTrayIcon().

Here is the caller graph for this function:

◆ attentionIcon()

const QIcon & QDBusTrayIcon::attentionIcon ( ) const
inline

Definition at line 83 of file qdbustrayicon_p.h.

◆ attentionIconName()

QString QDBusTrayIcon::attentionIconName ( ) const
inline

Definition at line 82 of file qdbustrayicon_p.h.

◆ attentionMessage()

QString QDBusTrayIcon::attentionMessage ( ) const
inline

Definition at line 81 of file qdbustrayicon_p.h.

◆ attentionTitle()

QString QDBusTrayIcon::attentionTitle ( ) const
inline

Definition at line 80 of file qdbustrayicon_p.h.

◆ category()

QString QDBusTrayIcon::category ( ) const
inline

Definition at line 72 of file qdbustrayicon_p.h.

◆ categoryChanged

void QDBusTrayIcon::categoryChanged ( )
signal

◆ cleanup()

void QDBusTrayIcon::cleanup ( )
overridevirtual

This method is called to cleanup the platform dependent implementation.

Implements QPlatformSystemTrayIcon.

Definition at line 132 of file qdbustrayicon.cpp.

◆ createMenu()

QPlatformMenu * QDBusTrayIcon::createMenu ( ) const
overridevirtual

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.

See also
updateMenu()
Since
5.3

Reimplemented from QPlatformSystemTrayIcon.

Definition at line 246 of file qdbustrayicon.cpp.

◆ dBusConnection()

QDBusMenuConnection * QDBusTrayIcon::dBusConnection ( )

Definition at line 212 of file qdbustrayicon.cpp.

◆ geometry()

QRect QDBusTrayIcon::geometry ( ) const
inlineoverridevirtual

This method returns the geometry of the platform dependent system tray icon on the screen.

Implements QPlatformSystemTrayIcon.

Definition at line 70 of file qdbustrayicon_p.h.

◆ icon()

const QIcon & QDBusTrayIcon::icon ( ) const
inline

Definition at line 77 of file qdbustrayicon_p.h.

◆ iconChanged

void QDBusTrayIcon::iconChanged ( )
signal

Referenced by QDBusTrayIcon().

Here is the caller graph for this function:

◆ iconName()

QString QDBusTrayIcon::iconName ( ) const
inline

Definition at line 76 of file qdbustrayicon_p.h.

◆ init()

void QDBusTrayIcon::init ( )
overridevirtual

This method is called to initialize the platform dependent implementation.

Implements QPlatformSystemTrayIcon.

Definition at line 124 of file qdbustrayicon.cpp.

◆ instanceId()

QString QDBusTrayIcon::instanceId ( ) const
inline

Definition at line 85 of file qdbustrayicon_p.h.

◆ isRequestingAttention()

bool QDBusTrayIcon::isRequestingAttention ( ) const
inline

Definition at line 79 of file qdbustrayicon_p.h.

Referenced by QStatusNotifierItemAdaptor::toolTip().

Here is the caller graph for this function:

◆ isSystemTrayAvailable()

bool QDBusTrayIcon::isSystemTrayAvailable ( ) const
overridevirtual

Returns true if the system tray is available on the platform.

Implements QPlatformSystemTrayIcon.

Definition at line 336 of file qdbustrayicon.cpp.

◆ menu()

QDBusPlatformMenu * QDBusTrayIcon::menu ( )
inline

Definition at line 87 of file qdbustrayicon_p.h.

Referenced by QStatusNotifierItemAdaptor::menu().

Here is the caller graph for this function:

◆ menuChanged

void QDBusTrayIcon::menuChanged ( )
signal

Referenced by QDBusTrayIcon().

Here is the caller graph for this function:

◆ showMessage()

void QDBusTrayIcon::showMessage ( const QString & title,
const QString & msg,
const QIcon & icon,
QPlatformSystemTrayIcon::MessageIcon iconType,
int msecs )
overridevirtual

Shows a balloon message for the entry with the given title, message msg and icon for the time specified in msecs.

iconType is used as a hint for the implementing platform.

See also
QSystemTrayIcon::showMessage()

Implements QPlatformSystemTrayIcon.

Definition at line 272 of file qdbustrayicon.cpp.

◆ status()

QString QDBusTrayIcon::status ( ) const
inline

Definition at line 73 of file qdbustrayicon_p.h.

◆ statusChanged

void QDBusTrayIcon::statusChanged ( QString arg)
signal

◆ supportsMessages()

bool QDBusTrayIcon::supportsMessages ( ) const
inlineoverridevirtual

Returns true if the system tray supports messages on the platform.

Implements QPlatformSystemTrayIcon.

Definition at line 69 of file qdbustrayicon_p.h.

◆ tooltip()

QString QDBusTrayIcon::tooltip ( ) const
inline

Definition at line 74 of file qdbustrayicon_p.h.

◆ tooltipChanged

void QDBusTrayIcon::tooltipChanged ( )
signal

Referenced by QDBusTrayIcon().

Here is the caller graph for this function:

◆ updateIcon()

void QDBusTrayIcon::updateIcon ( const QIcon & icon)
overridevirtual

This method is called when the icon did change.

Implements QPlatformSystemTrayIcon.

Definition at line 224 of file qdbustrayicon.cpp.

◆ updateMenu()

void QDBusTrayIcon::updateMenu ( QPlatformMenu * menu)
overridevirtual

This method is called when the system tray menu did change.

Implements QPlatformSystemTrayIcon.

Definition at line 251 of file qdbustrayicon.cpp.

◆ updateToolTip()

void QDBusTrayIcon::updateToolTip ( const QString & tooltip)
overridevirtual

This method is called when the tooltip text did change.

Implements QPlatformSystemTrayIcon.

Definition at line 239 of file qdbustrayicon.cpp.

Property Documentation

◆ attentionIcon

QIcon QDBusTrayIcon::attentionIcon
read

Definition at line 48 of file qdbustrayicon_p.h.

◆ attentionIconName

QString QDBusTrayIcon::attentionIconName
read

Definition at line 47 of file qdbustrayicon_p.h.

◆ attentionMessage

QString QDBusTrayIcon::attentionMessage
read

Definition at line 46 of file qdbustrayicon_p.h.

◆ attentionTitle

QString QDBusTrayIcon::attentionTitle
read

Definition at line 45 of file qdbustrayicon_p.h.

◆ category

QString QDBusTrayIcon::category
read

Definition at line 39 of file qdbustrayicon_p.h.

◆ icon

QIcon QDBusTrayIcon::icon
read

Definition at line 43 of file qdbustrayicon_p.h.

◆ iconName

QString QDBusTrayIcon::iconName
read

Definition at line 42 of file qdbustrayicon_p.h.

◆ isRequestingAttention

bool QDBusTrayIcon::isRequestingAttention
read

Definition at line 44 of file qdbustrayicon_p.h.

◆ menu

QDBusPlatformMenu * QDBusTrayIcon::menu
read

Definition at line 49 of file qdbustrayicon_p.h.

◆ status

QString QDBusTrayIcon::status
read

Definition at line 40 of file qdbustrayicon_p.h.

◆ tooltip

QString QDBusTrayIcon::tooltip
read

Definition at line 41 of file qdbustrayicon_p.h.


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