aversive_10-03-12/modules/ihm/menu/menu.h

Go to the documentation of this file.

/*  
 *  Copyright Droids Corporation, Microb Technology, Eirbot (2005)
 * 
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Revision : $Id: menu.h,v 1.4 2007-05-24 13:08:49 zer0 Exp $
 *
 */

/* Olivier MATZ, Droids-corp 2004 - 2006
 * Implementation of a static menu
 */

#include <aversive.h>

struct menu {
    uint8_t type;
    void * data;
};

/* ************************************************************* */

/* Functions that you should use to move in a menu, they try
   to never return NULL, except if param is NULL */

struct menu * menu_left(struct menu * m);

struct menu * menu_right(struct menu * m);

struct menu * menu_down(struct menu * m);

struct menu * menu_up(struct menu * m);


/* ************************************************************* */

/* Functions used to interact with the user (in and out : keyboard 
 * and display)
 * These functions can be reimplemented by the user to change the
 * manner that the menu is displayed or the manner that the user
 * moves in the menu.
 */


struct menu * menu_default_update(struct menu * m, char c);

void menu_default_display(struct menu * m);
     

/* ************************************************************* */

/* Functions that can be usefull, but warning : some of these return
 * a NULL pointer, that need to be handled */

char * menu_get_name(struct menu * m);

uint8_t menu_get_type(struct menu * m);

uint8_t menu_call_fct(struct menu * m);

struct menu * menu_get_previous(struct menu * m);

struct menu * menu_get_next(struct menu * m);

struct menu * menu_get_parent(struct menu * m);

struct menu * menu_get_first_son(struct menu * m);

struct menu * menu_get_sub(struct menu * m, uint8_t num);

uint8_t menu_get_sub_howmany(struct menu * m);


/* ************************************************************* */

/* macros used to declare a menu */

#define MENU_TYPE_ROOT      0
#define MENU_TYPE_MENU      1
#define MENU_TYPE_FCT_HDR   2
#define MENU_TYPE_FCT_PTR   3
#define MENU_TYPE_FCT_DATA  4
#define MENU_TYPE_END       5
#define MENU_TYPE_UNKNOWN 255 

#define MENU_ROOT(text) { MENU_TYPE_ROOT, (void *)text }

#define MENU_START(text) { MENU_TYPE_MENU, (void *)text }

#define MENU_END() { MENU_TYPE_END, NULL }

#define MENU_FCT(text, f, data)       \
 { MENU_TYPE_FCT_HDR, (void *)text }, \
 { MENU_TYPE_FCT_PTR, (void *)f },    \
 { MENU_TYPE_FCT_DATA, (void *)data }

---