Struct · aurore

aurore::ThemeInfo

A theme file as listThemes() or inspect() read it, without applying it.

On this page
aurore/core/theme.hpp
#include <aurore/core/theme.hpp>

struct aurore::ThemeInfo

Nested classes

Functions 6

const ThemeBackground & background(ThemeVariant variant) const
const ThemePictures & pictures(ThemeVariant variant) const
const ThemeDecor & decor(ThemeVariant variant) const
bool ok() const

Whether it was read without errors.

theme.hpp:279
ThemeVariant variant() const

The variant to show it in when it styles one only.

theme.hpp:281
bool styles(ThemeVariant variant) const

Whether it styles variant.

theme.hpp:283

Attributes 21

std::string path

as given to loadFile(); "builtin:<id>" for a preset

theme.hpp:211
std::string id

the file's name without its extension

theme.hpp:212
std::string name

its name, else the id

theme.hpp:213
std::string author

its author

theme.hpp:214
std::string version

its version

theme.hpp:215
std::string description

its description

theme.hpp:216
std::string backgroundImage

Its background_image: the dark variant's, else the light one's; "" without one (each variant's below)

theme.hpp:219
std::string icon

Its icon, the Cadran icon a picker shows it with ("snowflake"...), "" without one

theme.hpp:222
std::string counterpart

For a file that styles one variant, the theme file of the other one (counterpart, as given to loadFile; "" without one): what a picker switches to when the other variant is asked for.

theme.hpp:227
bool light = false

The variants it styles: one when it inherits light or dark, both when it has [light] and [dark] (it then follows the system's mode).

theme.hpp:231
bool dark = false
Preview lightPreview {}
Preview darkPreview {}
ThemeBackground lightBackground

Each variant's background (image, fit, dim, surface opacity)

theme.hpp:247
ThemeBackground darkBackground
ThemePictures lightPictures

Each variant's logo, icons, preview and image slots' pictures.

theme.hpp:255
ThemePictures darkPictures
ThemeDecor lightDecor

Each variant's decorations (backdrops, strips, particles)

theme.hpp:263
ThemeDecor darkDecor
std::vector< std::string > errors

"line 4: #12 is not a colour"…: lines skipped, files not found.

theme.hpp:271
std::vector< std::string > warnings

Unknown keys and text that reads badly on its background. Text on a background picture is checked only when the picture's colour is known: from an explicit check (inspect or listThemes with decodePictures), or once the picture was loaded in this run; a plain listing never decodes.

theme.hpp:276

Read from Aurore's headers by Doxygen at each build · library/include