menu.h

Go to the documentation of this file.

/*#*
 *#* $Log$
 *#* Revision 1.5  2007/09/19 16:23:27  batt
 *#* Fix doxygen warnings.
 *#*
 *#* Revision 1.4  2006/09/13 13:58:33  bernie
 *#* Add RenderHook support.
 *#*
 *#* Revision 1.3  2006/07/19 12:56:27  bernie
 *#* Convert to new Doxygen style.
 *#*
 *#* Revision 1.2  2006/06/03 13:58:02  bernie
 *#* Fix recursive timeout and add exit status information.
 *#*
 *#* Revision 1.1  2006/05/15 07:20:54  bernie
 *#* Move menu to gui/.
 *#*
 *#* Revision 1.4  2006/04/11 00:07:32  bernie
 *#* Implemenent MF_SAVESEL flag.
 *#*
 *#* Revision 1.3  2006/03/22 09:49:51  bernie
 *#* Simplifications from project_grl.
 *#*
 *#* Revision 1.2  2006/03/20 17:48:35  bernie
 *#* Implement support for ROM menus.
 *#*
 *#* Revision 1.1  2006/02/10 12:29:36  bernie
 *#* Add menu system.
 *#*
 *#* Revision 1.20  2005/11/16 18:10:19  bernie
 *#* Move top-level headers to cfg/ as in DevLib.
 *#*
 *#* Revision 1.19  2005/02/11 19:11:38  aleph
 *#* Move menu_displaymsg() in new displaymsg module
 *#*
 *#* Revision 1.18  2005/01/13 16:56:36  aleph
 *#* Fix progmem includes.
 *#*
 *#* Revision 1.17  2004/12/14 12:52:45  aleph
 *#* Add exclude menu flags
 *#*
 *#* Revision 1.16  2004/10/01 14:04:59  customer_pw
 *#* Add accessor functions for menu flags
 *#*
 *#* Revision 1.15  2004/09/09 08:31:36  customer_pw
 *#* Add disabled item type
 *#*
 *#* Revision 1.14  2004/08/29 21:46:12  bernie
 *#* CVSSILENT: Mark CVS log blocks.
 *#*
 *#* Revision 1.13  2004/08/25 15:35:23  customer_pw
 *#* IPTR -> iptr_t conversion.
 *#*
 *#* Revision 1.12  2004/08/25 13:23:45  bernie
 *#* IPTR -> iptr_t conversion.
 *#*/
#ifndef MWARE_MENU_H
#define MWARE_MENU_H

#include <cfg/compiler.h>

/* Fwd decl */
struct Bitmap;

typedef iptr_t (*MenuHook)(iptr_t userdata);

typedef struct MenuItem
{
    const_iptr_t label;    
    int          flags;    
    MenuHook     hook;     
    iptr_t       userdata; 
} MenuItem;

typedef void (*RenderHook)(struct Bitmap *bitmap, int ypos, bool selected, const struct MenuItem *item);

#define MIF_EXCLUDE_MASK    0x00FF 
#define MIF_PRI_MASK        0x00FF 
#define MIF_PRI(x)          ((x) & MIF_PRI_MASK) 
#define MIF_EXCLUDE_0       BV(0)  
#define MIF_EXCLUDE_1       BV(1)  
#define MIF_EXCLUDE_2       BV(2)  
#define MIF_EXCLUDE_3       BV(3)  
#define MIF_EXCLUDE_4       BV(4)  
#define MIF_EXCLUDE_5       BV(5)  
#define MIF_EXCLUDE_6       BV(6)  
#define MIF_EXCLUDE_7       BV(7)  
#define MIF_CHECKED         BV(8)  
#define MIF_CHECKIT         BV(9)  
#define MIF_TOGGLE          BV(10) 
#define MIF_HIDDEN          BV(11) 
#define MIF_DISABLED        BV(12) 
#define MIF_RAMLABEL        BV(13) 
#define MIF_RENDERHOOK      BV(14) 
/* \} */

typedef struct Menu
{
    MenuItem        *items;    
    const_iptr_t     title;    
    int              flags;    
    struct Bitmap   *bitmap;   
    int              selected; 
} Menu;

#define MF_STICKY   BV(0)  
#define MF_TOPLEVEL BV(1)  
#define MF_ROMITEMS BV(2)  
#define MF_SAVESEL  BV(3)  
/* \} */

#define MENU_OK       ((iptr_t)0)
#define MENU_CANCEL   ((iptr_t)-1)
#define MENU_TIMEOUT  ((iptr_t)-2)
#define MENU_ABORT    ((iptr_t)-3)
#define MENU_DISABLED ((iptr_t)-4)
/* \} */

/* Function prototypes */
iptr_t menu_handle(const struct Menu *menu);
int menu_setFlags(struct Menu *menu, int idx, int flags);
int menu_clearFlags(struct Menu *menu, int idx, int flags);

#endif /* MWARE_MENU_H */