aurore::Theme

A handle on one variant's colours (not owned).

The colour name (getColor()).

A colour of the base (see ThemeValues::addColor).

The colour name as drawn now; an unknown key is fatal (check with hasColor()).

Whether the key exists.

The colours behind the handle.

The light variant's colours.

The dark variant's colours.

The colours of variant.

Uses a theme file (docs/themes.md), replacing the one used before:

name = Ocean
inherit = dark          # light, dark, another file or builtin:<id>
accent = #3fa7ff        # the palette: accent, background, surface,
                        # text, warning, danger; the rest derived
[colors]                # any key, for the variants it styles
aurore/sidebar/background = #0d1b2a
[light] / [dark]        # the same, for one variant only
[metrics]
aurore/highlight/stroke_width = 4

path is a file, a resource ("@res/themes/x.theme") or a preset ("builtin:high-contrast-dark", builtinThemes()). A line it cannot read is logged and skipped; false when the file cannot be read at all. The variant to show it in is put in variant when given (the one it styles, or the one in use when it styles both), for Platform::setThemeVariant. Text that reads badly on its background is logged as a warning (checkContrast). The screens take it at the next iteration of the main loop, which draws them again (redraw on demand or not).

As loadFile, from the file's text; directory is where its @include and inherit files are looked for.

Back to the look without a theme file.

With "builtin:seasonal" in use, the preset of the day (by local date: Halloween, Christmas, the seasons... docs/themes.md), used as soon as the date enters another one. The main loop calls it at each iteration; it looks at the wall clock once a minute (a console resuming from sleep included).

The preset "builtin:seasonal" uses at when (seconds since the epoch, read in local time): "builtin:halloween"...

The file in use ("" without one), as given to loadFile.

Whether the file in use styles variant (true without one): a file for one variant only leaves the other as it is without a file.

The picture the file in use puts behind every screen in the variant in use (background_image = file.png, next to the theme file), "" without one: drawn over aurore/clear, under the screens.

The background of variant with the file in use: its image (none without a file, or for a variant the file does not style), how it fits, its veil, the surfaces' opacity.

The decorations of variant with the file in use (backdrop.*, decor.*, particles*): none without a file, or for a variant the file does not style. ThemeDecorations draws them.

A file a theme names (its background_image, and any picture a theme key names), as a path: name is read from directory, the folder of the theme file (or included file) that names it, and must stay in root, the folder of the theme (a theme folder, or the folder of a single .theme file). No absolute path, no "x:/", no ".." out of root, no link out of it; "@res/..." only for a preset (directory "builtin:") or a theme that is itself a resource. False, with the reason in error, when it is refused. The one place theme files' pictures are resolved.

A path resolveAsset() made, looked at again just before the file is opened (from any thread): false, with the reason in error, when a link now takes it out of its theme's folder (put there after resolveAsset() looked). True for a path resolveAsset() did not check (a resource, a file named by the app). A hard link cannot be told from the file itself: a theme folder is only as safe as who can write in it.

The logo, icons, preview and image slots' pictures of variant with the file in use (none without a file, or for a variant it does not style): paths, nothing loaded.

The icons a theme may draw as pictures (icon.<name> = file.png): any other name is a warning. Cadran adds its own (CadranIcon).

Declares an image slot: a picture of the app's that a theme may replace (image.<key> = file.png), "playguard/loading/art". fallback is the app's own picture ("@res/img/art.png", a file; "" for none), maxSide the largest side it is made at (0: 1920 x 1080). Before the theme file is loaded: a theme naming a slot not declared is warned about. Declared again, the new fallback replaces the old one.

The image slots declared, sorted.

The picture of the image slot key now (UI thread): the theme's for the variant in use, else the slot's fallback (also when the theme's cannot be read); nullptr for neither, or a slot not declared. Loaded on the decode thread (ThemeImages): it may still be LOADING, and ThemeImages::getLoadedEvent() says when it is ready. Kept while the theme and the variant stay; a view keeping it gets the new one on Application::getThemeChangedEvent() (aurore::Image::setThemeImage does).

The theme's logo for the variant in use (UI thread), nullptr without one: for an app that draws its logo itself (Cadran's mark draws it). Made at most ThemeImages::LOGO_SIZE; ThemeImage::draw with CONTAIN.

The theme's picture for the icon name in the variant in use (UI thread), nullptr without one; tint says whether it is a mask, drawn in the icon's colour. Made at most ThemeImages::ICON_SIZE.

A key of a surface (a card, a panel) drawn over the screens' background: with a background image and surface_opacity under 1, its opacity is multiplied by it. The core's: aurore/sidebar/background, aurore/highlight/background, the default buttons' backgrounds; Cadran adds cadran/surf and cadran/surf2.

Reads a theme file without using it: its metadata, a preview, what is wrong with it. Its pictures are only looked for (an error when one is not there), never decoded, unless decodePictures: then each is decoded on the calling thread, to tell a broken file and to check the text on it (for a check off the UI thread: –check-themes, a test).

Every *.theme of directory (a folder, or a resource folder such as "@res/themes"), sorted by name: one entry per file, a broken one with its errors (never skipped, never fatal). Empty when the folder does not exist. From the main thread, as inspect(): the previews are made from the themes in use. Cheap: colours only, no picture decoded unless decodePictures (as inspect()).

The presets built into Aurore ("builtin:<id>" paths).

Reads a colour as theme files write it ("#2ec4b6", "#2ec4b680", "rgba(…)"); false if it is not one.

WCAG's contrast ratio of two opaque colours (1 to 21).

A pair checkContrast() looks at: ink drawn on surface (keys), at least minimum:1. A translucent colour is first blended over aurore/background. The core adds its own; Cadran its palette's.

The pairs of variant under their minimum, as "aurore/text on aurore/background: 3.1:1, under 4.5:1". With a background image whose colour is known (ThemeImages), text on aurore/background is checked on the image's average colour under its veil, and translucent surfaces over it.

Only the pairs the background image changes (text on the screens' background, translucent surfaces), on its average colour under its veil; empty without an image, or while its colour is not known.

Changes each time a colour or a metric changes (a theme file used, a colour added): the main loop compares it at each iteration to tell the views and draw them again.