gui/menu.h

   1 /**
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
   6  * All Rights Reserved.
   7  * -->
   8  *
   9  * \version $Id$
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  * \author Stefano Fedrigo <aleph@develer.com>
  13  *
  14  * \brief Common menu handling API
  15  */
  16
  17 /*#*
  18  *#* $Log$
  19  *#* Revision 1.5  2007/09/19 16:23:27  batt
  20  *#* Fix doxygen warnings.
  21  *#*
  22  *#* Revision 1.4  2006/09/13 13:58:33  bernie
  23  *#* Add RenderHook support.
  24  *#*
  25  *#* Revision 1.3  2006/07/19 12:56:27  bernie
  26  *#* Convert to new Doxygen style.
  27  *#*
  28  *#* Revision 1.2  2006/06/03 13:58:02  bernie
  29  *#* Fix recursive timeout and add exit status information.
  30  *#*
  31  *#* Revision 1.1  2006/05/15 07:20:54  bernie
  32  *#* Move menu to gui/.
  33  *#*
  34  *#* Revision 1.4  2006/04/11 00:07:32  bernie
  35  *#* Implemenent MF_SAVESEL flag.
  36  *#*
  37  *#* Revision 1.3  2006/03/22 09:49:51  bernie
  38  *#* Simplifications from project_grl.
  39  *#*
  40  *#* Revision 1.2  2006/03/20 17:48:35  bernie
  41  *#* Implement support for ROM menus.
  42  *#*
  43  *#* Revision 1.1  2006/02/10 12:29:36  bernie
  44  *#* Add menu system.
  45  *#*
  46  *#* Revision 1.20  2005/11/16 18:10:19  bernie
  47  *#* Move top-level headers to cfg/ as in DevLib.
  48  *#*
  49  *#* Revision 1.19  2005/02/11 19:11:38  aleph
  50  *#* Move menu_displaymsg() in new displaymsg module
  51  *#*
  52  *#* Revision 1.18  2005/01/13 16:56:36  aleph
  53  *#* Fix progmem includes.
  54  *#*
  55  *#* Revision 1.17  2004/12/14 12:52:45  aleph
  56  *#* Add exclude menu flags
  57  *#*
  58  *#* Revision 1.16  2004/10/01 14:04:59  customer_pw
  59  *#* Add accessor functions for menu flags
  60  *#*
  61  *#* Revision 1.15  2004/09/09 08:31:36  customer_pw
  62  *#* Add disabled item type
  63  *#*
  64  *#* Revision 1.14  2004/08/29 21:46:12  bernie
  65  *#* CVSSILENT: Mark CVS log blocks.
  66  *#*
  67  *#* Revision 1.13  2004/08/25 15:35:23  customer_pw
  68  *#* IPTR -> iptr_t conversion.
  69  *#*
  70  *#* Revision 1.12  2004/08/25 13:23:45  bernie
  71  *#* IPTR -> iptr_t conversion.
  72  *#*/
  73 #ifndef MWARE_MENU_H
  74 #define MWARE_MENU_H
  75
  76 #include <cfg/compiler.h>
  77
  78 /* Fwd decl */
  79 struct Bitmap;
  80
  81 /** Menu callback function */
  82 typedef iptr_t (*MenuHook)(iptr_t userdata);
  83
  84 /**
  85  * Menu item description.
  86  */
  87 typedef struct MenuItem
  88 {
  89         const_iptr_t label;    /**< Item label (ID or ptr to string, 0 to disable) */
  90         int          flags;    /**< See MIF_#? definitions below */
  91         MenuHook     hook;     /**< Callback function (NULL to terminate item list) */
  92         iptr_t       userdata; /**< User data to be passed back to the hook */
  93 } MenuItem;
  94
  95 /** Render hook callback function prototype */
  96 typedef void (*RenderHook)(struct Bitmap *bitmap, int ypos, bool selected, const struct MenuItem *item);
  97
  98 /**
  99  * \name Flags for MenuItem.flags.
 100  * \{
 101  */
 102 #define MIF_EXCLUDE_MASK    0x00FF /**< Mask for mutual exclusion map (shared with priority). */
 103 #define MIF_PRI_MASK        0x00FF /**< Mask for priority value (shared with mutual exclusion). */
 104 #define MIF_PRI(x)          ((x) & MIF_PRI_MASK) /**< Set menu item priority. */
 105 #define MIF_EXCLUDE_0       BV(0)  /**< Exclude item 0 when this item is checked */
 106 #define MIF_EXCLUDE_1       BV(1)  /**< Exclude item 1 when this item is checked */
 107 #define MIF_EXCLUDE_2       BV(2)  /**< Exclude item 2 when this item is checked */
 108 #define MIF_EXCLUDE_3       BV(3)  /**< Exclude item 3 when this item is checked */
 109 #define MIF_EXCLUDE_4       BV(4)  /**< Exclude item 4 when this item is checked */
 110 #define MIF_EXCLUDE_5       BV(5)  /**< Exclude item 5 when this item is checked */
 111 #define MIF_EXCLUDE_6       BV(6)  /**< Exclude item 6 when this item is checked */
 112 #define MIF_EXCLUDE_7       BV(7)  /**< Exclude item 7 when this item is checked */
 113 #define MIF_CHECKED         BV(8)  /**< Item is currently checked */
 114 #define MIF_CHECKIT         BV(9)  /**< Automatically check this item when selected */
 115 #define MIF_TOGGLE          BV(10) /**< Toggle MIF_CHECKED when item is selected */
 116 #define MIF_HIDDEN          BV(11) /**< This menu item is not visible */
 117 #define MIF_DISABLED        BV(12) /**< This menu item is not visible */
 118 #define MIF_RAMLABEL        BV(13) /**< Item label is stored in RAM, not in program memory */
 119 #define MIF_RENDERHOOK      BV(14) /**< Menu render function is passed in label field */
 120 /* \} */
 121
 122 /**
 123  * Menu description.
 124  */
 125 typedef struct Menu
 126 {
 127         MenuItem        *items;    /**< Array of items (end with a NULL hook) */
 128         const_iptr_t     title;    /**< Menu title (ID or ptr to string, 0 to disable) */
 129         int              flags;    /**< See MF_#? definitions below */
 130         struct Bitmap   *bitmap;   /**< Bitmap where the menu is rendered */
 131         int              selected; /**< Initial selection (written to if MF_SAVESEL is set). */
 132 } Menu;
 133
 134 /**
 135  * \name Flags for Menu.flags.
 136  * \{
 137  */
 138 #define MF_STICKY   BV(0)  /**< Stay in the menu when the items called return */
 139 #define MF_TOPLEVEL BV(1)  /**< Top-level menu (do not display "back" label) */
 140 #define MF_ROMITEMS BV(2)  /**< Menu items are stored in ROM (default is RAM) */
 141 #define MF_SAVESEL  BV(3)  /**< Remember the selected item across invocations. */
 142 /* \} */
 143
 144 /**
 145  * \name Special result codes for menu_handle().
 146  * \{
 147  */
 148 #define MENU_OK       ((iptr_t)0)
 149 #define MENU_CANCEL   ((iptr_t)-1)
 150 #define MENU_TIMEOUT  ((iptr_t)-2)
 151 #define MENU_ABORT    ((iptr_t)-3)
 152 #define MENU_DISABLED ((iptr_t)-4)
 153 /* \} */
 154
 155 /* Function prototypes */
 156 iptr_t menu_handle(const struct Menu *menu);
 157 int menu_setFlags(struct Menu *menu, int idx, int flags);
 158 int menu_clearFlags(struct Menu *menu, int idx, int flags);
 159
 160 #endif /* MWARE_MENU_H */