Philip Withnall df3b4d302d breakManager: Add new state machine for screen time/health breaks
This implements health break reminder support in gnome-shell. It depends
on a
few bits and bobs from other modules:
 - New settings schemas in gsettings-desktop-schemas (released in
   47.beta, which Mutter already depends on)
 - A settings UI in gnome-control-center
 - User documentation in gnome-user-docs

It implements the design from
https://gitlab.gnome.org/Teams/Design/settings-mockups/-/blob/master/wellbeing/wellbeing.png.

The core of the implementation is `BreakManager`, which is a state
machine which uses the Mutter `IdleMonitor` to track whether the user
is, or should be, in a screen time break.

The `BreakDispatcher` is based on top of this, and controls showing
notifications, countdown timers, screen fades, the lock shield, etc. to
make the user aware of upcoming or due breaks, as per their notification
preferences.

Unit tests are included to check that `BreakManager` works. These
provide mock implementations of basic GLib clock functions, the
`IdleMonitor` and `Gio.Settings` in order to test the state machine in
faster-than-real-time.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

See: https://gitlab.gnome.org/Teams/Design/initiatives/-/issues/130
Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3251>
2024-11-28 10:44:10 +00:00
..
2019-02-05 16:25:57 +01:00

Gnome-shell OSK layouts are extracted from CLDR layout definitions:
https://www.unicode.org/cldr/charts/latest/keyboards/layouts/index.html

To add new layouts from CLDR:

1) Run update-osk-layouts.sh

2) Modify JSON files to add extra keys, tweak appearance...

2) Do git add and git commit

JSON file format
================

Each JSON file describes a keymap for a certain language and layout,
it has the following structure:

- Root (Object)

  Root object of a layout, has the following properties:

  - levels (Array of Level): Levels in the keymap
  - locale (String): Locale name for this keymap
  - name (String): Human readable name for this keymap

- Level (Object)

  A level defines the keys available on a keyboard level,
  these are the key panels visible at a time. E.g. to type
  uppercase levels or symbols.

  Levels have the following properties:

  - level (String): Name of the level, common names are
    "", "shift", "opt" and "opt+shift".
  - mode (String): Mode for this level, common modes are
    "default", "latched" and "locked".
  - rows (Array of Row): Array of rows of keys.

- Row (Array)

  A row is an Array of Key.

- Key (Object)

  A keyboard key. Keys have the following properties:

  - iconName (String): Icon name to show on the key.
    Keys with an icon name do not have a label.
  - label (String): Label to show on the key.
  - strings (Array of String): Strings to commit. If
    label property does not exist, the first element
    will be also the label. Extra elements are shown
    in the extra keys popover.
  - keyval (String): Hexadecimal keyval to emit as
    emulated key presses. Committed strings are
    preferred.
  - leftOffset (Double): If set, the left offset of
    this key, relative to the key immediately to the
    left, or the start of the row. If not set, the key
    will be implicitly located at the right of the
    previous key in the row. Multiples of 0.5 are
    accepted.
  - width (Double): Relative width of the key in the
    row. 1 is for a square key. Multiples of 0.5 are
    accepted. The implicit default value is 1.
  - height (Double): Relative height of the key in
    the grid. The key will overflow downwards. Multiples
    of 0.5 are accepted. The implicit default value is 1.
  - level (Integer): Level that the key switches to.
    See the levelSwitch action.
  - action (string): Action performed by the key,
    accepted actions are:

    - hide: Hides the OSK
    - languageMenu: Pops up the language selection
      menu
    - emoji: Switches to the emoji selection panel
    - modifier: Handles the keyval as a modifier
      key. This handles e.g. Ctrl+A as a sequence
      of Ctrl press, A press, A release, Ctrl
      release.
    - delete: Deletes text backwards
    - levelSwitch: Switches OSK to a different level