gantz_egui 0.6.1

UI traits and widgets that make up the GUI for gantz, an environment for creative systems.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

//! The "Panes" controls: per-pane visibility checkboxes plus a reset-layout
//! button. Shared between the Settings pane's Panes subtab and the graph-area
//! context menu's "panes" submenu.

use super::gantz::ViewToggles;

/// Render the per-pane visibility checkboxes.
///
/// `ext` lists the supplied extension panes (see [`ExtPane`][super::ExtPane])
/// - one checkbox per entry after the built-in tray panes.
pub fn panes_config(view: &mut ViewToggles, ext: &[super::ExtPaneEntry], ui: &mut egui::Ui) {
    // Sidebar panes: enabling one also opens the sidebar if it is closed, so
    // the toggle has a visible effect (e.g. from the graph-area context menu).
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.graphs,
        "Graphs",
        "Browse, create and import graphs.",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.history,
        "History",
        "Browse the commit history.",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.settings,
        "Settings",
        "Global / Style / Panes settings (also reachable from this menu).",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.graph_config,
        "Graph Config",
        "Per-graph layout settings and rename.",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.node_inspector,
        "Node Inspector",
        "Inspect and edit the selected node(s).",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.perf_vm,
        "VM Perf",
        "Virtual machine evaluation timing.",
    );
    sidebar_pane(
        ui,
        &mut view.sidebar_open,
        &mut view.perf_gui,
        "GUI Perf",
        "GUI rendering timing.",
    );
    // Tray panes: independent of the sidebar.
    ui.checkbox(&mut view.logs, "Logs")
        .on_hover_text("Log output from the running graphs.");
    ui.checkbox(&mut view.steel, "Steel")
        .on_hover_text("The compiled Steel code for the focused graph.");
    ui.checkbox(&mut view.gui_debug, "GUI Debug").on_hover_text(
        "An editable GUI tree literal rendered live against the focused graph's VM.",
    );
    for entry in ext {
        let on = view.ext.entry(entry.key.clone()).or_insert(false);
        ui.checkbox(on, entry.title.as_str())
            .on_hover_text(entry.description.as_str());
    }
}

/// Render the "reset all" layout button. Returns `true` when clicked.
pub fn reset_layout_button(ui: &mut egui::Ui) -> bool {
    ui.button("reset all")
        .on_hover_text("Reset all top-level panes to their default arrangement and size.")
        .clicked()
}

/// A sidebar-pane checkbox. Enabling it opens the sidebar so the change shows.
fn sidebar_pane(
    ui: &mut egui::Ui,
    sidebar_open: &mut bool,
    on: &mut bool,
    label: &str,
    hover: &str,
) {
    if ui.checkbox(on, label).on_hover_text(hover).changed() && *on {
        *sidebar_open = true;
    }
}