blob: eabe4344c8ab4bb5290617c0c835301bf6a1d5b6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
// Copyright (C) 2026 Danilo M. <danix@danix.xyz>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2 as
// published by the Free Software Foundation.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
import QtQuick
// What a module declares to the drawer.
//
// A module provides a tile, a page, both, or neither. A tile with no page
// calls activate() when clicked. A module with neither is a pure background
// service. A module may also own windows outside the drawer entirely, as
// sound does with its OSD.
//
// Nothing here enforces anything: a module is free to do something unusual.
// This file is documentation with defaults.
QtObject {
// Identifies the module to IPC: `ipc call drawer open <name>`.
required property string name
// Shown on the tile. A Nerd Font glyph.
property string icon: ""
// Label under the icon. Defaults to the name, capitalised.
property string label: name.charAt(0).toUpperCase() + name.slice(1)
// Declarative metadata: whether this module's service is meant to run
// while the drawer is closed. The drawer does not read or enforce it, the
// module implements its own lifetime. Pages are lazily loaded either way.
property bool alwaysActive: false
// Rendered inside the tile, below the icon: a short state line. Null for
// a tile that says nothing beyond its label.
property Component tileContent: null
// The full-height page behind the tile. Null means the tile is
// fire-and-forget and activate() is called instead.
property Component page: null
// What a tile with no page does when clicked.
function activate() {}
}
|