aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCharles Kerr <charles.kerr@canonical.com>2013-06-21 15:01:54 +0000
committerTarmac <Unknown>2013-06-21 15:01:54 +0000
commit854fb1a47bed41e41e6fed9c5e498dc81146302a (patch)
treec0db59a66b90162a7f8ae2519430249ce5a5ffb6 /README
parent05ba6fa097260473c774d0d077d4e3add3db134b (diff)
parent51bd7465ac148a34ec37cb8760daf3b282b5ed6a (diff)
downloadayatana-indicator-datetime-854fb1a47bed41e41e6fed9c5e498dc81146302a.tar.gz
ayatana-indicator-datetime-854fb1a47bed41e41e6fed9c5e498dc81146302a.tar.bz2
ayatana-indicator-datetime-854fb1a47bed41e41e6fed9c5e498dc81146302a.zip
This push extracts geoclue to its own self-contained module, fixes an errant g_critical, and merges ryan's timedate1 changes from the 13.04 branch.
Approved by PS Jenkins bot, Lars Uebernickel.
Diffstat (limited to 'README')
-rw-r--r--README58
1 files changed, 58 insertions, 0 deletions
diff --git a/README b/README
index e69de29..c6a8780 100644
--- a/README
+++ b/README
@@ -0,0 +1,58 @@
+ACTIONS
+=======
+
+ * "activate-settings"
+ Description: opens a page for changing indicator-datetime's settings
+ State: None
+ Parameter: None
+
+ * "activate-planner"
+ Description: opens up a calendar appointment editor.
+ State: None
+ Parameter: int64, a time_t hinting which day/time to show in the planner,
+ or 0 for the current day
+
+ * "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-canonical-type s "com.canonical.indicator.calendar"
+
+ * Appointment
+ - label s short summary of the appointment
+ - x-canonical-type s "com.canonical.indicator.appointment"
+ - x-canonical-color s color of the appt's type, to give a visual cue
+ - x-canonical-time x the date of the appointment
+ - x-canonical-time-format s strftime format string
+
+ * Location
+ - label s the location's name, eg "Oklahoma City"
+ - x-canonical-type s "com.canonical.indicator.location"
+ - x-canonical-timezone s timezone that the location is in
+ - x-canonical-time-format s strftime format string
+
+