uspace/lib/ui/private/menuentry.h

   1 /*
   2  * Copyright (c) 2023 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 entry structure
  34  *
  35  */
  36
  37 #ifndef _UI_PRIVATE_MENUENTRY_H
  38 #define _UI_PRIVATE_MENUENTRY_H
  39
  40 #include <adt/list.h>
  41 #include <gfx/coord.h>
  42 #include <types/ui/menuentry.h>
  43
  44 /** Actual structure of menu entry.
  45  *
  46  * This is private to libui.
  47  */
  48 struct ui_menu_entry {
  49         /** Containing menu */
  50         struct ui_menu *menu;
  51         /** Link to @c menu->entries */
  52         link_t lentries;
  53         /** Callbacks */
  54         ui_menu_entry_cb_t cb;
  55         /** This entry is disabled */
  56         bool disabled;
  57         /** This entry is a separator entry */
  58         bool separator;
  59         /** Menu entry is currently held down */
  60         bool held;
  61         /** Pointer is currently inside */
  62         bool inside;
  63         /** Callback argument */
  64         void *arg;
  65         /** Caption */
  66         char *caption;
  67         /** Shortcut key(s) */
  68         char *shortcut;
  69 };
  70
  71 /** Menu entry geometry.
  72  *
  73  * Computed positions of menu entry elements.
  74  */
  75 typedef struct {
  76         /** Outer rectangle */
  77         gfx_rect_t outer_rect;
  78         /** Caption position */
  79         gfx_coord2_t caption_pos;
  80         /** Shortcut position */
  81         gfx_coord2_t shortcut_pos;
  82 } ui_menu_entry_geom_t;
  83
  84 extern void ui_menu_entry_get_geom(ui_menu_entry_t *, gfx_coord2_t *,
  85     ui_menu_entry_geom_t *);
  86 extern void ui_menu_entry_cb(ui_menu_entry_t *);
  87
  88 #endif
  89
  90 /** @}
  91  */