ui.hpp

Go to the documentation of this file.

// ui — Cadran's helpers for dialogs, toasts, pickers, sheets, keyboards,
// visibility and focus. The app adds its own (background tasks, its
// settings file, its error codes) in the same namespace.
// Copyright (C) 2026 JigSawFr, (C) 2026 Taylor.  GPLv3-or-later (see LICENSE.GPL).
#pragma once
 
#include <chrono>
#include <cstdint>
#include <functional>
#include <initializer_list>
#include <string>
#include <utility>
#include <vector>
#include <aurore.hpp>
 
#include <aurore/cadran/ui/cadran_text.hpp>
#include <aurore/cadran/ui/format_text.hpp>
#include <aurore/cadran/ui/guarded.hpp>
#include <aurore/cadran/ui/prefs.hpp>
#include <aurore/cadran/view/cadran_icon.hpp>
 
namespace ui
{
 
// The status colours below are the boards' inks (cadran::install_theme(),
// which must run before the first lookup: Aurore aborts on an unknown
// theme key), one shade per theme (>= 4.5:1).
 
void use_font_for(const std::string& locale);
 
enum class Toast
{
    Info,
    Done,
    Refused,
};
void notify(const std::string& text, Toast kind = Toast::Info);
void refuse(const std::string& text);
void error(const std::string& text);
void error(const std::string& what, const std::string& why);
void show_failure(const cadran_text::Failure& f);
void replace_screen(aurore::Activity* next);
void confirm(const std::string& body, const std::string& confirm_label,
    std::function<void()> on_yes, std::function<void()> on_no = nullptr, bool danger = false);
void confirm_danger(const std::string& body, const std::string& confirm_label, std::function<void()> on_yes);
void info(const std::string& body);
void qr_dialog(const std::string& body, const std::string& url);
 
enum class Check
{
    Ok,
    Warn,
    Bad,
    Info,
    Header, 
};
struct CheckLine
{
    Check state = Check::Info;
    std::string text;
};
aurore::Box* check_row(const CheckLine& line, float size = 17);
aurore::Box* checklist_body(const std::string& title, const std::vector<CheckLine>& lines, const std::string& note = "",
    const std::string& subtitle = "");
void notice(const char* icon, Check tone, const std::string& title, const std::string& text);
void hold_confirm(aurore::Box* body, const std::string& hold_label, std::function<void()> on_yes,
    std::function<void()> on_no = nullptr);
 
aurore::Dialog* dialog(const std::string& text);
aurore::Dialog* dialog(const std::string& text, aurore::View* below);
aurore::Dialog* box_dialog(aurore::Box* body);
 
void on_cancel(aurore::Dialog* dialog, std::function<void()> on_cancel);
void add_cancel(aurore::Dialog* dialog, std::function<void()> cancel);
 
using Swatch = CadranSwatch::Colors;
 
void pick(const std::string& title, const std::vector<std::string>& values, int selected,
    std::function<void(int)> on_pick, bool checked = true, const std::vector<std::string>& details = {},
    const std::vector<std::string>& icons = {}, const std::vector<Swatch>& swatches = {});
void pick_grid(const std::string& title, const std::vector<std::string>& values, const std::vector<std::string>& icons,
    int selected, std::function<void(int)> on_pick, int columns = 4);
void pick_marked(const std::string& title, const std::vector<std::string>& values, const std::vector<bool>& marks,
    int focus, std::function<void(int)> on_pick, const std::vector<std::string>& details = {});
struct Choice
{
    enum class Tone
    {
        PLAIN,
        ON,
        WARN,
        DANGER
    };
    Choice(std::string text, std::function<void()> action, const char* icon_name = nullptr, std::string detail_text = "",
        std::string group_name = "", Tone line_tone = Tone::PLAIN)
        : label(std::move(text))
        , run(std::move(action))
        , icon(icon_name)
        , detail(std::move(detail_text))
        , group(std::move(group_name))
        , tone(line_tone)
    {
    }
    Choice& switched(bool on)
    {
        this->toggle = on ? 1 : 0;
        return *this;
    }
    std::string label;
    std::function<void()> run;
    const char* icon;
    std::string detail;
    std::string group;
    Tone tone;
    int toggle = -1; 
};
void pick_actions(const std::string& title, const std::vector<Choice>& choices, const std::string& subtitle = "",
    int image = 0);
bool is_sheet(aurore::View* view);
 
void prompt_text(const std::string& header, const std::string& initial, int max_len,
    std::function<void(std::string)> on_value);
 
void show_writable(aurore::DetailCell* cell, bool writable, const char* title_key = "cadran/text",
    const char* detail_key = "cadran/text2");
 
void set_visible(aurore::View* view, bool visible);
 
void set_visible_all(std::initializer_list<std::pair<aurore::View*, bool>> changes);
 
void set_text(aurore::Label* label, const std::string& text);
void set_detail(aurore::DetailCell* cell, const std::string& text);
 
void batch_layout(aurore::Box* box, const std::function<void()>& fill);
 
void keep_focus(aurore::Activity* activity, aurore::View* fallback = nullptr);
 
bool has_focus(aurore::Activity* activity);
bool on_top(aurore::Activity* activity);
aurore::Activity* main_screen();
void open_tab(int position, const std::string& row = "");
void refresh_shown_tab();
 
void go_to_tab(aurore::View* from, int position);
void open_screen(aurore::View* content, const std::string& title);
 
void pick_language(std::function<void()> after = nullptr);
void pick_theme(std::function<void()> after = nullptr);
void pick_palette(std::function<void()> after = nullptr);
std::string palette_name();
void pick_text_size(std::function<void()> after = nullptr);
std::string text_size_name(bool tile = false);
void pick_rail(std::function<void()> after = nullptr);
std::string rail_name();
std::string language_name(bool tile = false);
std::string theme_name(bool tile = false);
void quick_settings(std::function<void()> after = nullptr);
 
bool save_prefs();
 
} // namespace ui