Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
StatusNotifierItem.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
6#include <PhosphorServiceSni/phosphorservicesni_export.h>
7
8#include <QImage>
9#include <QObject>
10#include <QString>
11
12#include <memory>
13
14namespace PhosphorServiceSni {
15
20class PHOSPHORSERVICESNI_EXPORT StatusNotifierItem : public QObject
21{
22 Q_OBJECT
23 Q_DISABLE_COPY_MOVE(StatusNotifierItem)
24 Q_PROPERTY(QString id READ id NOTIFY idChanged)
25 Q_PROPERTY(QString title READ title NOTIFY titleChanged)
26 Q_PROPERTY(QString category READ category NOTIFY categoryChanged)
27 Q_PROPERTY(Status status READ status NOTIFY statusChanged)
28 Q_PROPERTY(QImage iconImage READ iconImage NOTIFY iconChanged)
29 Q_PROPERTY(QImage overlayIconImage READ overlayIconImage NOTIFY iconChanged)
30 Q_PROPERTY(QImage attentionIconImage READ attentionIconImage NOTIFY iconChanged)
31 Q_PROPERTY(QString toolTipTitle READ toolTipTitle NOTIFY toolTipChanged)
32 Q_PROPERTY(QString toolTipBody READ toolTipBody NOTIFY toolTipChanged)
33 Q_PROPERTY(QString menuPath READ menuPath NOTIFY menuPathChanged)
34 Q_PROPERTY(bool itemIsMenu READ itemIsMenu NOTIFY menuPathChanged)
35 Q_PROPERTY(QString dbusService READ dbusService CONSTANT)
36 Q_PROPERTY(QString dbusPath READ dbusPath CONSTANT)
37 Q_PROPERTY(bool isValid READ isValid NOTIFY validChanged)
39
40public:
41 enum class Status {
42 Passive,
43 Active,
44 NeedsAttention
45 };
46 Q_ENUM(Status)
47
48
52 StatusNotifierItem(const QString& dbusService, const QString& dbusPath, QObject* parent = nullptr);
53 ~StatusNotifierItem() override;
54
55 [[nodiscard]] QString id() const;
56 [[nodiscard]] QString title() const;
57 [[nodiscard]] QString category() const;
58 [[nodiscard]] Status status() const;
59 [[nodiscard]] QImage iconImage() const;
60 [[nodiscard]] QImage overlayIconImage() const;
61 [[nodiscard]] QImage attentionIconImage() const;
62 [[nodiscard]] QString toolTipTitle() const;
63 [[nodiscard]] QString toolTipBody() const;
64 [[nodiscard]] QString menuPath() const;
65 [[nodiscard]] bool itemIsMenu() const;
66 [[nodiscard]] QString dbusService() const;
67 [[nodiscard]] QString dbusPath() const;
68 [[nodiscard]] bool isValid() const;
69
76 Q_INVOKABLE void setPreferredIconSize(int size);
77 [[nodiscard]] int preferredIconSize() const;
78
79public Q_SLOTS:
80 void activate(int x, int y);
81 void secondaryActivate(int x, int y);
82 void contextMenu(int x, int y);
83 void scroll(int delta, const QString& orientation);
84
85Q_SIGNALS:
86 void idChanged();
94
95private:
96 class Private;
97 std::unique_ptr<Private> d;
98};
99
100} // namespace PhosphorServiceSni
void scroll(int delta, const QString &orientation)
Status
Definition StatusNotifierItem.h:41
void setPreferredIconSize(int size)
Preferred render size in logical pixels.
StatusNotifierItem(const QString &dbusService, const QString &dbusPath, QObject *parent=nullptr)
dbusService is the unique bus name, dbusPath the object path.
Definition DBusMenuModel.h:13