uspace/lib/ui/private/menu.h

   1 /*
   2  * Copyright (c) 2024 Jiri Svoboda
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /** @addtogroup libui
  30  * @{
  31  */
  32 /**
  33  * @file Menu structure
  34  *
  35  */
  36
  37 #ifndef _UI_PRIVATE_MENU_H
  38 #define _UI_PRIVATE_MENU_H
  39
  40 #include <adt/list.h>
  41 #include <gfx/coord.h>
  42 #include <stdbool.h>
  43 #include <types/common.h>
  44 #include <types/ui/menu.h>
  45 #include <types/ui/resource.h>
  46
  47 /** Actual structure of menu.
  48  *
  49  * This is private to libui.
  50  */
  51 struct ui_menu {
  52         /** Parent window */
  53         struct ui_window *parent;
  54         /** Caption */
  55         char *caption;
  56         /** Popup window or @c NULL if menu is not currently open */
  57         struct ui_popup *popup;
  58         /** Selected menu entry or @c NULL */
  59         struct ui_menu_entry *selected;
  60         /** Maximum caption width */
  61         gfx_coord_t max_caption_w;
  62         /** Maximum shortcut width */
  63         gfx_coord_t max_shortcut_w;
  64         /** Total entry height */
  65         gfx_coord_t total_h;
  66         /** Menu entries (ui_menu_entry_t) */
  67         list_t entries;
  68         /** Callbacks */
  69         struct ui_menu_cb *cb;
  70         /** Callback argument */
  71         void *arg;
  72         /** ID of device that activated entry */
  73         sysarg_t idev_id;
  74 };
  75
  76 /** Menu geometry.
  77  *
  78  * Computed rectangles of menu elements.
  79  */
  80 typedef struct {
  81         /** Outer rectangle */
  82         gfx_rect_t outer_rect;
  83         /** Entries rectangle */
  84         gfx_rect_t entries_rect;
  85 } ui_menu_geom_t;
  86
  87 extern void ui_menu_get_geom(ui_menu_t *, gfx_coord2_t *, ui_menu_geom_t *);
  88 extern ui_resource_t *ui_menu_get_res(ui_menu_t *);
  89 extern errno_t ui_menu_paint_bg_gfx(ui_menu_t *, gfx_coord2_t *);
  90 extern errno_t ui_menu_paint_bg_text(ui_menu_t *, gfx_coord2_t *);
  91 extern void ui_menu_up(ui_menu_t *);
  92 extern void ui_menu_down(ui_menu_t *);
  93 extern void ui_menu_left(ui_menu_t *, sysarg_t);
  94 extern void ui_menu_right(ui_menu_t *, sysarg_t);
  95 extern void ui_menu_close_req(ui_menu_t *);
  96 extern void ui_menu_press_accel(ui_menu_t *, char32_t, sysarg_t);
  97
  98 #endif
  99
 100 /** @}
 101  */