Basic

Files
file	menu.h

Data Structures
struct	menu_entry
	Not yet documented. More...
struct	menu
	Not yet documented. More...

Macros
#define	MENU_ACTION_ENTRY(_label, _action)
	Not yet documented.
#define	MENU_CYCLE_ENTRY(_label_format, _cycle, _update)
	Not yet documented.
#define	MENU_ACTION_CYCLE_ENTRY(_label_format, _action, _cycle, _update)
	Not yet documented.
#define	MENU_MASK   (0x0003)
	Not yet documented.

Typedefs
typedef int8_t	menu_cursor_t
	Not yet documented.
typedef struct menu	menu_t
	Not yet documented.
typedef struct menu_entry	menu_entry_t
	Not yet documented.
typedef void(*	menu_action_t) (void *work, menu_entry_t *menu_entry)
	Not yet documented.
typedef void(*	menu_cycle_t) (void *work, menu_entry_t *menu_entry, int32_t direction)
	Not yet documented.
typedef menu_action_t	menu_update_t
	Not yet documented.
typedef void(*	menu_input_func_t) (menu_t *menu)
	Not yet documented.

Enumerations
enum	menu_flags_t
	Not yet documented. More...

Functions
void	menu_init (menu_t *menu)
	Not yet documented.
void	menu_entries_set (menu_t *menu, menu_entry_t *entries, uint32_t count)
	Not yet documented.
void	menu_input_set (menu_t *menu, menu_input_func_t input_func)
	Not yet documented.
void	menu_update (menu_t *menu)
	Not yet documented.
menu_cursor_t	menu_cursor (menu_t *menu)
	Not yet documented.
void	menu_cursor_up_move (menu_t *menu)
	Not yet documented.
void	menu_cursor_down_move (menu_t *menu)
	Not yet documented.
void	menu_cycle_call (menu_t *menu, int32_t direction)
	Not yet documented.
void	menu_action_call (menu_t *menu)
	Not yet documented.

Detailed Description

This is where menu.h is described.

---

Data Structure Documentation

menu_entry

struct menu_entry

Not yet documented.

Data Fields
char	label[48]	Not yet documented.
char *	label_format	Not yet documented.
menu_action_t	action_func	Not yet documented.
menu_cycle_t	cycle_func	Not yet documented.
menu_update_t	update_func	Not yet documented.

Macro Definition Documentation

MENU_ACTION_ENTRY

#define MENU_ACTION_ENTRY	(		_label,
			_action
	)

Value:

    {                                   \
    .label        = _label,                                                    \
    .label_format = NULL,                                                      \
    .action_func  = _action,                                                   \
    .update_func  = NULL,                                                      \
    .cycle_func   = NULL                                                       \
}

Not yet documented.

Parameters

_label
_action

MENU_CYCLE_ENTRY

#define MENU_CYCLE_ENTRY	(		_label_format,
			_cycle,
			_update
	)

Value:

    {                     \
    .label        = "",                                                        \
    .label_format = _label_format,                                             \
    .action_func  = NULL,                                                      \
    .update_func  = _update,                                                   \
    .cycle_func   = _cycle                                                     \
}

Not yet documented.

Parameters

_label_format
_cycle
_update

MENU_ACTION_CYCLE_ENTRY

#define MENU_ACTION_CYCLE_ENTRY	(		_label_format,
			_action,
			_cycle,
			_update
	)

Value:

    {     \
    .label        = "",                                                        \
    .label_format = _label_format,                                             \
    .action_func  = _action,                                                   \
    .update_func  = _update,                                                   \
    .cycle_func   = _cycle                                                     \
}

Not yet documented.

Parameters

_label_format
_actino
_cycle
_update

Enumeration Type Documentation

menu_flags_t

enum menu_flags_t

Not yet documented.

Enumerator
MENU_NONE	Not yet documented.
MENU_ENABLED	Not yet documented.
MENU_INPUT_ENABLED	Not yet documented.

Function Documentation

menu_init()

void menu_init

(

menu_t *

menu

)

Not yet documented.

Parameters

menu

menu_entries_set()

void menu_entries_set	(	menu_t *	menu,
		menu_entry_t *	entries,
		uint32_t	count
	)

Not yet documented.

Parameters

menu
entries
count

menu_input_set()

void menu_input_set	(	menu_t *	menu,
		menu_input_func_t	input_func
	)

Not yet documented.

Parameters

menu
input_func

menu_update()

void menu_update

(

menu_t *

menu

)

Not yet documented.

Parameters

menu

menu_cursor()

menu_cursor_t menu_cursor

(

menu_t *

menu

)

Not yet documented.

Parameters

menu

Returns

Not yet documented.

menu_cursor_up_move()

void menu_cursor_up_move

(

menu_t *

menu

)

Not yet documented.

Parameters

menu

menu_cursor_down_move()

void menu_cursor_down_move

(

menu_t *

menu

)

Not yet documented.

Parameters

menu

menu_cycle_call()

void menu_cycle_call	(	menu_t *	menu,
		int32_t	direction
	)

Not yet documented.

Parameters

menu
direction

menu_action_call()

void menu_action_call

(

menu_t *

menu

)

Not yet documented.

Parameters

menu