API reference
Every class
The 174 classes and structs of Aurore's public headers, by namespace.
On this page
aurore 137
aurore::AccountWidgetClassaurore::ActionClassaurore::ActivityAn activity is a "screen" of your app in which the library adds the UI components.aurore::AnimatableClassaurore::AppletFrameClassaurore::AppletFrameItemStructaurore::ApplicationThe app: its window, its stack of activities, the focus, the inputs and the main loop.aurore::AudioPlayerClassaurore::AuroreKeyCombinationStructaurore::AuroreKeyStateClassaurore::BatteryWidgetClassaurore::BooleanCellClassaurore::BottomBarClassaurore::BoundViewClassaurore::BoxGeneric FlexBox layout.aurore::ButtonClassaurore::ButtonLatchClassaurore::ButtonStyleStructaurore::CheckBoxClassaurore::ContextMenuClassaurore::ContextMenuItemClassaurore::ControllerStateStructaurore::DataModelClassaurore::DebugLayerClassaurore::DelayOperationStructaurore::DetailCellClassaurore::DialogClassaurore::DialogButtonClassaurore::DropdownClassaurore::EditTextDialogClassaurore::EventClassaurore::FiniteTickingClassaurore::FontLoaderClassaurore::FrameContextClassaurore::FrameProfileStructaurore::GamepadActionClassaurore::GestureRecognizerClassaurore::HeaderClassaurore::HeadlessImeManagerClassaurore::HeadlessInputManagerClassaurore::HeadlessPlatformClassaurore::HeadlessVideoContextClassaurore::HintClassaurore::HintsClassaurore::HotReloadWhat Application::setHotReload() turns on (docs/hot_reload.md); the core calls the rest.aurore::HRecyclerFrameClassaurore::HScrollingFrameClassaurore::IconButtonClassaurore::ImageAn image.aurore::ImeManagerClassaurore::IndexPathA cell's place in a RecyclerFrame: its section and row (item: the row, or the item's index for a grid).aurore::InputCellClassaurore::InputManagerClassaurore::InputNumericCellClassaurore::InspectorThe built-in inspector, turned on with Application::setInspectorEnabled() (docs/inspector.md).aurore::KeyboardActionClassaurore::KeyStateStructaurore::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::LoggerClassaurore::LongPressGestureRecognizerClassaurore::LRUCacheLRU cache If the reference count is not 0, the cache will never expire.aurore::MouseStateStructaurore::NodeStructaurore::NotificationClassaurore::NotificationManagerClassaurore::NullAudioPlayerClassaurore::ObservableClassaurore::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::PanAccelerationStructaurore::PanGestureRecognizerClassaurore::PanGestureStatusStructaurore::PlatformClassaurore::PointStructaurore::ProfilerClassaurore::ProgressSpinnerClassaurore::RadioCellClassaurore::RawMouseStateStructaurore::RawTouchStateStructaurore::ReadingXMLElementWhile it lives, the XML element being read (named in View::fatalXML's errors).aurore::RectStructaurore::RectangleClassaurore::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::RecyclingGridClassaurore::RecyclingGridContentBoxClassaurore::RecyclingGridDataSourceClassaurore::RecyclingGridItemClassaurore::RecyclingViewClassaurore::RepeatingTaskClassaurore::RepeatingTimerClassaurore::ScrollGestureRecognizerClassaurore::ScrollingFrameA vertical-only frame that can scroll if its content overflows.aurore::SelectorCellClassaurore::SensorEventStructaurore::SidebarClassaurore::SidebarItemClassaurore::SidebarItemGroupClassaurore::SidebarSeparatorClassaurore::SingletonClassaurore::SizeStructaurore::SliderClassaurore::SliderCellClassaurore::StyleSimple wrapper around StyleValues for the array operator.aurore::StyleMetricA metric of the base, with its kind.aurore::StyleValueStructaurore::StyleValuesThe metrics (sizes, margins, durations) by name, "aurore/sidebar/width"…: the ones the code adds, and over them a theme file's [metrics].aurore::SubscriptionClassaurore::TabFrameClassaurore::TapGestureConfigStructaurore::TapGestureRecognizerClassaurore::TapGestureStatusStructaurore::TextureCacheClassaurore::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::ThemeInfo::PreviewA few colours to show it in a picker, per variant it styles.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::resolveAssetaurore::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::ThreadingClassaurore::TickingClassaurore::TimerClassaurore::TouchStateStructaurore::ViewSuperclass for all the other views Lifecycle of a view is : new -> [willAppear -> willDisappear] -> deleteaurore::ViewNotFoundExceptionClassaurore::WirelessWidgetClass
The global namespace 12
CadranDigitsA line of text in Cadran's display face (Sora): big figures, card values, chips.CadranIconOne of Cadran's vector icons (<CadranIcon icon="today"> in XML), drawn as nanovg paths, or as the theme's picture for it (icon.<name>).CadranSwatchA few colours shown in an icon's place, the size of a row's icon square (cadran::List::row): a palette's in its picker (ui::pick()'s swatches).CadranSwatch::ColorsStructFooterHintsThe footer's hints fitted to the footer: the clock keeps its line, the hints come closer, then their texts are cut.HeaderSettingThe language, theme and text size in the main screen's header: a tap opens their picker.LoadingBarA progress bar that eases to each new value (the loading screen's, a list's).QrViewA QR code of a text, dark on white with its quiet zone whatever the theme.ScrollViewThe scrolling frame of Cadran's screens (<ScrollView>): each press moves to the next line and scrolls just enough to show it with its header and notes.TabBadgeThe number of things to do in a tab, an amber disc by its name in the sidebar (or on its icon) and on the row where they are done.VersionBadgeThe running version by every screen's title: grey for a release, amber with the commit for any other build.VideoContextClass
aurore::test 4
aurore::test::HarnessClassaurore::test::ImageStructaurore::test::ImageDiffStructaurore::test::OptionsStruct
cadran 6
cadran::CardA card of the lists: a rounded surface with a 1 px border (accent, the line colour unless set) drawn behind its rows, the rows' separators kept on all but the last visible one.cadran::ListThe Cadran look of a list screen built as usual: its headers as kickers, its cells in cards with icons, chevrons and switches, a few cells as tiles.cadran::PillModeA mode of the app the main screen's pill says over what every screen says, as long as it lasts (ui::hooks' pill fills it in; read-only is Aurore's own): its text, icon and…cadran::ProgressA dialog's body while something measurable is under way, left-aligned: a head (an image, hidden until it is given one; what is under way, small; a title cut to one line), a…cadran::SwitchThe boards' switch, drawn from a BooleanCell's state each frame (so it follows the cell whoever changes it).cadran::TimeButtonA time of day chosen with the stick among times (minutes after midnight, in order, evenly apart): up / down the next or the one before, L / R an hour (or a tap on the arrows),…
cadran::kit 4
cadran::kit::BarA progress bar, 12 px high: the well, filled in teal up to set; the fill eases to each new value (at once with the motion off).cadran::kit::ChipA rounded chip with a text in the display face (an amount, a period…).cadran::kit::EmptyWhat an empty list shows instead: a card with icon_name in a soft circle, title (why it is empty) and text under it (what will come; may be empty), centred; box takes an action…cadran::kit::MarkA pill's mark: its colour, and a shape that says the same to whom the colours look alike (WCAG 1.4.1): a check for what is on (teal), a triangle for what needs the user (amber,…
cadran::palette 4
cadran::palette::ContrastThe pairs the palettes promise to keep readable (an ink on a surface, at least minimum:1; a translucent one blended over the background first): what the host suite checks of…cadran::palette::KeyEach colour's theme keys: the Cadran one ("cadran/…"), and the core's it also sets so that Aurore's own views take the boards' look.cadran::palette::PaletteDark: the boards' navy.cadran::palette::RgbaA colour, 0 to 255 per channel.
cadran_text 1
cadran_text::FailureA failure as its dialog shows it (ui::error): what failed as the title, why as the text (the error's hint, first letter in capitals), the code small ("error 0x0000C88E",…
markdown 1
markdown::BlockA block of a Markdown text: its kind and what it holds.
text 1
text::ConsoleCommentsThe HTML comments of a Markdown text, invisible on GitHub, read line by line (each trimmed of white space, as trim_space): skipped, except the console's own (an app's changelog…
ui 3
ui::CheckLineA line of checklist_body().ui::ChoiceA list of things to do, as a sheet (ui/action_sheet.cpp): each line's label, and what it runs once the sheet has closed; its icon (a Cadran icon, nullptr: none), what is set…ui::PrefsWhat the user chose for Cadran's look.
ui::hooks 1
ui::hooks::HooksWhat Cadran asks of the app, filled in once at start-up (get()).
Read from Aurore's headers by Doxygen at each build · library/include