kosslan/quickshell
1
0
Fork 0
forked from quickshell/quickshell
Code Pull requests Activity

service/tray!: refactor qml bindings to StatusNotifierItem

Browse source 
Breaking: Dropped SystemTrayMenuWatcher.
This commit is contained in:
outfoxxed 2024-11-21 04:59:48 -08:00
parent f53e6fb515
commit ac50767873
Signed by: outfoxxed
GPG key ID: 4C88A185FB89301E
4 changed files with 222 additions and 415 deletions
Download patch file Download diff file Expand all files Collapse all files

155
src/services/status_notifier/qml.hpp
View file

@ -9,116 +9,6 @@
#include "../../core/model.hpp"
#include "item.hpp"
///! Statis of a SystemTrayItem.
/// See @@SystemTrayItem.status.
namespace SystemTrayStatus { // NOLINT
Q_NAMESPACE;
QML_ELEMENT;
enum Enum {
/// A passive item does not convey important information and can be considered idle. You may want to hide these.
Passive = 0,
/// An active item may have information more important than a passive one and you probably do not want to hide it.
Active = 1,
/// An item that needs attention conveys very important information such as low battery.
NeedsAttention = 2,
};
Q_ENUM_NS(Enum);
} // namespace SystemTrayStatus
///! Category of a SystemTrayItem.
/// See @@SystemTrayItem.category.
namespace SystemTrayCategory { // NOLINT
Q_NAMESPACE;
QML_ELEMENT;
enum Enum {
/// The fallback category for general applications or anything that does
/// not fit into a different category.
ApplicationStatus = 0,
/// System services such as IMEs or disk indexing.
SystemServices = 1,
/// Hardware controls like battery indicators or volume control.
Hardware = 2,
};
Q_ENUM_NS(Enum);
} // namespace SystemTrayCategory
///! An item in the system tray.
/// A system tray item, roughly conforming to the [kde/freedesktop spec]
/// (there is no real spec, we just implemented whatever seemed to actually be used).
///
/// [kde/freedesktop spec]: https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/StatusNotifierItem/
class SystemTrayItem: public QObject {
using DBusMenuItem = qs::dbus::dbusmenu::DBusMenuItem;
// intentionally wrongly aliased to temporarily hack around a docgen issue
using QsMenuHandle = qs::dbus::dbusmenu::DBusMenuHandle;
Q_OBJECT;
/// A name unique to the application, such as its name.
Q_PROPERTY(QString id READ id NOTIFY idChanged);
/// Text that describes the application.
Q_PROPERTY(QString title READ title NOTIFY titleChanged);
Q_PROPERTY(SystemTrayStatus::Enum status READ status NOTIFY statusChanged);
Q_PROPERTY(SystemTrayCategory::Enum category READ category NOTIFY categoryChanged);
/// Icon source string, usable as an Image source.
Q_PROPERTY(QString icon READ icon NOTIFY iconChanged);
Q_PROPERTY(QString tooltipTitle READ tooltipTitle NOTIFY tooltipTitleChanged);
Q_PROPERTY(QString tooltipDescription READ tooltipDescription NOTIFY tooltipDescriptionChanged);
/// If this tray item has an associated menu accessible via @@display() or @@menu.
Q_PROPERTY(bool hasMenu READ hasMenu NOTIFY hasMenuChanged);
/// A handle to the menu associated with this tray item, if any.
///
/// Can be displayed with @@Quickshell.QsMenuAnchor or @@Quickshell.QsMenuOpener.
Q_PROPERTY(qs::menu::QsMenuHandle* menu READ menu NOTIFY hasMenuChanged);
/// If this tray item only offers a menu and activation will do nothing.
Q_PROPERTY(bool onlyMenu READ onlyMenu NOTIFY onlyMenuChanged);
QML_ELEMENT;
QML_UNCREATABLE("SystemTrayItems can only be acquired from SystemTray");
public:
explicit SystemTrayItem(qs::service::sni::StatusNotifierItem* item, QObject* parent = nullptr);
/// Primary activation action, generally triggered via a left click.
Q_INVOKABLE void activate() const;
/// Secondary activation action, generally triggered via a middle click.
Q_INVOKABLE void secondaryActivate() const;
/// Scroll action, such as changing volume on a mixer.
Q_INVOKABLE void scroll(qint32 delta, bool horizontal) const;
/// Display a platform menu at the given location relative to the parent window.
Q_INVOKABLE void display(QObject* parentWindow, qint32 relativeX, qint32 relativeY);
[[nodiscard]] QString id() const;
[[nodiscard]] QString title() const;
[[nodiscard]] SystemTrayStatus::Enum status() const;
[[nodiscard]] SystemTrayCategory::Enum category() const;
[[nodiscard]] QString icon() const;
[[nodiscard]] QString tooltipTitle() const;
[[nodiscard]] QString tooltipDescription() const;
[[nodiscard]] bool hasMenu() const;
[[nodiscard]] QsMenuHandle* menu() const;
[[nodiscard]] bool onlyMenu() const;
qs::service::sni::StatusNotifierItem* item = nullptr;
signals:
void idChanged();
void titleChanged();
void statusChanged();
void categoryChanged();
void iconChanged();
void tooltipTitleChanged();
void tooltipDescriptionChanged();
void hasMenuChanged();
void onlyMenuChanged();
};
///! System tray
/// Referencing the SystemTray singleton will make quickshell start tracking
/// system tray contents, which are updated as the tray changes, and can be
@ -126,7 +16,7 @@ signals:
class SystemTray: public QObject {
Q_OBJECT;
/// List of all system tray icons.
QSDOC_TYPE_OVERRIDE(ObjectModel<SystemTrayItem>*);
QSDOC_TYPE_OVERRIDE(ObjectModel<qs::service::sni::StatusNotifierItem>*);
Q_PROPERTY(UntypedObjectModel* items READ items CONSTANT);
QML_ELEMENT;
QML_SINGLETON;
@ -134,51 +24,12 @@ class SystemTray: public QObject {
public:
explicit SystemTray(QObject* parent = nullptr);
[[nodiscard]] ObjectModel<SystemTrayItem>* items();
[[nodiscard]] ObjectModel<qs::service::sni::StatusNotifierItem>* items();
private slots:
void onItemRegistered(qs::service::sni::StatusNotifierItem* item);
void onItemUnregistered(qs::service::sni::StatusNotifierItem* item);
private:
ObjectModel<SystemTrayItem> mItems {this};
};
///! Accessor for SystemTrayItem menus.
/// > [!ERROR] Deprecated in favor of @@Quickshell.QsMenuOpener.menu,
/// > which now supports directly accessing a tray menu via @@SystemTrayItem.menu.
///
/// SystemTrayMenuWatcher provides access to the associated
/// @@Quickshell.DBusMenu.DBusMenuItem for a tray item.
class SystemTrayMenuWatcher: public QObject {
using DBusMenu = qs::dbus::dbusmenu::DBusMenu;
using DBusMenuItem = qs::dbus::dbusmenu::DBusMenuItem;
Q_OBJECT;
/// The tray item to watch.
Q_PROPERTY(SystemTrayItem* trayItem READ trayItem WRITE setTrayItem NOTIFY trayItemChanged);
/// The menu associated with the tray item. Will be null if @@trayItem is null
/// or has no associated menu.
Q_PROPERTY(DBusMenuItem* menu READ menu NOTIFY menuChanged);
QML_ELEMENT;
public:
explicit SystemTrayMenuWatcher(QObject* parent = nullptr): QObject(parent) {}
~SystemTrayMenuWatcher() override;
Q_DISABLE_COPY_MOVE(SystemTrayMenuWatcher);
[[nodiscard]] SystemTrayItem* trayItem() const;
void setTrayItem(SystemTrayItem* item);
[[nodiscard]] DBusMenuItem* menu() const;
signals:
void trayItemChanged();
void menuChanged();
private slots:
void onItemDestroyed();
private:
SystemTrayItem* item = nullptr;
ObjectModel<qs::service::sni::StatusNotifierItem> mItems {this};
};