4 * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
11 * \author Bernardo Innocenti <bernie@develer.com>
12 * \author Stefano Fedrigo <aleph@develer.com>
14 * \brief Common menu handling API
19 *#* Revision 1.1 2006/05/15 07:20:54 bernie
20 *#* Move menu to gui/.
22 *#* Revision 1.4 2006/04/11 00:07:32 bernie
23 *#* Implemenent MF_SAVESEL flag.
25 *#* Revision 1.3 2006/03/22 09:49:51 bernie
26 *#* Simplifications from project_grl.
28 *#* Revision 1.2 2006/03/20 17:48:35 bernie
29 *#* Implement support for ROM menus.
31 *#* Revision 1.1 2006/02/10 12:29:36 bernie
34 *#* Revision 1.20 2005/11/16 18:10:19 bernie
35 *#* Move top-level headers to cfg/ as in DevLib.
37 *#* Revision 1.19 2005/02/11 19:11:38 aleph
38 *#* Move menu_displaymsg() in new displaymsg module
40 *#* Revision 1.18 2005/01/13 16:56:36 aleph
41 *#* Fix progmem includes.
43 *#* Revision 1.17 2004/12/14 12:52:45 aleph
44 *#* Add exclude menu flags
46 *#* Revision 1.16 2004/10/01 14:04:59 customer_pw
47 *#* Add accessor functions for menu flags
49 *#* Revision 1.15 2004/09/09 08:31:36 customer_pw
50 *#* Add disabled item type
52 *#* Revision 1.14 2004/08/29 21:46:12 bernie
53 *#* CVSSILENT: Mark CVS log blocks.
55 *#* Revision 1.13 2004/08/25 15:35:23 customer_pw
56 *#* IPTR -> iptr_t conversion.
58 *#* Revision 1.12 2004/08/25 13:23:45 bernie
59 *#* IPTR -> iptr_t conversion.
64 #include <cfg/compiler.h>
69 /** Menu callback function */
70 typedef void (*MenuHook)(iptr_t userdata);
73 * Menu item description.
75 typedef struct MenuItem
77 const_iptr_t label; /*!< Item label (ID or ptr to string, 0 to disable) */
78 int flags; /*!< See MIF_#? definitions below */
79 MenuHook hook; /*!< Callback function (NULL to terminate item list) */
80 iptr_t userdata; /*!< User data to be passed back to the hook */
84 * \name Flags for MenuItem.flags.
87 #define MIF_EXCLUDE_MASK 0x00FF /**< Mask for mutual exclusion map (shared with priority). */
88 #define MIF_PRI_MASK 0x00FF /**< Mask for priority value (shared with mutual exclusion). */
89 #define MIF_PRI(x) ((x) & MIF_PRI_MASK) /**< Set menu item priority. */
90 #define MIF_EXCLUDE_0 BV(0) /*!< Exclude item 0 when this item is checked */
91 #define MIF_EXCLUDE_1 BV(1) /*!< Exclude item 1 when this item is checked */
92 #define MIF_EXCLUDE_2 BV(2) /*!< Exclude item 2 when this item is checked */
93 #define MIF_EXCLUDE_3 BV(3) /*!< Exclude item 3 when this item is checked */
94 #define MIF_EXCLUDE_4 BV(4) /*!< Exclude item 4 when this item is checked */
95 #define MIF_EXCLUDE_5 BV(5) /*!< Exclude item 5 when this item is checked */
96 #define MIF_EXCLUDE_6 BV(6) /*!< Exclude item 6 when this item is checked */
97 #define MIF_EXCLUDE_7 BV(7) /*!< Exclude item 7 when this item is checked */
98 #define MIF_CHECKED BV(8) /*!< Item is currently checked */
99 #define MIF_CHECKIT BV(9) /*!< Automatically check this item when selected */
100 #define MIF_TOGGLE BV(10) /*!< Toggle MIF_CHECKED when item is selected */
101 #define MIF_HIDDEN BV(11) /*!< This menu item is not visible */
102 #define MIF_DISABLED BV(12) /*!< This menu item is not visible */
103 #define MIF_RAMLABEL BV(13) /*!< Item label is stored in RAM, not in program memory */
111 MenuItem *items; /*!< Array of items (end with a NULL hook) */
112 const_iptr_t title; /*!< Menu title (ID or ptr to string, 0 to disable) */
113 int flags; /*!< See MF_#? definitions below */
114 struct Bitmap *bitmap; /*!< Bitmap where the menu is rendered */
115 int selected; /*!< Initial selection (written to if #MF_SAVESEL is set). */
119 * \name Flags for Menu.flags.
122 #define MF_STICKY BV(0) /**< Stay in the menu when the items called return */
123 #define MF_TOPLEVEL BV(1) /**< Top-level menu (do not display "back" label) */
124 #define MF_ROMITEMS BV(2) /**< Menu items are stored in ROM (default is RAM) */
125 #define MF_SAVESEL BV(3) /**< Remember the selected item across invocations. */
128 /* Function prototypes */
129 iptr_t menu_handle(const struct Menu *menu);
130 int menu_setFlags(struct Menu *menu, int idx, int flags);
131 int menu_clearFlags(struct Menu *menu, int idx, int flags);
133 #endif /* MWARE_MENU_H */