source: mainline/uspace/lib/ui/private/menu.h@ 1c6c3e1d

ticket/834-toolchain-update
Last change on this file since 1c6c3e1d was 46bd63c9, checked in by Jiri Svoboda <jiri@…>, 22 months ago

Split drop-down menu into two classes: drop-down and menu

Naming is clearly the hardest problem in computer science.

  • Property mode set to 100644
File size: 3.1 KB
Line 
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 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 */
51struct 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};
73
74/** Menu geometry.
75 *
76 * Computed rectangles of menu elements.
77 */
78typedef struct {
79 /** Outer rectangle */
80 gfx_rect_t outer_rect;
81 /** Entries rectangle */
82 gfx_rect_t entries_rect;
83} ui_menu_geom_t;
84
85extern void ui_menu_get_geom(ui_menu_t *, gfx_coord2_t *, ui_menu_geom_t *);
86extern ui_resource_t *ui_menu_get_res(ui_menu_t *);
87extern errno_t ui_menu_paint_bg_gfx(ui_menu_t *, gfx_coord2_t *);
88extern errno_t ui_menu_paint_bg_text(ui_menu_t *, gfx_coord2_t *);
89extern void ui_menu_up(ui_menu_t *);
90extern void ui_menu_down(ui_menu_t *);
91extern void ui_menu_left(ui_menu_t *, sysarg_t);
92extern void ui_menu_right(ui_menu_t *, sysarg_t);
93extern void ui_menu_close_req(ui_menu_t *);
94extern void ui_menu_press_accel(ui_menu_t *, char32_t, sysarg_t);
95
96#endif
97
98/** @}
99 */
Note: See TracBrowser for help on using the repository browser.