Changeset 5de852c in mainline

Timestamp:

2022-01-11T13:12:15Z (2 years ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

bfc0fc6

Parents:

59768c7

git-author:

Jiri Svoboda <jiri@…> (2022-01-10 20:11:54)

git-committer:

Jiri Svoboda <jiri@…> (2022-01-11 13:12:15)

Message:

Coordinate keyboard event delivery between application and UI framework

If an application sets its own keyboard event handler, it needs to call
ui_window_def_kbd() to deliver events to the window's UI control tree.
Menubar should be able to capture these events so that they are not
accidentally acted upon by the application keyboard handler.

Location:

uspace

Files:

• app/calculator/calculator.c (modified) (1 diff)
• app/edit/edit.c (modified) (1 diff)
• lib/ui/include/ui/menu.h (modified) (2 diffs)
• lib/ui/include/ui/window.h (modified) (1 diff)
• lib/ui/src/menu.c (modified) (4 diffs)
• lib/ui/src/menubar.c (modified) (1 diff)
• lib/ui/src/window.c (modified) (2 diffs)
• lib/ui/test/menubar.c (modified) (1 diff)

uspace/app/calculator/calculator.c

@@ -186 +186 @@
         calc_t *calc = (calc_t *) arg;
 
+        if (ui_window_def_kbd(window, event) == ui_claimed)
+                return;
+
         if (event->type == KEY_PRESS && (event->mods & KM_CTRL) != 0) {
                 switch (event->key) {

uspace/app/edit/edit.c

@@ -2230 +2230 @@
         pane.keymod = event->mods;
 
+        if (ui_window_def_kbd(window, event) == ui_claimed)
+                return;
+
         if (event->type == KEY_PRESS) {
                 key_handle_press(event);

uspace/lib/ui/include/ui/menu.h

@@ -39 +39 @@
 #include <errno.h>
 #include <gfx/coord.h>
+#include <io/kbd_event.h>
 #include <io/pos_event.h>
 #include <stdbool.h>
@@ -57 +58 @@
 extern bool ui_menu_is_open(ui_menu_t *);
 extern errno_t ui_menu_paint(ui_menu_t *, gfx_coord2_t *);
+extern ui_evclaim_t ui_menu_kbd_event(ui_menu_t *, kbd_event_t *);
 extern ui_evclaim_t ui_menu_pos_event(ui_menu_t *, gfx_coord2_t *,
     pos_event_t *);

uspace/lib/ui/include/ui/window.h

@@ -65 +65 @@
 extern void ui_window_set_ctl_cursor(ui_window_t *, ui_stock_cursor_t);
 extern errno_t ui_window_paint(ui_window_t *);
-extern void ui_window_def_kbd(ui_window_t *, kbd_event_t *);
+extern ui_evclaim_t ui_window_def_kbd(ui_window_t *, kbd_event_t *);
 extern errno_t ui_window_def_paint(ui_window_t *);
 extern void ui_window_def_pos(ui_window_t *, pos_event_t *);

uspace/lib/ui/src/menu.c

@@ -66 +66 @@
 static void ui_menu_popup_kbd(ui_popup_t *, void *, kbd_event_t *);
 static void ui_menu_popup_pos(ui_popup_t *, void *, pos_event_t *);
+static void ui_menu_key_press_unmod(ui_menu_t *, kbd_event_t *);
 
 static ui_popup_cb_t ui_menu_popup_cb = {
@@ -493 +494 @@
 }
 
-/** Handle close event in menu popup window.
- *
- * @param popup Menu popup window
- * @param arg Argument (ui_menu_t *)
- */
-static void ui_menu_popup_close(ui_popup_t *popup, void *arg)
-{
-        ui_menu_t *menu = (ui_menu_t *)arg;
-
-        /* Deactivate menu bar, close menu */
-        ui_menu_bar_deactivate(menu->mbar);
+/** Handle keyboard event in menu.
+ *
+ * @param menu Menu
+ * @param event Keyboard event
+ * @return ui_claimed iff the event was claimed
+ */
+ui_evclaim_t ui_menu_kbd_event(ui_menu_t *menu, kbd_event_t *event)
+{
+        if (event->type == KEY_PRESS && (event->mods &
+            (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
+                ui_menu_key_press_unmod(menu, event);
+        }
+
+        return ui_claimed;
 }
 
@@ -612 +616 @@
 }
 
+/** Handle close event in menu popup window.
+ *
+ * @param popup Menu popup window
+ * @param arg Argument (ui_menu_t *)
+ */
+static void ui_menu_popup_close(ui_popup_t *popup, void *arg)
+{
+        ui_menu_t *menu = (ui_menu_t *)arg;
+
+        /* Deactivate menu bar, close menu */
+        ui_menu_bar_deactivate(menu->mbar);
+}
+
 /** Handle keyboard event in menu popup window.
  *
@@ -622 +639 @@
         ui_menu_t *menu = (ui_menu_t *)arg;
 
-        if (event->type == KEY_PRESS && (event->mods &
-            (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
-                ui_menu_key_press_unmod(menu, event);
-        }
+        ui_menu_kbd_event(menu, event);
 }
 

uspace/lib/ui/src/menubar.c

@@ -371 +371 @@
         if (event->type == KEY_PRESS && (event->mods &
             (KM_CTRL | KM_ALT | KM_SHIFT)) == 0) {
-                ui_menu_bar_key_press_unmod(mbar, event);
+                return ui_menu_bar_key_press_unmod(mbar, event);
+        }
+
+        if (mbar->active)
                 return ui_claimed;
-        }
-
-        return ui_claimed;
+
+        return ui_unclaimed;
 }
 

uspace/lib/ui/src/window.c

@@ -963 +963 @@
                 window->cb->kbd(window, window->arg, kbd);
         else
-                return ui_window_def_kbd(window, kbd);
+                ui_window_def_kbd(window, kbd);
 }
 
@@ -1005 +1005 @@
  *
  * @param window Window
- */
-void ui_window_def_kbd(ui_window_t *window, kbd_event_t *kbd)
+ * @return ui_claimed iff event was claimed
+ */
+ui_evclaim_t ui_window_def_kbd(ui_window_t *window, kbd_event_t *kbd)
 {
         if (window->control != NULL)
-                ui_control_kbd_event(window->control, kbd);
+                return ui_control_kbd_event(window->control, kbd);
+
+        return ui_unclaimed;
 }
 

uspace/lib/ui/test/menubar.c

@@ -188 +188 @@
         event.type = KEY_PRESS;
         event.key = KC_ESCAPE;
-        claimed = ui_menu_kbd_pos_event(mbar, &event);
+        claimed = ui_menu_bar_kbd_event(mbar, &event);
         PCUT_ASSERT_ERRNO_VAL(EOK, rc);
         PCUT_ASSERT_EQUALS(ui_claimed, claimed);