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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
# Ayatana System Indicator — DateTime [](https://travis-ci.com/github/AyatanaIndicators/ayatana-indicator-datetime)
## About Ayatana Indicators
The Ayatana Indicators project is the continuation of Application
Indicators and System Indicators, two technologies developed by Canonical
Ltd. for the Unity7 desktop.
Application Indicators are a GTK implementation of the StatusNotifierItem
Specification (SNI) that was originally submitted to freedesktop.org by
KDE.
System Indicators are an extensions to the Application Indicators idea.
System Indicators allow for far more widgets to be displayed in the
indicator's menu.
The Ayatana Indicators project is the new upstream for application
indicators, system indicators and associated projects with a focus on
making Ayatana Indicators a desktop agnostic technology.
On GNU/Linux, Ayatana Indicators are currently available for desktop
envinronments like MATE (used by default in [Ubuntu
MATE](https://ubuntu-mate.com)), XFCE (used by default in
[Xubuntu](https://bluesabre.org/2021/02/25/xubuntu-21-04-progress-update/),
LXDE, and the Budgie Desktop).
The Lomiri Operating Environment (UI of the Ubuntu Touch OS, formerly
known as Unity8) uses Ayatana Indicators for rendering its notification
area and the [UBports](https://ubports.com) project is a core contributor
to the Ayatana Indicators project.
For further info, please visit:
https://ayatana-indicators.org
When using the -datetime Ayatana Indicator, make sure that the -datetime
Ubuntu Indicator (package name: indicator-datetime) is not installed.
## The Datetime Ayatana System Indicator
### Actions
* **desktop.open-settings-app**<br />
**phone.open-settings-app**
- Description: open the settings application.
- State: None
- Parameter: None
* **desktop.open-alarm-app**<br />
**phone.open-alarm-app**
- Description: open the application for creating new alarms.
- State: None
- Parameter: None
* **desktop.open-calendar-app**<br />
**phone.open-calendar-app**
- State: None
- Parameter: int64, a time_t hinting which day/time to show in the planner,
or 0 for the current day
* **desktop.open-appointment**<br />
**phone.open-appointment**
- Description: opens an appointment editor to the specified appointment.
- State: None
- Parameter: string, an opaque uid to specify which appointment to use.
This uid comes from the menuitems' target values.
* **set-location**
- Description: Set the current location. This will try to set the current
- timezone to the new location's timezone.
- State: None
- Parameter: a timezone id string followed by a space and location name.
- Example: **America/Chicago Oklahoma City**
* **calendar**
- Description: set which month/day should be given focus in the indicator's
calendar. The planner will look for appointments from this
day to the end of the same month.
Client code implementing the calendar view should call this
when the user clicks on a new day, month, or year.
- State: a dictionary containing these key value/pairs:
- **appointment-days**: an array of day-of-month ints. Used by the
calendar menuitem to mark appointment days.
- **calendar-day**: int64, a time_t. Used by the calendar menuitem
to know which year/month should be visible
and which day should have the cursor.
- **show-week-numbers**: if true, show week numbers in the calendar.
- Parameter: int64, a time_t specifying which year/month should be visible
and which day should have the cursor.
### Custom Menuitems
* Calendar
- x-ayatana-type s "org.ayatana.indicator.calendar"
* Alarm
- label s short summary of the appointment
- x-ayatana-type s "org.ayatana.indicator.alarm"
- x-ayatana-time x the date of the appointment
- x-ayatana-time-format s strftime format string
* Appointment
- label s short summary of the appointment
- x-ayatana-type s "org.ayatana.indicator.appointment"
- x-ayatana-color s color of the appt's type, to give a visual cue
- x-ayatana-time x the date of the appointment
- x-ayatana-time-format s strftime format string
* Location
- label s the location's name, eg "Oklahoma City"
- x-ayatana-type s "org.ayatana.indicator.location"
- x-ayatana-timezone s timezone that the location is in
- x-ayatana-time-format s strftime format string
### Code
#### Model
The app's model is represented by the "State" class, and "Menu" objects
are the corresponding views. "State" is a simple container for various
properties, and menus connect to those properties' changed() signals to
know when the view needs to be refreshed.
As one can see in main.c, the app's very simple flow is to instantiate
a state and its properties, build menus that correspond to the state,
and export the menus on DBus.
Because State is a simple aggregate of its components (such as a "Clock"
or "Planner" object to get the current time and upcoming appointments,
respectively), one can plug in live components for production and mock
components for unit tests. The entire backend can be mix-and-matched by
adding the desired test-or-production components.
Start with:<br />
include/datetime/state.h<br />
include/datetime/clock.h<br />
include/datetime/locations.h<br />
include/datetime/planner.h<br />
include/datetime/settings.h<br />
include/datetime/timezones.h<br />
Implementations:<br />
include/datetime/settings-live.h<br />
include/datetime/locations-settings.h<br />
include/datetime/planner-eds.h<br />
include/datetime/timezones-live.h<br />
#### View
Menu is a mostly-opaque class to wrap GMenu code. Its subclasses contain
the per-profile logic of which sections/menuitems to show and which to hide.
Menus are instantiated via the MenuFactory, which takes a state and profile.
Actions is a mostly-opaque class to wrap our GActionGroup. Its subclasses
contain the code that actually executed when an action is triggered (ie,
LiveActions for production and MockActions for testing).
Exporter exports the Actions and Menus onto the DBus, and also emits a
signal if/when the busname is lost so
ayatana-indicator-datetime-service knows when to exit.
include/datetime/menu.h<br />
include/datetime/actions.h<br />
include/datetime/exporter.h<br />
## License and Copyright
See COPYING and AUTHORS file in this project.
## Building and Testing
For instructions on building and running built-in tests, see the INSTALL.md file.
|
