Martino Ferrari
1baa58b8fd
The hamburger menu's help rows were three flat entries and a window. They are a **`Help` submenu** now, which is where every GNOME menu keeps them, with the four things a first run cannot find: - Keyboard shortcuts Ctrl+/ (the existing overview, `show_shortcuts()`) - Documentation F1 (the existing manual, `show_help()`) - Guided tour Ctrl+T (new) - Enable contextual help (new, a stateful row: its check *is* the setting) The submenu *replaces* the menu's rows rather than floating beside them, the same shape and the same reason as the plot's right-click menu: a submenu torn out of the menu it belongs to is a second thing to dismiss, and the `GtkMenuButton` that owned one toggled itself out of sync the moment anything else closed its popover. It is the pages of a `GtkStack`, not a rebuild of the box and not a swap of the popover's child: the main view holds `app.layout_toggle`, which the tick's `sync_layout_editor()` and the `L` accel read, so rebuilding would leave that pointer on a destroyed widget, and a swapped child would leave the view that is not showing without an owner. **The contextual help is one table and a "?" per surface** (`src/ui_context_help.cpp`): the plot, the trigger, the cursors, the measurements, the math channels, the signals, the event history, the time window, the status line, and the math editor's identity row. Each row names the *heading box* its button joins -- a sibling of the title, never an overlay child on a corner, which is what would cover the switch or the [edit] button already there -- so adding a surface is a row and a widget pointer. Off means *gone*, not greyed: the buttons are removed, and they are found by a data key rather than a list of pointers because the math editor's heading is built afresh on every opening and a list would go stale one dialog later. `contextual_help` and `tour_seen` are keys of `settings.toml`, written through the same `Settings`/`load_settings()`/`save_settings()` the Preferences dialog uses, whose own rows start from `load_settings()` and so carry them through untouched. **The guided tour is five steps on a `GtkOverlay`** above the window's content: the plot, the side panel, the trigger, the signals and the status line. There is no popover in it and therefore no pointer grab to leak -- four dim rectangles around the hole are what make it modal -- and the probe asserts that as a reading (`controllers=` against the count taken before it opened) rather than as a claim. Everything is placed from `gtk_widget_compute_bounds()` re-read on every frame, because a widget's allocation is 0 on the frame it is first shown and a window resize moves it under a one-shot measurement; the hole is kept from the last frame that could measure the target, because a frame that lands between two layout passes would otherwise empty it and make the spotlight jump. `Skip`, `Finish` and `Escape` all hide every child and leave nothing behind. A first run gets the tour once, decided by `tour_seen` and not by "the settings file did not exist" (a user who changed the theme has a file and has still never seen it), and the flag is written when the tour *starts* rather than when it finishes: a user who skips it in the first second has still seen it. `UDPSCOPE_PROBE_HELPUI_MS` drives all of it -- the auto-start, the menu's seven rows and the submenu's five, the toggle's effect read as a count of affordances on either side of it, and the tour started, stepped forwards and back and dismissed -- and the exit dump gains `help layer:` and `help figures:`, the latter being the ten surfaces' window-coordinate rectangles that the manual's annotated screenshots crop their boxes from. Two of them are what the D-Bus-free headless run can still not decide, and both are limitations rather than defects: export carries no "?" (it is a menu action with no surface of its own, and a popover inside the menu's popover is the nested-popover trap the invariants already warn about), and the tour card cannot miss its target when the target is the whole content -- which is what the plot is at the window's 756 px minimum, where the split view overlays the side panel instead of putting it beside the plot. The probe prints both rectangles rather than asserting a placement, so that case reads as the geometry it is. Also fixed while it was found: `gtk_widget_measure()` includes the widget's own margins (measured: a 280 px box with `margin-start 453` reports 733), so a measure that is used to *place* the widget is a feedback loop -- that is what made the tour card walk between the corner and the target from frame to frame.
89 lines
4.4 KiB
C++
89 lines
4.4 KiB
C++
// SPDX-License-Identifier: MIT
|
|
#include "shortcuts.hpp"
|
|
|
|
#include <gdk/gdk.h>
|
|
|
|
namespace udpscope {
|
|
namespace {
|
|
|
|
/// Bare letters are toggles, Ctrl is for files and windows. Nothing here shadows a key the
|
|
/// plot's own controller handles ('+', '-', 'f', the arrows, Escape).
|
|
constexpr Accel kAccels[] = {
|
|
{GDK_KEY_space, 0, AppAction::PauseToggle, "space", "Pause or resume the display",
|
|
"Acquisition"},
|
|
{GDK_KEY_a, 0, AppAction::TriggerArm, "a", "Arm or disarm the trigger", "Acquisition"},
|
|
{GDK_KEY_t, 0, AppAction::TriggerPanel, "t", "Enable or disable trigger mode", "Acquisition"},
|
|
{GDK_KEY_c, 0, AppAction::CursorsPane, "c", "Enable or disable the cursors", "Panes and editors"},
|
|
{GDK_KEY_m, 0, AppAction::SideTabMeasure, "m", "Show the Measure tab", "Panes and editors"},
|
|
{GDK_KEY_g, 0, AppAction::SideTabSignals, "g", "Show the Signals tab", "Panes and editors"},
|
|
{GDK_KEY_l, 0, AppAction::LayoutEditor, "l", "Show or hide the layout editor",
|
|
"Panes and editors"},
|
|
{GDK_KEY_s, 0, AppAction::SidePanel, "s", "Show or hide the side panel",
|
|
"Panes and editors"},
|
|
{GDK_KEY_e, GDK_CONTROL_MASK, AppAction::Export, "<Control>e",
|
|
"Export the visible range", "Files and windows"},
|
|
{GDK_KEY_F1, 0, AppAction::Help, "F1", "Open the documentation", "Files and windows"},
|
|
{GDK_KEY_slash, GDK_CONTROL_MASK, AppAction::Shortcuts, "<Control>slash",
|
|
"Open this shortcut overview", "Files and windows"},
|
|
{GDK_KEY_t, GDK_CONTROL_MASK, AppAction::GuidedTour, "<Control>t",
|
|
"Start the guided tour", "Files and windows"},
|
|
{GDK_KEY_h, GDK_CONTROL_MASK, AppAction::ContextualHelp, "<Control>h",
|
|
"Turn the contextual help on or off", "Files and windows"},
|
|
{GDK_KEY_q, GDK_CONTROL_MASK, AppAction::Quit, "<Control>q", "Quit udpscope",
|
|
"Files and windows"},
|
|
};
|
|
constexpr int kAccelCount = static_cast<int>(sizeof(kAccels) / sizeof(kAccels[0]));
|
|
|
|
/// The plot's own interactions, documentation only. The keyboard's modifiers are not the
|
|
/// wheel's: '+' is shift+'=' on common layouts, so Shift could not mean anything there.
|
|
///
|
|
/// A space-separated accelerator is the two-key alternative form the shortcut label draws
|
|
/// as `+ / -`. The mouse rows carry no accelerator at all: neither GTK's accelerator syntax nor
|
|
/// libadwaita's knows a wheel or a drag, and asking either to parse "Wheel" is a parse warning and an
|
|
/// empty cell. The overview draws them from `src/ui/shortcuts.ui`, which gives each one GTK's generic
|
|
/// gesture type and an icon where the keycaps would be. That file is the *presentation*; this table is
|
|
/// what the application handles, which is why `[help]`'s `ui=` is checked against `tables=`.
|
|
constexpr Gesture kGestures[] = {
|
|
{"plus minus", "", "Zoom in or out, both axes", "Plot keyboard"},
|
|
{"<Control>plus <Control>minus", "", "Zoom the time axis only", "Plot keyboard"},
|
|
{"<Alt>plus <Alt>minus", "", "Zoom the value axis only", "Plot keyboard"},
|
|
{"Left Right", "", "Pan along time", "Plot keyboard"},
|
|
{"Up Down", "", "Pan along values", "Plot keyboard"},
|
|
{"f", "", "Fit the view to the data", "Plot keyboard"},
|
|
{"Escape", "", "Cancel the gesture in progress", "Plot keyboard"},
|
|
{"", "Wheel", "Zoom about the pointer, both axes", "Plot mouse"},
|
|
{"", "Shift and wheel", "Zoom the time axis only", "Plot mouse"},
|
|
{"", "Ctrl and wheel", "Zoom the value axis only", "Plot mouse"},
|
|
{"", "Drag", "Pan", "Plot mouse"},
|
|
{"", "Ctrl and drag", "Box zoom on time", "Plot mouse"},
|
|
{"", "Alt and drag", "Box zoom on values", "Plot mouse"},
|
|
{"", "Shift and drag", "Box zoom on time and values", "Plot mouse"},
|
|
};
|
|
constexpr int kGestureCount = static_cast<int>(sizeof(kGestures) / sizeof(kGestures[0]));
|
|
|
|
/// The only modifiers a table row may require. Lock, Num-Lock and the pointer buttons all
|
|
/// arrive in the same mask and must be masked out or no row ever matches.
|
|
constexpr unsigned kModMask = GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_ALT_MASK;
|
|
|
|
} // namespace
|
|
|
|
const Accel* app_accels(int* count) {
|
|
if (count != nullptr) *count = kAccelCount;
|
|
return kAccels;
|
|
}
|
|
|
|
const Gesture* plot_gestures(int* count) {
|
|
if (count != nullptr) *count = kGestureCount;
|
|
return kGestures;
|
|
}
|
|
|
|
const Accel* find_accel(unsigned keyval, unsigned mods) {
|
|
const unsigned wanted = mods & kModMask;
|
|
for (const Accel& accel : kAccels) {
|
|
if (accel.keyval == keyval && accel.mods == wanted) return &accel;
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
} // namespace udpscope
|