Changeset 62223ec in mainline

Timestamp:

2021-04-09T22:41:22Z (3 years ago)

Author:

jxsvoboda <5887334+jxsvoboda@…>

Branches:

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

Children:

f251883

Parents:

0262f16c

git-author:

Jiri Svoboda <jiri@…> (2021-04-01 21:04:11)

git-committer:

jxsvoboda <5887334+jxsvoboda@…> (2021-04-09 22:41:22)

Message:

Close menu when window is unfocused

This of course means we need to do all the plumbing for delivering
unfocus event to UI controls.

Location:

uspace/lib/ui

Files:

• include/types/ui/control.h (modified) (1 diff)
• include/ui/control.h (modified) (1 diff)
• include/ui/fixed.h (modified) (1 diff)
• include/ui/menubar.h (modified) (1 diff)
• include/ui/window.h (modified) (1 diff)
• src/control.c (modified) (1 diff)
• src/fixed.c (modified) (4 diffs)
• src/menubar.c (modified) (4 diffs)
• src/window.c (modified) (3 diffs)
• test/control.c (modified) (4 diffs)
• test/fixed.c (modified) (4 diffs)
• test/window.c (modified) (4 diffs)

uspace/lib/ui/include/types/ui/control.h

@@ -52 +52 @@
         /** Position event */
         ui_evclaim_t (*pos_event)(void *, pos_event_t *);
+        /** Unfocus */
+        void (*unfocus)(void *);
 } ui_control_ops_t;
 

uspace/lib/ui/include/ui/control.h

@@ -47 +47 @@
 extern errno_t ui_control_paint(ui_control_t *);
 extern ui_evclaim_t ui_control_pos_event(ui_control_t *, pos_event_t *);
+extern void ui_control_unfocus(ui_control_t *);
 
 #endif

uspace/lib/ui/include/ui/fixed.h

@@ -50 +50 @@
 extern errno_t ui_fixed_paint(ui_fixed_t *);
 extern ui_evclaim_t ui_fixed_pos_event(ui_fixed_t *, pos_event_t *);
+extern void ui_fixed_unfocus(ui_fixed_t *);
 
 #endif

uspace/lib/ui/include/ui/menubar.h

@@ -52 +52 @@
 extern errno_t ui_menu_bar_paint(ui_menu_bar_t *);
 extern ui_evclaim_t ui_menu_bar_pos_event(ui_menu_bar_t *, pos_event_t *);
+extern void ui_menu_bar_unfocus(ui_menu_bar_t *);
 
 #endif

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

@@ -61 +61 @@
 extern errno_t ui_window_def_paint(ui_window_t *);
 extern void ui_window_def_pos(ui_window_t *, pos_event_t *);
+extern void ui_window_def_unfocus(ui_window_t *);
 
 #endif

uspace/lib/ui/src/control.c

@@ -112 +112 @@
 }
 
+/** Inform UI control that window has been unfocused.
+ *
+ * @param control Control
+ */
+void ui_control_unfocus(ui_control_t *control)
+{
+        if (control->ops->unfocus != NULL)
+                control->ops->unfocus(control->ext);
+}
+
 /** @}
  */

uspace/lib/ui/src/fixed.c

@@ -47 +47 @@
 static errno_t ui_fixed_ctl_paint(void *);
 static ui_evclaim_t ui_fixed_ctl_pos_event(void *, pos_event_t *);
+static void ui_fixed_ctl_unfocus(void *);
 
 /** Push button control ops */
@@ -52 +53 @@
         .destroy = ui_fixed_ctl_destroy,
         .paint = ui_fixed_ctl_paint,
-        .pos_event = ui_fixed_ctl_pos_event
+        .pos_event = ui_fixed_ctl_pos_event,
+        .unfocus = ui_fixed_ctl_unfocus
 };
 
@@ -232 +234 @@
 }
 
+/** Handle fixed layout window unfocus notification.
+ *
+ * @param fixed Fixed layout
+ */
+void ui_fixed_unfocus(ui_fixed_t *fixed)
+{
+        ui_fixed_elem_t *elem;
+
+        elem = ui_fixed_first(fixed);
+        while (elem != NULL) {
+                ui_control_unfocus(elem->control);
+
+                elem = ui_fixed_next(elem);
+        }
+}
+
 /** Destroy fixed layout control.
  *
@@ -268 +286 @@
 }
 
+/** Handle fixed layout control window unfocus notification.
+ *
+ * @param arg Argument (ui_fixed_t *)
+ */
+void ui_fixed_ctl_unfocus(void *arg)
+{
+        ui_fixed_t *fixed = (ui_fixed_t *) arg;
+
+        ui_fixed_unfocus(fixed);
+}
+
 /** @}
  */

uspace/lib/ui/src/menubar.c

@@ -60 +60 @@
 static errno_t ui_menu_bar_ctl_paint(void *);
 static ui_evclaim_t ui_menu_bar_ctl_pos_event(void *, pos_event_t *);
+static void ui_menu_bar_ctl_unfocus(void *);
 
 /** Menu bar control ops */
@@ -65 +66 @@
         .destroy = ui_menu_bar_ctl_destroy,
         .paint = ui_menu_bar_ctl_paint,
-        .pos_event = ui_menu_bar_ctl_pos_event
+        .pos_event = ui_menu_bar_ctl_pos_event,
+        .unfocus = ui_menu_bar_ctl_unfocus
 };
 
@@ -328 +330 @@
 }
 
+/** Handle menu bar window unfocus notification.
+ *
+ * @param mbar Menu bar
+ */
+void ui_menu_bar_unfocus(ui_menu_bar_t *mbar)
+{
+        ui_menu_bar_select(mbar, NULL, NULL);
+}
+
 /** Destroy menu bar control.
  *
@@ -364 +375 @@
 }
 
+/** Handle menu bar control window unfocus notification.
+ *
+ * @param arg Argument (ui_menu_bar_t *)
+ */
+void ui_menu_bar_ctl_unfocus(void *arg)
+{
+        ui_menu_bar_t *mbar = (ui_menu_bar_t *) arg;
+
+        ui_menu_bar_unfocus(mbar);
+}
+
 /** @}
  */

uspace/lib/ui/src/window.c

@@ -815 +815 @@
         if (window->cb != NULL && window->cb->unfocus != NULL)
                 window->cb->unfocus(window, window->arg);
+        else
+                return ui_window_def_unfocus(window);
 }
 
@@ -850 +852 @@
  *
  * @param window Window
- * @return EOK on success or an error code
  */
 void ui_window_def_pos(ui_window_t *window, pos_event_t *pos)
@@ -856 +857 @@
         if (window->control != NULL)
                 ui_control_pos_event(window->control, pos);
+}
+
+/** Default window unfocus routine.
+ *
+ * @param window Window
+ * @return EOK on success or an error code
+ */
+void ui_window_def_unfocus(ui_window_t *window)
+{
+        if (window->control != NULL)
+                ui_control_unfocus(window->control);
 }
 

uspace/lib/ui/test/control.c

@@ -42 +42 @@
 static errno_t test_ctl_paint(void *);
 static ui_evclaim_t test_ctl_pos_event(void *, pos_event_t *);
+static void test_ctl_unfocus(void *);
 
 static ui_control_ops_t test_ctl_ops = {
         .destroy = test_ctl_destroy,
         .paint = test_ctl_paint,
-        .pos_event = test_ctl_pos_event
+        .pos_event = test_ctl_pos_event,
+        .unfocus = test_ctl_unfocus
 };
 
@@ -66 +68 @@
         /** Position event that was sent */
         pos_event_t pevent;
+
+        /** @c true iff unfocus was called */
+        bool unfocus;
 } test_resp_t;
 
@@ -166 +171 @@
 }
 
+/** Test sending unfocus to control */
+PCUT_TEST(unfocus)
+{
+        ui_control_t *control = NULL;
+        test_resp_t resp;
+        errno_t rc;
+
+        rc = ui_control_new(&test_ctl_ops, &resp, &control);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+        PCUT_ASSERT_NOT_NULL(control);
+
+        resp.unfocus = false;
+
+        ui_control_unfocus(control);
+        PCUT_ASSERT_TRUE(resp.unfocus);
+
+        ui_control_delete(control);
+}
+
 static void test_ctl_destroy(void *arg)
 {
@@ -191 +215 @@
 }
 
+static void test_ctl_unfocus(void *arg)
+{
+        test_resp_t *resp = (test_resp_t *) arg;
+
+        resp->unfocus = true;
+}
+
 PCUT_EXPORT(control);

uspace/lib/ui/test/fixed.c

@@ -41 +41 @@
 static errno_t test_ctl_paint(void *);
 static ui_evclaim_t test_ctl_pos_event(void *, pos_event_t *);
+static void test_ctl_unfocus(void *);
 
 static ui_control_ops_t test_ctl_ops = {
         .destroy = test_ctl_destroy,
         .paint = test_ctl_paint,
-        .pos_event = test_ctl_pos_event
+        .pos_event = test_ctl_pos_event,
+        .unfocus = test_ctl_unfocus
 };
 
@@ -62 +64 @@
         /** Position event that was sent */
         pos_event_t pevent;
+        /** @c true iff unfocus was called */
+        bool unfocus;
 } test_resp_t;
 
@@ -230 +234 @@
 }
 
+/** ui_fixed_unfocus() delivers unfocus notification to control */
+PCUT_TEST(unfocus)
+{
+        ui_fixed_t *fixed = NULL;
+        ui_control_t *control;
+        test_resp_t resp;
+        errno_t rc;
+
+        rc = ui_fixed_create(&fixed);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        rc = ui_control_new(&test_ctl_ops, (void *) &resp, &control);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        rc = ui_fixed_add(fixed, control);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        resp.unfocus = false;
+
+        ui_fixed_unfocus(fixed);
+        PCUT_ASSERT_TRUE(resp.unfocus);
+
+        ui_fixed_destroy(fixed);
+}
+
 static void test_ctl_destroy(void *arg)
 {
@@ -255 +284 @@
 }
 
+static void test_ctl_unfocus(void *arg)
+{
+        test_resp_t *resp = (test_resp_t *) arg;
+
+        resp->unfocus = true;
+}
+
 PCUT_EXPORT(fixed);

uspace/lib/ui/test/window.c

@@ -66 +66 @@
 static errno_t test_ctl_paint(void *);
 static ui_evclaim_t test_ctl_pos_event(void *, pos_event_t *);
+static void test_ctl_unfocus(void *);
 
 static ui_control_ops_t test_ctl_ops = {
         .paint = test_ctl_paint,
-        .pos_event = test_ctl_pos_event
+        .pos_event = test_ctl_pos_event,
+        .unfocus = test_ctl_unfocus
 };
 
@@ -90 +92 @@
         bool pos;
         pos_event_t pos_event;
+        bool unfocus;
 } test_ctl_resp_t;
 
@@ -388 +391 @@
         PCUT_ASSERT_INT_EQUALS(event.hpos, resp.pos_event.hpos);
         PCUT_ASSERT_INT_EQUALS(event.vpos, resp.pos_event.vpos);
+
+        /* Need to remove first because we didn't implement the destructor */
+        ui_window_remove(window, control);
+
+        ui_window_destroy(window);
+        ui_destroy(ui);
+}
+
+/** ui_window_def_unfocus() delivers unfocus event to control in window */
+PCUT_TEST(def_unfocus)
+{
+        errno_t rc;
+        ui_t *ui = NULL;
+        ui_wnd_params_t params;
+        ui_window_t *window = NULL;
+        ui_control_t *control = NULL;
+        test_ctl_resp_t resp;
+
+        rc = ui_create_disp(NULL, &ui);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        ui_wnd_params_init(&params);
+        params.caption = "Hello";
+
+        rc = ui_window_create(ui, &params, &window);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        rc = ui_control_new(&test_ctl_ops, &resp, &control);
+        PCUT_ASSERT_ERRNO_VAL(EOK, rc);
+
+        ui_window_add(window, control);
+
+        resp.unfocus = false;
+
+        ui_window_def_unfocus(window);
+        PCUT_ASSERT_TRUE(resp.unfocus);
 
         /* Need to remove first because we didn't implement the destructor */
@@ -701 +740 @@
 }
 
+static void test_ctl_unfocus(void *arg)
+{
+        test_ctl_resp_t *resp = (test_ctl_resp_t *) arg;
+
+        resp->unfocus = true;
+}
+
 PCUT_EXPORT(window);