Namespace

aurore

On this page

Namespaces
Classes
Functions
Enums
Types
Variables

Namespaces 2

aurore::literalsNamespace
aurore::testNamespace

Classes 136

aurore::AccountWidgetClass
aurore::ActionClass
aurore::ActivityAn activity is a "screen" of your app in which the library adds the UI components.
aurore::AnimatableClass
aurore::AppletFrameClass
aurore::AppletFrameItemStruct
aurore::ApplicationThe app: its window, its stack of activities, the focus, the inputs and the main loop.
aurore::AudioPlayerClass
aurore::AuroreKeyCombinationStruct
aurore::AuroreKeyStateClass
aurore::BatteryWidgetClass
aurore::BooleanCellClass
aurore::BottomBarClass
aurore::BoundViewClass
aurore::BoxGeneric FlexBox layout.
aurore::ButtonClass
aurore::ButtonLatchClass
aurore::ButtonStyleStruct
aurore::CheckBoxClass
aurore::ContextMenuClass
aurore::ContextMenuItemClass
aurore::ControllerStateStruct
aurore::DataModelClass
aurore::DebugLayerClass
aurore::DelayOperationStruct
aurore::DetailCellClass
aurore::DialogClass
aurore::DialogButtonClass
aurore::DropdownClass
aurore::EditTextDialogClass
aurore::EventClass
aurore::FiniteTickingClass
aurore::FontLoaderClass
aurore::FrameContextClass
aurore::FrameProfileStruct
aurore::GamepadActionClass
aurore::GestureRecognizerClass
aurore::HeaderClass
aurore::HeadlessImeManagerClass
aurore::HeadlessInputManagerClass
aurore::HeadlessPlatformClass
aurore::HeadlessVideoContextClass
aurore::HintClass
aurore::HintsClass
aurore::HotReloadWhat Application::setHotReload() turns on (docs/hot_reload.md); the core calls the rest.
aurore::HRecyclerFrameClass
aurore::HScrollingFrameClass
aurore::IconButtonClass
aurore::ImageAn image.
aurore::ImeManagerClass
aurore::IndexPathA cell's place in a RecyclerFrame: its section and row (item: the row, or the item's index for a grid).
aurore::InputCellClass
aurore::InputManagerClass
aurore::InputNumericCellClass
aurore::InspectorThe built-in inspector, turned on with Application::setInspectorEnabled() (docs/inspector.md).
aurore::KeyboardActionClass
aurore::KeyStateStruct
aurore::LabelSome text.
aurore::LayoutPresetA screen's layout in one go: the design size its screens are laid out on, the density of their lengths and the scale of their text (Application::usePreset).
aurore::LoggerClass
aurore::LongPressGestureRecognizerClass
aurore::LRUCacheLRU cache If the reference count is not 0, the cache will never expire.
aurore::MouseStateStruct
aurore::NodeStruct
aurore::NotificationClass
aurore::NotificationManagerClass
aurore::NullAudioPlayerClass
aurore::ObservableClass
aurore::PaddingAn empty view that has auto x auto and grow=1.0 to push all the next views in its box to the right (or to the bottom)
aurore::PanAccelerationStruct
aurore::PanGestureRecognizerClass
aurore::PanGestureStatusStruct
aurore::PlatformClass
aurore::PointStruct
aurore::ProfilerClass
aurore::ProgressSpinnerClass
aurore::RadioCellClass
aurore::RawMouseStateStruct
aurore::RawTouchStateStruct
aurore::ReadingXMLElementWhile it lives, the XML element being read (named in View::fatalXML's errors).
aurore::RectStruct
aurore::RectangleClass
aurore::RecyclerCellA cell of a RecyclerFrame, reused as the list scrolls: subclass it, fill it in RecyclerDataSource::cellForRow().
aurore::RecyclerContentBoxThe box a RecyclerFrame lays its cells in, which asks it where the focus goes.
aurore::RecyclerDataSourceWhat a RecyclerFrame shows: the app subclasses it and gives it with RecyclerFrame::setDataSource().
aurore::RecyclerFrameA list that makes only the cells on screen, and reuses them as it scrolls: a long list at the cost of a short one.
aurore::RecyclerHeaderA section's header in a RecyclerFrame: a title and a subtitle.
aurore::RecyclingGridClass
aurore::RecyclingGridContentBoxClass
aurore::RecyclingGridDataSourceClass
aurore::RecyclingGridItemClass
aurore::RecyclingViewClass
aurore::RepeatingTaskClass
aurore::RepeatingTimerClass
aurore::ScrollGestureRecognizerClass
aurore::ScrollingFrameA vertical-only frame that can scroll if its content overflows.
aurore::SelectorCellClass
aurore::SensorEventStruct
aurore::SidebarClass
aurore::SidebarItemClass
aurore::SidebarItemGroupClass
aurore::SidebarSeparatorClass
aurore::SingletonClass
aurore::SizeStruct
aurore::SliderClass
aurore::SliderCellClass
aurore::StyleSimple wrapper around StyleValues for the array operator.
aurore::StyleMetricA metric of the base, with its kind.
aurore::StyleValueStruct
aurore::StyleValuesThe metrics (sizes, margins, durations) by name, "aurore/sidebar/width"…: the ones the code adds, and over them a theme file's [metrics].
aurore::SubscriptionClass
aurore::TabFrameClass
aurore::TapGestureConfigStruct
aurore::TapGestureRecognizerClass
aurore::TapGestureStatusStruct
aurore::TextureCacheClass
aurore::ThemeThe colours views draw with, by key, for the light and the dark variant: Application::getTheme() is the variant in use.
aurore::ThemeBackgroundA variant's background, as a theme file sets it (docs/themes.md)
aurore::ThemeDecorA variant's decorations: one picture per area, and particles.
aurore::ThemeDecorationsWhat a theme decorates the screens with (docs/themes.md, Decorations), in the variant in use: a picture over the surface of an area (the header, the sidebar, the dialogs:…
aurore::ThemeIconA Cadran icon a theme draws as a picture (icon.<name>, docs/themes.md)
aurore::ThemeImageA picture a theme file names (its background_image, its logo, icons, preview, an app's image slots): a texture made from it, at most MAX_WIDTH x MAX_HEIGHT (or its options'…
aurore::ThemeImageOptionsHow a picture is made into a texture: ThemeImages::load's options.
aurore::ThemeImagesThe one loader of theme pictures.
aurore::ThemeInfoA theme file as listThemes() or inspect() read it, without applying it.
aurore::ThemeParticlesA variant's particles, as a theme file sets them (docs/themes.md).
aurore::ThemePictureA picture of the decorations, as a theme file sets it.
aurore::ThemePicturesA variant's pictures besides its background, as a theme file sets them (docs/themes.md, "Logos and images"): paths made by Theme::resolveAsset
aurore::ThemeValuesOne variant's colours by key ("aurore/text", "cadran/teal"…): the ones the code adds (the base), and over them the ones of the theme file in use.
aurore::ThreadingClass
aurore::TickingClass
aurore::TimerClass
aurore::TouchStateStruct
aurore::ViewSuperclass for all the other views Lifecycle of a view is : new -> [willAppear -> willDisappear] -> delete
aurore::ViewNotFoundExceptionClass
aurore::WirelessWidgetClass

Functions 46

void updateHighlightAnimation()

void getHighlightAnimation(float *gradient_x,float *gradient_y,float *color)

void setHighlightAnimationStill(bool still)

WidthClass widthClassOf(float width)

The class of a width in layout units.

application.hpp:77

std::string bidiVisual(const std::string &text)

bool bidiAvailable()

std::string localeFromSystem(std::string system)

The locale Aurore uses (one of the LOCALE_ above) for a system one: POSIX ("fr_FR.UTF-8", "pt_BR@euro"), BCP 47 ("fr-CA", "zh-Hant-TW") or a language alone ("de"). en-US when no locale of Aurore matches.

i18n.hpp:62

template <typename... Args>std::string getStr(std::string stringName, Args &&... args)

Returns the translation for the given string, after injecting format parameters (if any)

i18n.hpp:74

void loadTranslations()

Loads all translations of the current system locale + default locale Must be called before trying to get a translation!

i18n.hpp:93

void loadTranslations(const std::string &locale)

Loads the translations of locale in place of the current ones, while the app runs (the platform's locale is left as it is): the strings read after it are in that language

i18n.hpp:100

std::string operator""_i18n(const char *str, size_t len)

Returns the translation for the given string, without injecting any parameters Shortcut to aurore::getStr(stringName)

i18n.hpp:109

void setDensity(float density)

Sets the density, between DENSITY_MIN and DENSITY_MAX (a value outside is brought back in, NaN ignored). It scales the metrics of kind LENGTH, the XML numbers in dp and aurore::dp(), never the text (Application::setTextScale). The views read their sizes when they are made: set it before the screens are built, or build them again.

style.hpp:67

float getDensity()

The density in use (DENSITY_COMFORTABLE by default).

style.hpp:69

float dp(float length)

length at the density in use: what 16dp is in XML.

style.hpp:71

bool parseDensity(const std::string &text, float *density)

A density by name: "comfortable", "compact", "dense", or a number ("0.8"); false for anything else (and NaN).

style.hpp:76

Style getStyle()

The app's metrics: what XML reads with @style/….

style.hpp:138

void sync(std::function< void()> func)

Enqueue a function to be executed before the application is redrawn the next time.

Aurore is not thread-safe, and sync() provides a mechanism for queuing up UI-related state changes from other threads.

It's a shortcut for aurore::Application::sync(&func);

thread.hpp:58

void async(std::function< void()> func)

Enqueue a function to be executed in parallel with application's main thread.

It's a shortcut for aurore::Application::async(&func);

thread.hpp:66

size_t delay(long milliseconds, std::function< void()> func)

void cancelDelay(size_t iter)

Time getCPUTimeUsec()

Returns the current CPU time in microseconds: the simulated clock's while one is set (setSimulatedTimeUsec()), else the system's monotonic clock.

time.hpp:45

Time getRealTimeUsec()

Returns the system's monotonic clock in microseconds, even while a simulated clock is set (to measure how long something really took).

time.hpp:55

void setSimulatedTimeUsec(Time usec)

Replaces the clock read by getCPUTimeUsec() (animations, timers, delay(), button repeat...) with one that only moves when told: frames then run without waiting for real time, the same way every run. Used by the test harness (aurore::test::Harness). A negative value goes back to the real clock.

time.hpp:66

bool isTimeSimulated()

std::time_t getWallTime()

The wall clock (the dates and times shown), in seconds since the epoch: the system's, or the one set with setSimulatedWallTime(), which moves on with getCPUTimeUsec().

time.hpp:81

void setSimulatedWallTime(int64_t seconds)

Sets the wall clock to seconds since the epoch from now on (the test harness: the same date on every screenshot). A negative value goes back to the system's.

time.hpp:94

std::tm localTime(std::time_t time)

std::localtime() without its shared buffer: safe on any thread (the logger runs on the task thread too).

time.hpp:104

bool endsWith(const std::string &data, const std::string &suffix)

bool startsWith(const std::string &data, const std::string &prefix)

void fatal(std::string message)

Prints the given error message message and throws a std::logic_error.

util.hpp:30

std::string loadFileContents(const std::string &path)

bool readSmallFile(const std::string &path,size_t maxBytes,std::string *text)

The whole of a regular file of at most maxBytes bytes, in text. False, text untouched, for a file that is not there, is not a regular file (a folder, a pipe, a device) or is larger.

util.hpp:39

bool isResourceNameSafe(const std::string &name)

True for a resource name ("@res/…") with no ".." part: one that stays in the resources.

util.hpp:45

std::string escapeControlChars(const std::string &text)

text with its control characters (ASCII and C1) written as \xNN, for a log line or a message that quotes a file a user gave.

util.hpp:51

const char * environmentVariable(const std::string &name)

The environment variable AURORE_<name>: nullptr when it is not set.

util.hpp:54

void nameXMLDocument(const tinyxml2::XMLDocument *document,const std::string &name)

For the XML errors (View::fatalXML): the file or resource a document was read from, and the element being read while this lives

view.hpp:81

float ntz(float value)

Some YG values are NAN if not set, wrecking our calculations if we use them as they are

view.hpp:220

std::string accessibilityRoleName(AccessibilityRole role)

std::string accessibilityRoleWord(AccessibilityRole role)

std::string accessibilityStateWord(const std::string &state)

std::string accessibilityPercent(float fraction)

void setHintsFontScaleMax(float max)

float getHintsFontScaleMax()

void setHintsSteady(bool steady)

void setHintsOptionalOwner(View *owner)

View * getHintsOptionalOwner()

Enums 45

enum ActionType

Value
`ACTION_GAMEPAD`
`ACTION_KEYBOARD`
`ACTION_COUNT`

actions.hpp:104

enum class InputType

Input types for entire app.

Value	Description
`GAMEPAD`	Gamepad or keyboard.
`TOUCH`	Touch screen.

application.hpp:52

enum class WidthClass

How wide the screen is, in layout units (Application::contentWidth): what a layout picks its variant from (XML compact:, medium:, expanded:).

Value	Description
`COMPACT`	under WIDTH_MEDIUM: a phone, a small console screen (one column)
`MEDIUM`	under WIDTH_EXPANDED
`EXPANDED`	the 1280-unit design width and more

application.hpp:66

enum Sound

Value	Initializer
`SOUND_NONE`	`0`
`SOUND_FOCUS_CHANGE`
`SOUND_FOCUS_ERROR`
`SOUND_CLICK`
`SOUND_BACK`
`SOUND_FOCUS_SIDEBAR`
`SOUND_CLICK_ERROR`
`SOUND_HONK`
`SOUND_CLICK_SIDEBAR`
`SOUND_TOUCH_UNFOCUS`
`SOUND_TOUCH`
`SOUND_SLIDER_TICK`
`SOUND_SLIDER_RELEASE`
`_SOUND_MAX`

audio.hpp:22

enum class JustifyContent

How a box spreads its children along its axis (justifyContent in XML).

Value
`FLEX_START`
`CENTER`
`FLEX_END`
`SPACE_BETWEEN`
`SPACE_AROUND`
`SPACE_EVENLY`

box.hpp:26

enum class AlignItems

How a box places its children across its axis (alignItems in XML).

Value
`AUTO`
`FLEX_START`
`CENTER`
`FLEX_END`
`STRETCH`
`BASELINE`
`SPACE_BETWEEN`
`SPACE_AROUND`

box.hpp:37

enum class Axis

The direction a box lays its children out in (axis in XML).

Value
`ROW`
`COLUMN`

box.hpp:50

enum class Wrap

Whether a box's children go on to new lines when they do not fit (flexWrap).

Value
`NO_WRAP`
`WRAP`
`WRAP_REVERSE`

box.hpp:57

enum class Direction

The writing direction a box lays its children out in.

Value
`INHERIT`
`LEFT_TO_RIGHT`
`RIGHT_TO_LEFT`

box.hpp:65

enum class GestureState

Value
`INTERRUPTED`
`UNSURE`
`START`
`STAY`
`END`
`FAILED`

gesture.hpp:29

enum KeyboardKeyDisableBitmask

Value	Initializer
`KEYBOARD_DISABLE_NONE`	`0`
`KEYBOARD_DISABLE_SPACE`	`1`
`KEYBOARD_DISABLE_AT`	`1 << 1`
`KEYBOARD_DISABLE_PERCENT`	`1 << 2`
`KEYBOARD_DISABLE_FORWSLASH`	`1 << 3`
`KEYBOARD_DISABLE_BACKSLASH`	`1 << 4`
`KEYBOARD_DISABLE_NUMBERS`	`1 << 5`
`KEYBOARD_DISABLE_DOWNLOADCODE`	`1 << 6`
`KEYBOARD_DISABLE_USERNAME`	`1 << 7`

ime.hpp:27

enum AuroreKeyboardModifiers

Value	Initializer
`AURORE_KBD_MODIFIER_NONE`	`0x00`
`AURORE_KBD_MODIFIER_SHIFT`	`0x01`
`AURORE_KBD_MODIFIER_CTRL`	`0x02`
`AURORE_KBD_MODIFIER_ALT`	`0x04`
`AURORE_KBD_MODIFIER_META`	`0x08`

input.hpp:32

enum AuroreKeyboardScancode

HidKeyboardScancode Uses the same key codes as GLFW

Value	Initializer
`AURORE_KBD_KEY_UNKNOWN`	`-1`
`AURORE_KBD_KEY_SPACE`	`32`
`AURORE_KBD_KEY_APOSTROPHE`	`39`
`AURORE_KBD_KEY_COMMA`	`44`
`AURORE_KBD_KEY_MINUS`	`45`
`AURORE_KBD_KEY_PERIOD`	`46`
`AURORE_KBD_KEY_SLASH`	`47`
`AURORE_KBD_KEY_0`	`48`
`AURORE_KBD_KEY_1`	`49`
`AURORE_KBD_KEY_2`	`50`
`AURORE_KBD_KEY_3`	`51`
`AURORE_KBD_KEY_4`	`52`
`AURORE_KBD_KEY_5`	`53`
`AURORE_KBD_KEY_6`	`54`
`AURORE_KBD_KEY_7`	`55`
`AURORE_KBD_KEY_8`	`56`
`AURORE_KBD_KEY_9`	`57`
`AURORE_KBD_KEY_SEMICOLON`	`59`
`AURORE_KBD_KEY_EQUAL`	`61`
`AURORE_KBD_KEY_A`	`65`
`AURORE_KBD_KEY_B`	`66`
`AURORE_KBD_KEY_C`	`67`
`AURORE_KBD_KEY_D`	`68`
`AURORE_KBD_KEY_E`	`69`
`AURORE_KBD_KEY_F`	`70`
`AURORE_KBD_KEY_G`	`71`
`AURORE_KBD_KEY_H`	`72`
`AURORE_KBD_KEY_I`	`73`
`AURORE_KBD_KEY_J`	`74`
`AURORE_KBD_KEY_K`	`75`
`AURORE_KBD_KEY_L`	`76`
`AURORE_KBD_KEY_M`	`77`
`AURORE_KBD_KEY_N`	`78`
`AURORE_KBD_KEY_O`	`79`
`AURORE_KBD_KEY_P`	`80`
`AURORE_KBD_KEY_Q`	`81`
`AURORE_KBD_KEY_R`	`82`
`AURORE_KBD_KEY_S`	`83`
`AURORE_KBD_KEY_T`	`84`
`AURORE_KBD_KEY_U`	`85`
`AURORE_KBD_KEY_V`	`86`
`AURORE_KBD_KEY_W`	`87`
`AURORE_KBD_KEY_X`	`88`
`AURORE_KBD_KEY_Y`	`89`
`AURORE_KBD_KEY_Z`	`90`
`AURORE_KBD_KEY_LEFT_BRACKET`	`91`
`AURORE_KBD_KEY_BACKSLASH`	`92`
`AURORE_KBD_KEY_RIGHT_BRACKET`	`93`
`AURORE_KBD_KEY_GRAVE_ACCENT`	`96`
`AURORE_KBD_KEY_WORLD_1`	`161`
`AURORE_KBD_KEY_WORLD_2`	`162`
`AURORE_KBD_KEY_ESCAPE`	`256`
`AURORE_KBD_KEY_ENTER`	`257`
`AURORE_KBD_KEY_TAB`	`258`
`AURORE_KBD_KEY_BACKSPACE`	`259`
`AURORE_KBD_KEY_INSERT`	`260`
`AURORE_KBD_KEY_DELETE`	`261`
`AURORE_KBD_KEY_RIGHT`	`262`
`AURORE_KBD_KEY_LEFT`	`263`
`AURORE_KBD_KEY_DOWN`	`264`
`AURORE_KBD_KEY_UP`	`265`
`AURORE_KBD_KEY_PAGE_UP`	`266`
`AURORE_KBD_KEY_PAGE_DOWN`	`267`
`AURORE_KBD_KEY_HOME`	`268`
`AURORE_KBD_KEY_END`	`269`
`AURORE_KBD_KEY_CAPS_LOCK`	`280`
`AURORE_KBD_KEY_SCROLL_LOCK`	`281`
`AURORE_KBD_KEY_NUM_LOCK`	`282`
`AURORE_KBD_KEY_PRINT_SCREEN`	`283`
`AURORE_KBD_KEY_PAUSE`	`284`
`AURORE_KBD_KEY_F1`	`290`
`AURORE_KBD_KEY_F2`	`291`
`AURORE_KBD_KEY_F3`	`292`
`AURORE_KBD_KEY_F4`	`293`
`AURORE_KBD_KEY_F5`	`294`
`AURORE_KBD_KEY_F6`	`295`
`AURORE_KBD_KEY_F7`	`296`
`AURORE_KBD_KEY_F8`	`297`
`AURORE_KBD_KEY_F9`	`298`
`AURORE_KBD_KEY_F10`	`299`
`AURORE_KBD_KEY_F11`	`300`
`AURORE_KBD_KEY_F12`	`301`
`AURORE_KBD_KEY_F13`	`302`
`AURORE_KBD_KEY_F14`	`303`
`AURORE_KBD_KEY_F15`	`304`
`AURORE_KBD_KEY_F16`	`305`
`AURORE_KBD_KEY_F17`	`306`
`AURORE_KBD_KEY_F18`	`307`
`AURORE_KBD_KEY_F19`	`308`
`AURORE_KBD_KEY_F20`	`309`
`AURORE_KBD_KEY_F21`	`310`
`AURORE_KBD_KEY_F22`	`311`
`AURORE_KBD_KEY_F23`	`312`
`AURORE_KBD_KEY_F24`	`313`
`AURORE_KBD_KEY_F25`	`314`
`AURORE_KBD_KEY_KP_0`	`320`
`AURORE_KBD_KEY_KP_1`	`321`
`AURORE_KBD_KEY_KP_2`	`322`
`AURORE_KBD_KEY_KP_3`	`323`
`AURORE_KBD_KEY_KP_4`	`324`
`AURORE_KBD_KEY_KP_5`	`325`
`AURORE_KBD_KEY_KP_6`	`326`
`AURORE_KBD_KEY_KP_7`	`327`
`AURORE_KBD_KEY_KP_8`	`328`
`AURORE_KBD_KEY_KP_9`	`329`
`AURORE_KBD_KEY_KP_DECIMAL`	`330`
`AURORE_KBD_KEY_KP_DIVIDE`	`331`
`AURORE_KBD_KEY_KP_MULTIPLY`	`332`
`AURORE_KBD_KEY_KP_SUBTRACT`	`333`
`AURORE_KBD_KEY_KP_ADD`	`334`
`AURORE_KBD_KEY_KP_ENTER`	`335`
`AURORE_KBD_KEY_KP_EQUAL`	`336`
`AURORE_KBD_KEY_LEFT_SHIFT`	`340`
`AURORE_KBD_KEY_LEFT_CONTROL`	`341`
`AURORE_KBD_KEY_LEFT_ALT`	`342`
`AURORE_KBD_KEY_LEFT_SUPER`	`343`
`AURORE_KBD_KEY_RIGHT_SHIFT`	`344`
`AURORE_KBD_KEY_RIGHT_CONTROL`	`345`
`AURORE_KBD_KEY_RIGHT_ALT`	`346`
`AURORE_KBD_KEY_RIGHT_SUPER`	`347`
`AURORE_KBD_KEY_MENU`	`348`
`AURORE_KBD_KEY_LAST`

input.hpp:43

enum ControllerButton

Value	Initializer
`BUTTON_LT`	`0`
`BUTTON_LB`
`BUTTON_LSB`
`BUTTON_UP`
`BUTTON_RIGHT`
`BUTTON_DOWN`
`BUTTON_LEFT`
`BUTTON_BACK`
`BUTTON_GUIDE`
`BUTTON_START`
`BUTTON_RSB`
`BUTTON_Y`
`BUTTON_B`
`BUTTON_A`
`BUTTON_X`
`BUTTON_RB`
`BUTTON_RT`
`BUTTON_NAV_UP`
`BUTTON_NAV_RIGHT`
`BUTTON_NAV_DOWN`
`BUTTON_NAV_LEFT`
`_BUTTON_MAX`

input.hpp:178

enum ControllerAxis

Value
`LEFT_X`
`LEFT_Y`
`RIGHT_X`
`RIGHT_Y`
`LEFT_Z`
`RIGHT_Z`
`_AXES_MAX`

input.hpp:213

enum class SensorEventType

Value
`GYRO`
`ACCEL`

input.hpp:234

enum class TouchPhase

Value
`START`
`STAY`
`END`
`NONE`

input.hpp:258

enum class LogLevel

Value	Initializer
`LOG_ERROR`	`0`
`LOG_WARNING`
`LOG_INFO`
`LOG_DEBUG`
`LOG_VERBOSE`

logger.hpp:45

enum class MetricKind

What a metric is: a length (a size, a margin, a radius, in layout units) follows the density (setDensity), anything else (a duration, a font size, an opacity, a ratio) does not.

Value
`OTHER`
`LENGTH`

style.hpp:32

enum class ThemeVariant

The two sets of colours every theme has: light and dark.

Value
`LIGHT`
`DARK`

theme.hpp:36

enum class BackgroundFit

How a theme's background_image fills the window (background_fit)

Value	Description
`COVER`	scaled to cover it, centred, cut at the edges (the default)
`CONTAIN`	scaled to fit in it whole, centred, aurore/clear around it
`TILE`	repeated from the top left, one pixel per unit of the layout
`CENTER`	as is, one pixel per unit of the layout, centred

theme.hpp:71

enum class ThemeArea

What a decoration picture is drawn in (View::setThemeArea)

Value	Description
`NONE`
`HEADER`	backdrop.header: a screen's header, its whole width
`SIDEBAR`	backdrop.sidebar: the sidebar (Cadran's rail)
`DIALOG`	backdrop.dialog: dialogs, dropdowns, Cadran's sheets
`TOP`	decor.top: a strip along the top edge of the screen
`BOTTOM`	decor.bottom: along its bottom edge

theme.hpp:128

enum class ParticleKind

The particles a theme may draw (particles in a theme file).

Value
`NONE`
`SNOW`
`LEAVES`
`PETALS`
`EMBERS`
`CONFETTI`
`SPARKLES`
`HEARTS`
`BUBBLES`

theme.hpp:153

enum class ParticleLayer

particles_layer: behind the screens (under every view) or in front of them, fainter

Value
`BACK`
`FRONT`

theme.hpp:168

enum class PanAxis

Value
`HORIZONTAL`
`VERTICAL`
`ANY`

pan_gesture.hpp:52

enum class FocusDirection

Focus direction when navigating.

Value
`UP`
`DOWN`
`LEFT`
`RIGHT`

view.hpp:95

enum class ViewBackground

View background.

Value
`NONE`
`SIDEBAR`
`BACKDROP`
`SHAPE_COLOR`
`VERTICAL_LINEAR`
`HORIZONTAL_LINEAR`

view.hpp:104

enum class AlignSelf

Value
`AUTO`
`FLEX_START`
`CENTER`
`FLEX_END`
`STRETCH`
`BASELINE`
`SPACE_BETWEEN`
`SPACE_AROUND`

view.hpp:114

enum class Visibility

View visibility.

Value	Description
`VISIBLE`	the view is visible
`INVISIBLE`	the view is invisible but still takes some space
`GONE`	the view is invisible and doesn't take any space

view.hpp:127

enum class PositionType

Position attribute behavior.

Value	Description
`RELATIVE`	position attributes offset the view from the base layout
`ABSOLUTE`	position attributes set the absolute coordinates of the view
`STATIC`	position attributes are ignored, and absolute children are placed against an ancestor that is not static

view.hpp:135

enum class BoxSizing

What the width and height of a view measure.

Value	Description
`BORDER_BOX`	the whole view, padding and border included
`CONTENT_BOX`	the content only, padding and border are added to it

view.hpp:143

enum class TransitionAnimation

The animation to play when pushing / popping an activity or showing / hiding a view.

Value	Description
`FADE`	the old activity fades away and the new one fades in
`SLIDE_LEFT`	the old activity slides out to the left and the new one slides in from the right
`SLIDE_RIGHT`	inverted SLIDE_LEFT
`NONE`
`LINEAR`

view.hpp:152

enum class ShadowType

A View shape's shadow type.

Value	Description
`NONE`	do not draw any shadow around the shape
`GENERIC`	generic all-purpose shadow
`CUSTOM`	customized shadow (use the provided methods to tweak it)

view.hpp:162

enum class StyleState : uint8_t

Value	Initializer
`HOVER`	`1 << 0`
`FOCUS`	`1 << 1`
`PRESSED`	`1 << 2`
`DISABLED`	`1 << 3`

view_style.hpp:30

enum class AccessibilityRole : uint8_t

Value
`NONE`
`BUTTON`
`LABEL`
`HEADER`
`IMAGE`
`CELL`
`TOGGLE`
`SLIDER`
`TEXT_FIELD`
`TAB`
`LIST`
`DIALOG`

view_style.hpp:77

enum class HeaderStyle

Value
`REGULAR`
`POPUP`

applet_frame.hpp:31

enum class ButtonState

Value	Initializer
`ENABLED`	`0`
`DISABLED`

button.hpp:138

enum class ImageScalingType

This dictates what to do with the image if there is not enough room for the view to grow and display the whole image, or if the view is bigger than the image

Value	Description
`FIT`	The image is scaled to fit the view boundaries, aspect ratio is conserved.
`FILL`	The image is scaled to fill the view boundaries, aspect ratio is conserved.
`STRETCH`	The image is stretched to fit the view boundaries (aspect ratio is not conserved). The original image dimensions are entirely ignored in the layout process.
`CENTER`	The image is either cropped (not enough space) or untouched (too much space)

image.hpp:32

enum class ImageInterpolation

This dictates what interpolation to use when down / up scaling the image.

Value
`LINEAR`
`NEAREST`

image.hpp:45

enum class ImageAlignment

Alignment of the image inside the view for FIT and CROP scaling types.

Value
`TOP`
`RIGHT`
`BOTTOM`
`LEFT`
`CENTER`

image.hpp:52

enum class HorizontalAlign

Where a label's lines sit across its width.

Value
`LEFT`
`CENTER`
`RIGHT`

label.hpp:33

enum class VerticalAlign

Where a label's text sits in its height.

Value
`BASELINE`
`TOP`
`CENTER`
`BOTTOM`

label.hpp:41

enum class CursorPosition

An edit cursor's place in a label's text (Label::setCursor).

Value	Initializer
`UNSET`	`-2`
`END`	`-1`
`START`	`0`

label.hpp:50

enum ProgressSpinnerSize

Value
`NORMAL`
`LARGE`

progress_spinner.hpp:25

enum class ScrollingBehavior

How a ScrollingFrame follows the focus.

Value	Description
`NATURAL`	Inputs scroll the view like the scroll wheel on a web page, focus changes only when the next view to focus is fully on screen To work properly, there must be at least one focusable view in the "top" area of the frame (there should not be the need to scroll to see it)
`CENTERED`	The focused view is always in the center, inputs always change focus and scroll immediately.

scrolling_frame.hpp:30

Types 25

typedef std::function< bool(View *)> ActionListener

typedef int ActionIdentifier

typedef int AuroreKeyCode

using EasingFunction = tweeny::easing::enumerated

typedef std::function< View *(void)> XMLViewCreator

Makes a new view for an XML tag (Application::registerXMLView).

application.hpp:99

typedef std::unordered_map< std::string, int > FontStash

typedef std::vector< DelayOperation >::iterator DelayOperationIterator

typedef retro_time_t Time

typedef std::function< void()> TickingGenericCallback

typedef std::function< void(bool)> TickingEndCallback

typedef TickingGenericCallback TickingTickCallback

typedef Event< PanGestureStatus, Sound * > PanGestureEvent

typedef Event< TapGestureStatus, Sound * > TapGestureEvent

typedef Event< View * > GenericEvent

typedef Event VoidEvent

typedef std::function< void(void)> AutoAttributeHandler

typedef std::function< void(int)> IntAttributeHandler

typedef std::function< void(float)> FloatAttributeHandler

typedef std::function< void(std::string)> StringAttributeHandler

typedef std::function< void(NVGcolor)> ColorAttributeHandler

typedef std::function< void(bool)> BoolAttributeHandler

typedef std::function< void(std::string)> FilePathAttributeHandler

typedef struct aurore::ButtonStyle ButtonStyle

typedef Event< int > ValueSelectedEvent

typedef std::function< View *(void)> TabViewCreator

Variables 48

constexpr constexpr float WIDTH_MEDIUM = 720.0f

The narrowest MEDIUM width.

application.hpp:73

constexpr constexpr float WIDTH_EXPANDED = 1080.0f

The narrowest EXPANDED width.

application.hpp:74

constexpr constexpr LayoutPreset PRESET_STANDARD = { 1280, 720, DENSITY_COMFORTABLE, 1.0f }

The usual one: 1280x720 at density 1, the text as written.

application.hpp:93

constexpr constexpr LayoutPreset PRESET_SMALL_SCREEN = { 480, 360, DENSITY_DENSE, 1.25f }

A small screen, 320x240 pixels for instance: 480x360 units (a compact width), dense, the text 1.25 times larger (12 to 17 pixels).

application.hpp:96

static constexpr constexpr const int FONT_INVALID = -1

static const std::string FONT_REGULAR = "regular"

static const std::string FONT_KOREAN_REGULAR = "korean"

static const std::string FONT_CHINESE_SIMPLIFIED = "zh-Hans"

static const std::string FONT_CHINESE_SIMPLIFIED_EXT = "zh-Hans-ext"

static const std::string FONT_CHINESE_TRADITIONAL = "zh-Hant"

static const std::string FONT_JAPANESE = "ja"

static const std::string FONT_MATERIAL_ICONS = "material"

static const std::string FONT_SWITCH_ICONS = "switch"

static const std::string FONT_EMOJI = "emoji"

const std::string LOCALE_JA = "ja"

const std::string LOCALE_EN_US = "en-US"

const std::string LOCALE_EN_GB = "en-GB"

const std::string LOCALE_FR = "fr"

const std::string LOCALE_FR_CA = "fr-CA"

const std::string LOCALE_DE = "de"

const std::string LOCALE_IT = "it"

const std::string LOCALE_ES = "es"

const std::string LOCALE_ZH_CN = "zh-CN"

const std::string LOCALE_ZH_HANS = "zh-Hans"

const std::string LOCALE_ZH_HANT = "zh-Hant"

const std::string LOCALE_ZH_TW = "zh-TW"

const std::string LOCALE_Ko = "ko"

const std::string LOCALE_NL = "nl"

const std::string LOCALE_PT = "pt"

const std::string LOCALE_PT_BR = "pt-BR"

const std::string LOCALE_RU = "ru"

const std::string LOCALE_ES_419 = "es-419"

const std::string LOCALE_RYU = "ja-RYU"

custom locale

i18n.hpp:51

const std::string LOCALE_AUTO = "auto"

const std::string LOCALE_DEFAULT = LOCALE_EN_US

constexpr constexpr float DENSITY_COMFORTABLE = 1.0f

The density: lengths drawn that many times their size (aurore::dp()).

the default

style.hpp:54

constexpr constexpr float DENSITY_COMPACT = 0.85f

constexpr constexpr float DENSITY_DENSE = 0.7f

small screens

style.hpp:56

constexpr constexpr float DENSITY_MIN = 0.5f

constexpr constexpr float DENSITY_MAX = 1.5f

constexpr constexpr int THEME_AREA_COUNT = 5

HEADER to BOTTOM.

theme.hpp:137

const NVGcolor TRANSPARENT = nvgRGBA(0, 0, 0, 0)

const NVGcolor transparent

const ButtonStyle BUTTONSTYLE_PRIMARY = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,

    .highlightPadding = "aurore/button/primary_highlight_padding",
    .borderThickness  = "",

    .enabledBackgroundColor = "aurore/button/primary_enabled_background",
    .enabledLabelColor      = "aurore/button/primary_enabled_text",
    .enabledBorderColor     = "",

    .disabledBackgroundColor = "aurore/button/primary_disabled_background",
    .disabledLabelColor      = "aurore/button/primary_disabled_text",
    .disabledBorderColor     = "",
}

const ButtonStyle BUTTONSTYLE_HIGHLIGHT = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,

    .highlightPadding = "",
    .borderThickness  = "",

    .enabledBackgroundColor = "aurore/button/default_enabled_background",
    .enabledLabelColor      = "aurore/button/highlight_enabled_text",
    .enabledBorderColor     = "",

    .disabledBackgroundColor = "aurore/button/default_disabled_background",
    .disabledLabelColor      = "aurore/button/highlight_disabled_text",
    .disabledBorderColor     = "",
}

const ButtonStyle BUTTONSTYLE_DEFAULT = {
    .shadowType              = ShadowType::GENERIC,
    .hideHighlightBackground = true,

    .highlightPadding = "",
    .borderThickness  = "",

    .enabledBackgroundColor = "aurore/button/default_enabled_background",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "",

    .disabledBackgroundColor = "aurore/button/default_disabled_background",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "",
}

const ButtonStyle BUTTONSTYLE_BORDERED = {
    .shadowType              = ShadowType::NONE,
    .hideHighlightBackground = false,

    .highlightPadding = "",
    .borderThickness  = "aurore/button/border_thickness",

    .enabledBackgroundColor = "",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "aurore/button/enabled_border_color",

    .disabledBackgroundColor = "",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "aurore/button/disabled_border_color",
}

const ButtonStyle BUTTONSTYLE_BORDERLESS = {
    .shadowType              = ShadowType::NONE,
    .hideHighlightBackground = false,

    .highlightPadding = "",
    .borderThickness  = "",

    .enabledBackgroundColor = "",
    .enabledLabelColor      = "aurore/button/default_enabled_text",
    .enabledBorderColor     = "",

    .disabledBackgroundColor = "",
    .disabledLabelColor      = "aurore/button/default_disabled_text",
    .disabledBorderColor     = "",
}

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