4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2006, 2010 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
31 * All Rights Reserved.
34 * \author Bernie Innocenti <bernie@codewiz.org>
35 * \author Stefano Fedrigo <aleph@develer.com>
37 * \brief Common menu handling API
39 * $WIZ$ module_name = "menu"
40 * $WIZ$ module_depends = "text", "gfx", "timer", "kbd"
46 #include <cfg/compiler.h>
50 /** Menu callback function */
51 typedef iptr_t (*MenuHook)(iptr_t userdata);
52 typedef void (*BlitBitmap)(const Bitmap *bm);
55 * Menu item description.
57 typedef struct MenuItem
59 const_iptr_t label; /**< Item label (ID or ptr to string, 0 to disable) */
60 int flags; /**< See MIF_#? definitions below */
61 MenuHook hook; /**< Callback function (NULL to terminate item list) */
62 iptr_t userdata; /**< User data to be passed back to the hook */
65 /** Render hook callback function prototype */
66 typedef void (*RenderHook)(struct Bitmap *bitmap, int ypos, bool selected, const struct MenuItem *item);
69 * \name Flags for MenuItem.flags.
72 #define MIF_EXCLUDE_MASK 0x00FF /**< Mask for mutual exclusion map (shared with priority). */
73 #define MIF_PRI_MASK 0x00FF /**< Mask for priority value (shared with mutual exclusion). */
74 #define MIF_PRI(x) ((x) & MIF_PRI_MASK) /**< Set menu item priority. */
75 #define MIF_EXCLUDE_0 BV(0) /**< Exclude item 0 when this item is checked */
76 #define MIF_EXCLUDE_1 BV(1) /**< Exclude item 1 when this item is checked */
77 #define MIF_EXCLUDE_2 BV(2) /**< Exclude item 2 when this item is checked */
78 #define MIF_EXCLUDE_3 BV(3) /**< Exclude item 3 when this item is checked */
79 #define MIF_EXCLUDE_4 BV(4) /**< Exclude item 4 when this item is checked */
80 #define MIF_EXCLUDE_5 BV(5) /**< Exclude item 5 when this item is checked */
81 #define MIF_EXCLUDE_6 BV(6) /**< Exclude item 6 when this item is checked */
82 #define MIF_EXCLUDE_7 BV(7) /**< Exclude item 7 when this item is checked */
83 #define MIF_CHECKED BV(8) /**< Item is currently checked */
84 #define MIF_CHECKIT BV(9) /**< Automatically check this item when selected */
85 #define MIF_TOGGLE BV(10) /**< Toggle MIF_CHECKED when item is selected */
86 #define MIF_HIDDEN BV(11) /**< This menu item is not visible */
87 #define MIF_DISABLED BV(12) /**< This menu item is not visible */
88 #define MIF_RAMLABEL BV(13) /**< Item label is stored in RAM, not in program memory */
89 #define MIF_RENDERHOOK BV(14) /**< Menu render function is passed in label field */
97 MenuItem *items; /**< Array of items (end with a NULL hook) */
98 const_iptr_t title; /**< Menu title (ID or ptr to string, 0 to disable) */
99 int flags; /**< See MF_#? definitions below */
100 struct Bitmap *bitmap; /**< Bitmap where the menu is rendered */
101 int selected; /**< Initial selection (written to if MF_SAVESEL is set). */
102 BlitBitmap lcd_blitBitmap; /**< Callback to call to do smooth the display */
106 * \name Flags for Menu.flags.
109 #define MF_STICKY BV(0) /**< Stay in the menu when the items called return */
110 #define MF_TOPLEVEL BV(1) /**< Top-level menu (do not display "back" label) */
111 #define MF_ROMITEMS BV(2) /**< Menu items are stored in ROM (default is RAM) */
112 #define MF_SAVESEL BV(3) /**< Remember the selected item across invocations. */
116 * \name Special result codes for menu_handle().
119 #define MENU_OK ((iptr_t)0)
120 #define MENU_CANCEL ((iptr_t)-1)
121 #define MENU_TIMEOUT ((iptr_t)-2)
122 #define MENU_ABORT ((iptr_t)-3)
123 #define MENU_DISABLED ((iptr_t)-4)
126 /* Function prototypes */
127 iptr_t menu_handle(const struct Menu *menu);
128 int menu_setFlags(struct Menu *menu, int idx, int flags);
129 int menu_clearFlags(struct Menu *menu, int idx, int flags);
131 #endif /* GUI_MENU_H */