source: mainline/uspace/lib/ui/private/menu.h@ 59768c7

serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 59768c7 was 59768c7, checked in by Jiri Svoboda <jiri@…>, 3 years ago

Menu control using F10, cursor keys, Enter, Escape

  • Property mode set to 100644
File size: 2.8 KB
Line 
1/*
2 * Copyright (c) 2022 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/ui/menu.h>
44#include <types/ui/resource.h>
45
46/** Actual structure of menu.
47 *
48 * This is private to libui.
49 */
50struct ui_menu {
51 /** Containing menu bar */
52 struct ui_menu_bar *mbar;
53 /** Link to @c bar->menus */
54 link_t lmenus;
55 /** Caption */
56 char *caption;
57 /** Popup window or @c NULL if menu is not currently open */
58 struct ui_popup *popup;
59 /** Selected menu entry or @c NULL */
60 struct ui_menu_entry *selected;
61 /** Maximum caption width */
62 gfx_coord_t max_caption_w;
63 /** Maximum shortcut width */
64 gfx_coord_t max_shortcut_w;
65 /** Total entry height */
66 gfx_coord_t total_h;
67 /** Menu entries (ui_menu_entry_t) */
68 list_t entries;
69};
70
71/** Menu geometry.
72 *
73 * Computed rectangles of menu elements.
74 */
75typedef struct {
76 /** Outer rectangle */
77 gfx_rect_t outer_rect;
78 /** Entries rectangle */
79 gfx_rect_t entries_rect;
80} ui_menu_geom_t;
81
82extern void ui_menu_get_geom(ui_menu_t *, gfx_coord2_t *, ui_menu_geom_t *);
83extern ui_resource_t *ui_menu_get_res(ui_menu_t *);
84extern errno_t ui_menu_paint_bg_gfx(ui_menu_t *, gfx_coord2_t *);
85extern errno_t ui_menu_paint_bg_text(ui_menu_t *, gfx_coord2_t *);
86extern void ui_menu_up(ui_menu_t *);
87extern void ui_menu_down(ui_menu_t *);
88
89#endif
90
91/** @}
92 */
Note: See TracBrowser for help on using the repository browser.