Nilorea Library
C utilities for networking, threading, graphics
Loading...
Searching...
No Matches
ex_gui_datagrid_keys.c

Datagrid keyboard navigation (headless).

Datagrid keyboard navigation (headless). Listbox, radiolist, combobox, dropmenu, slider and checkbox could all be driven from the keyboard; the datagrid could not, so a grid was mouse-only and every host that wanted keys had to bolt its own handler onto the event loop.

The datagrid is now focusable (Tab, and a click) and takes up/down, page up/down, home/end to move the selected row, firing on_select exactly as a click does and scrolling the new row into view. Shift extends a range when multiselect is on, and left/right scroll the columns when they overflow the pane.

Author
Castagnier Mickael
Version
1.0
Date
25/08/2026
/*
* Nilorea Library
* Copyright (C) 2005-2026 Castagnier Mickael
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied. See the License for the specific language governing
* permissions and limitations under the License.
*
* SPDX-License-Identifier: Apache-2.0
*/
#define ALLEGRO_UNSTABLE 1
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "nilorea/n_gui.h"
#include "nilorea/n_log.h"
static int failures = 0;
static int selected_seen[64];
static int nb_selected_seen = 0;
static void expect_true(const char* label, int cond) {
if (!cond) {
n_log(LOG_ERR, "%s: FAILED", label);
} else {
n_log(LOG_INFO, "%s: OK", label);
}
}
static void on_select(int widget_id, int row, void* user_data) {
(void)widget_id;
(void)user_data;
if (nb_selected_seen < 64)
}
static ALLEGRO_EVENT key_event(int keycode, unsigned int modifiers) {
ALLEGRO_EVENT ev;
memset(&ev, 0, sizeof(ev));
ev.type = ALLEGRO_EVENT_KEY_CHAR;
ev.keyboard.keycode = keycode;
ev.keyboard.modifiers = modifiers;
return ev;
}
static ALLEGRO_EVENT mouse_event(int type, int x, int y) {
ALLEGRO_EVENT ev;
memset(&ev, 0, sizeof(ev));
ev.type = (unsigned int)type;
ev.mouse.x = x;
ev.mouse.y = y;
ev.mouse.button = 1;
return ev;
}
int main(void) {
ALLEGRO_FONT* font;
int win, grid, i;
int rows[8];
size_t nsel;
if (!al_init() || !al_init_font_addon()) {
n_log(LOG_ERR, "allegro init failed");
return 1;
}
font = al_create_builtin_font(); /* no display needed */
if (!font) {
n_log(LOG_ERR, "al_create_builtin_font failed");
return 1;
}
if (!gui) {
n_log(LOG_ERR, "n_gui_new_ctx failed");
al_destroy_font(font);
return 1;
}
n_gui_set_display_size(gui, 800.0f, 600.0f);
win = n_gui_add_window(gui, "W", 0.0f, 0.0f, 400.0f, 300.0f);
/* deliberately short: 20 rows in a pane that shows only a handful, so paging
and the scroll-into-view rule have something to do */
grid = n_gui_add_datagrid(gui, win, 0.0f, 0.0f, 200.0f, 100.0f, on_select, NULL);
n_gui_datagrid_add_column(gui, grid, "n", 80.0f);
n_gui_datagrid_add_column(gui, grid, "v", 80.0f);
for (i = 0; i < 20; i++) {
char a[16], b[16];
const char* row[2];
snprintf(a, sizeof(a), "r%02d", i);
snprintf(b, sizeof(b), "%d", i);
row[0] = a;
row[1] = b;
}
/* a click over a data row focuses the grid, so the arrows drive the grid the
operator just pointed at without a separate Tab */
n_gui_process_event(gui, mouse_event(ALLEGRO_EVENT_MOUSE_BUTTON_DOWN, 20, 25));
n_gui_process_event(gui, mouse_event(ALLEGRO_EVENT_MOUSE_BUTTON_UP, 20, 25));
expect_true("a click focuses the grid", gui->focused_widget_id == grid);
/* -1 clears the selection: the guard admitted it but the unsigned row-range test
that followed rejected it, so "no row selected" was unreachable from the API */
expect_true("-1 clears the selection", n_gui_datagrid_get_selected(gui, grid) == -1);
expect_true("a row past the end is ignored", n_gui_datagrid_get_selected(gui, grid) == -1);
/* down from nothing selects the first row and fires on_select */
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
expect_true("down selects the first row", n_gui_datagrid_get_selected(gui, grid) == 0);
expect_true("and fires on_select once", nb_selected_seen == 1 && selected_seen[0] == 0);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
expect_true("down walks the rows", n_gui_datagrid_get_selected(gui, grid) == 2);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_UP, 0));
expect_true("up walks back", n_gui_datagrid_get_selected(gui, grid) == 1);
/* the ends clamp rather than wrap: wrapping past the last row of a traffic log
is never what the operator meant */
n_gui_process_event(gui, key_event(ALLEGRO_KEY_UP, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_UP, 0));
expect_true("up clamps at the first row", n_gui_datagrid_get_selected(gui, grid) == 0);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_END, 0));
expect_true("end selects the last row", n_gui_datagrid_get_selected(gui, grid) == 19);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
expect_true("down clamps at the last row", n_gui_datagrid_get_selected(gui, grid) == 19);
expect_true("the last row is scrolled into view", n_gui_datagrid_get_scroll_offset(gui, grid) > 0);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_HOME, 0));
expect_true("home selects the first row", n_gui_datagrid_get_selected(gui, grid) == 0);
expect_true("and scrolls back to the top", n_gui_datagrid_get_scroll_offset(gui, grid) == 0);
/* paging moves by a screenful and stays inside the grid */
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
expect_true("page down moves more than one row", n_gui_datagrid_get_selected(gui, grid) > 1);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGDN, 0));
expect_true("page down clamps at the last row", n_gui_datagrid_get_selected(gui, grid) == 19);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_PGUP, 0));
expect_true("page up comes back", n_gui_datagrid_get_selected(gui, grid) < 19);
/* multiselect: shift extends the range from the anchor, a plain arrow collapses it */
n_gui_process_event(gui, key_event(ALLEGRO_KEY_HOME, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, ALLEGRO_KEYMOD_SHIFT));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, ALLEGRO_KEYMOD_SHIFT));
nsel = n_gui_datagrid_get_selected_rows(gui, grid, rows, 8);
expect_true("shift+down extends the range", nsel == 3 && rows[0] == 0 && rows[2] == 2);
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
nsel = n_gui_datagrid_get_selected_rows(gui, grid, rows, 8);
expect_true("a plain arrow collapses it", nsel == 1 && rows[0] == 3);
/* an empty grid must not move anything or fire a callback for a row that is gone */
n_gui_process_event(gui, key_event(ALLEGRO_KEY_DOWN, 0));
n_gui_process_event(gui, key_event(ALLEGRO_KEY_END, 0));
expect_true("an empty grid ignores the keys", nb_selected_seen == 0);
al_destroy_font(font);
if (failures) {
n_log(LOG_ERR, "ex_gui_datagrid_keys: %d failure(s)", failures);
return 1;
}
n_log(LOG_NOTICE, "ex_gui_datagrid_keys: all checks passed");
return 0;
}
static int failures
Definition ex_atlas.c:51
int main(void)
Definition ex_atlas.c:117
static void expect_true(const char *label, int cond)
Definition ex_atlas.c:53
static ALLEGRO_EVENT mouse_event(int type, int x, int y, int dz)
Build a left-button mouse event at (x, y).
static void on_select(int widget_id, int row, void *user_data)
Record a row selection, to prove the keyboard path fires the same callback a click does.
static int selected_seen[64]
Rows reported by the grid's on_select callback, in order.
static int nb_selected_seen
How many entries of selected_seen are used.
static ALLEGRO_EVENT key_event(int keycode, unsigned int modifiers)
Build a key event for keycode with modifiers.
static N_GUI_CTX * gui
static void type(N_GUI_CTX *gui, const char *s)
Type a whole string into whatever has focus.
static const char * row(N_GUI_TREE *tree, int index)
the text of a visible row, "" past the end
FONT * font
the default 8x8 font, valid after allegro_init()
void n_gui_set_display_size(N_GUI_CTX *ctx, float w, float h)
set the display (viewport) size so global scrollbars can be computed.
Definition n_gui.c:12348
void n_gui_datagrid_set_selected(N_GUI_CTX *ctx, int widget_id, int row)
set the selected row index (fires the on_select callback).
Definition n_gui.c:5306
size_t n_gui_datagrid_get_selected_rows(N_GUI_CTX *ctx, int widget_id, int *out, size_t max)
fill out with the indices of the selected rows (ascending), up to max, and return the total number of...
Definition n_gui.c:5345
int n_gui_datagrid_get_scroll_offset(N_GUI_CTX *ctx, int widget_id)
first visible data row (the vertical scroll position), or 0.
Definition n_gui.c:5426
int n_gui_process_event(N_GUI_CTX *ctx, ALLEGRO_EVENT event)
Process an allegro event through the GUI system.
Definition n_gui.c:13611
int n_gui_datagrid_add_column(N_GUI_CTX *ctx, int widget_id, const char *title, float width)
append a column with a header title and pixel width; returns the column index or -1
Definition n_gui.c:5153
void n_gui_datagrid_set_multiselect(N_GUI_CTX *ctx, int widget_id, int enabled)
enable (1) or disable (0) multi-row selection.
Definition n_gui.c:5323
#define N_GUI_WIN_FRAMELESS
frameless window: no title bar drawn, drag via window body unless N_GUI_WIN_FIXED_POSITION is also se...
Definition n_gui.h:276
int n_gui_add_window(N_GUI_CTX *ctx, const char *title, float x, float y, float w, float h)
Add a new pseudo-window to the context.
Definition n_gui.c:1277
N_GUI_CTX * n_gui_new_ctx(ALLEGRO_FONT *default_font)
Create a new GUI context.
Definition n_gui.c:1103
void n_gui_datagrid_clear_rows(N_GUI_CTX *ctx, int widget_id)
remove all rows from a data grid (columns are kept)
Definition n_gui.c:5268
void n_gui_destroy_ctx(N_GUI_CTX **ctx)
Destroy a GUI context and all its windows/widgets.
Definition n_gui.c:1209
void n_gui_open_window(N_GUI_CTX *ctx, int window_id)
Open (show) a window.
Definition n_gui.c:1436
int n_gui_datagrid_add_row(N_GUI_CTX *ctx, int widget_id, const char **values)
append a row of cell strings (values must have one entry per column); returns the row index or -1
Definition n_gui.c:5210
void n_gui_window_set_flags(N_GUI_CTX *ctx, int window_id, int flags)
Set feature flags on a window.
Definition n_gui.c:2515
int n_gui_datagrid_get_selected(N_GUI_CTX *ctx, int widget_id)
get the selected row index, or -1 if none
Definition n_gui.c:5300
int n_gui_add_datagrid(N_GUI_CTX *ctx, int window_id, float x, float y, float w, float h, void(*on_select)(int, int, void *), void *user_data)
Add a sortable data grid widget.
Definition n_gui.c:3460
The top-level GUI context that holds all windows.
Definition n_gui.h:1669
#define n_log(__LEVEL__,...)
Logging function wrapper to get line and func.
Definition n_log.h:113
#define LOG_ERR
error conditions
Definition n_log.h:100
void set_log_level(const int log_level)
Set the global log level value ( static int LOG_LEVEL ).
Definition n_log.c:123
#define LOG_NOTICE
normal but significant condition
Definition n_log.h:104
#define LOG_INFO
informational
Definition n_log.h:106
Common headers and low-level functions & define.
GUI system: buttons, sliders, text areas, checkboxes, scrollbars, dropdown menus, windows.
Generic log system.