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
QWidgetPlatformSystemTrayIcon Class Reference

#include <qwidgetplatformsystemtrayicon_p.h>

+ Inheritance diagram for QWidgetPlatformSystemTrayIcon:
+ Collaboration diagram for QWidgetPlatformSystemTrayIcon:

Public Member Functions

 QWidgetPlatformSystemTrayIcon (QObject *parent=nullptr)
 
 ~QWidgetPlatformSystemTrayIcon ()
 
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.
 
QRect geometry () const override
 This method returns the geometry of the platform dependent system tray icon on the screen.
 
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.
 
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.
 
- 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 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.
 

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
 
- 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.
 
- 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
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

Definition at line 27 of file qwidgetplatformsystemtrayicon_p.h.

Constructor & Destructor Documentation

◆ QWidgetPlatformSystemTrayIcon()

QT_BEGIN_NAMESPACE QWidgetPlatformSystemTrayIcon::QWidgetPlatformSystemTrayIcon ( QObject * parent = nullptr)
explicit

Definition at line 11 of file qwidgetplatformsystemtrayicon.cpp.

References QWidgetPlatformSystemTrayIcon(), QSystemTrayIcon::activated(), QObject::connect(), QScopedPointer< T, Cleanup >::data(), QPlatformSystemTrayIcon::messageClicked(), QSystemTrayIcon::messageClicked(), QObject::parent(), and QObject::setParent().

Referenced by QWidgetPlatformSystemTrayIcon().

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

◆ ~QWidgetPlatformSystemTrayIcon()

QWidgetPlatformSystemTrayIcon::~QWidgetPlatformSystemTrayIcon ( )

Definition at line 22 of file qwidgetplatformsystemtrayicon.cpp.

References ~QWidgetPlatformSystemTrayIcon().

Referenced by ~QWidgetPlatformSystemTrayIcon().

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

Member Function Documentation

◆ cleanup()

void QWidgetPlatformSystemTrayIcon::cleanup ( )
overridevirtual

This method is called to cleanup the platform dependent implementation.

Implements QPlatformSystemTrayIcon.

Definition at line 31 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::hide().

+ Here is the call graph for this function:

◆ createMenu()

QPlatformMenu * QWidgetPlatformSystemTrayIcon::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 80 of file qwidgetplatformsystemtrayicon.cpp.

References QWidgetPlatformMenu.

◆ geometry()

QRect QWidgetPlatformSystemTrayIcon::geometry ( ) const
overridevirtual

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

Implements QPlatformSystemTrayIcon.

Definition at line 59 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::geometry().

+ Here is the call graph for this function:

◆ init()

void QWidgetPlatformSystemTrayIcon::init ( )
overridevirtual

This method is called to initialize the platform dependent implementation.

Implements QPlatformSystemTrayIcon.

Definition at line 26 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::show().

+ Here is the call graph for this function:

◆ isSystemTrayAvailable()

bool QWidgetPlatformSystemTrayIcon::isSystemTrayAvailable ( ) const
overridevirtual

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

Implements QPlatformSystemTrayIcon.

Definition at line 70 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::isSystemTrayAvailable().

+ Here is the call graph for this function:

◆ showMessage()

void QWidgetPlatformSystemTrayIcon::showMessage ( const QString & title,
const QString & msg,
const QIcon & icon,
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 64 of file qwidgetplatformsystemtrayicon.cpp.

References icon, Q_UNUSED, QSystemTrayIcon::showMessage(), and title.

+ Here is the call graph for this function:

◆ supportsMessages()

bool QWidgetPlatformSystemTrayIcon::supportsMessages ( ) const
overridevirtual

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

Implements QPlatformSystemTrayIcon.

Definition at line 75 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::supportsMessages().

+ Here is the call graph for this function:

◆ updateIcon()

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

This method is called when the icon did change.

Implements QPlatformSystemTrayIcon.

Definition at line 36 of file qwidgetplatformsystemtrayicon.cpp.

References icon, and QSystemTrayIcon::setIcon().

+ Here is the call graph for this function:

◆ updateMenu()

void QWidgetPlatformSystemTrayIcon::updateMenu ( QPlatformMenu * menu)
overridevirtual

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

Implements QPlatformSystemTrayIcon.

Definition at line 46 of file qwidgetplatformsystemtrayicon.cpp.

References menu, and Q_UNUSED.

◆ updateToolTip()

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

This method is called when the tooltip text did change.

Implements QPlatformSystemTrayIcon.

Definition at line 41 of file qwidgetplatformsystemtrayicon.cpp.

References QSystemTrayIcon::setToolTip().

+ Here is the call graph for this function:

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