listmenu.c File Reference

Defines all the fucntions for making/editing lists for the Eyebot. More...

#include "listmenu.h"
#include "system.h"
#include "lcd.h"

Functions
int	listmenuSize (LIST_MENU listmenu)
	Returns the size of the list. More...
void	listmenuToggleScroll (LIST_MENU *listmenu)
	Toggles the scroll functions. More...
int	listmenuGetScroll (LIST_MENU listmenu)
	checks for the scroll value of the list More...
void	listmenuInit (LIST_MENU *listmenu, char *name)
	initialises the list to display on the LCD More...
void	listmenuAddItem (LIST_MENU *listmenu, char *name, void *plink)
	Adds an item (a string) to the list. More...
void	listmenuFreeItems (LIST_MENU *listmenu)
	Frees the items in the list. More...
void	listmenuChangeItemText (LIST_MENU *listmenu, char *newText, int index)
	Changes the item's name. More...
int	listmenuGetIndex (LIST_MENU listmenu)
	Returns the index of the menu item. More...
char *	listmenuGetItemText (LIST_MENU listmenu)
	Returns the text for the current menu itme. More...

Detailed Description

Defines all the fucntions for making/editing lists for the Eyebot.

Author

Marcus Pham & Remi Keat

Function Documentation

void listmenuAddItem	(	LIST_MENU *	listmenu,
		char *	name,
		void *	plink
	)

Adds an item (a string) to the list.

Parameters

*listmenu	a pointer to the menu
name	the name of the item to add the list
*plink	a pointer to a user function/data

void listmenuChangeItemText	(	LIST_MENU *	listmenu,
		char *	newText,
		int	index
	)

Changes the item's name.

Parameters

*listmenu	a pointer to the menu
newText	the new name of the item to add the list
index	the index of the item in the list

void listmenuFreeItems

(

LIST_MENU *

listmenu

)

Frees the items in the list.

Parameters

*listmenu

a pointer to the menu

int listmenuGetIndex

(

LIST_MENU

listmenu

)

Returns the index of the menu item.

Parameters

listmenu

the menu

Returns

the index of the item

char* listmenuGetItemText

(

LIST_MENU

listmenu

)

Returns the text for the current menu itme.

Parameters

listmenu

the menu

Returns

the string representing the text

int listmenuGetScroll

(

LIST_MENU

listmenu

)

checks for the scroll value of the list

Parameters

listmenu

the listmenu item

Returns

the scroll value

void listmenuInit	(	LIST_MENU *	listmenu,
		char *	name
	)

initialises the list to display on the LCD

Parameters

*listmenu	a pointer to the menu
name	the name of the list

int listmenuSize

(

LIST_MENU

listmenu

)

Returns the size of the list.

Parameters

listmenu

the menu to check

Returns

the size of the list

void listmenuToggleScroll

(

LIST_MENU *

listmenu

)

Toggles the scroll functions.

Parameters

*listmenu

a pointer to the list