Collaboration diagram for D4D MENU API Functions Specification:

Functions
D4D_MENU_INDEX	D4D_MenuGetIndex (D4D_OBJECT *pThis)
	Function returns the current selected item index. More...

void	D4D_MenuSetIndex (D4D_OBJECT *pThis, D4D_MENU_INDEX ix)
	Function select new item by index. More...

D4D_MENU_INDEX	D4D_MenuGetItemCount (D4D_OBJECT_PTR pThis)
	Function gets the count of menu items. More...

D4D_MENU_INDEX	D4D_MenuFindUserDataItem (D4D_OBJECT_PTR pThis, void *pUser)
	Function finds the index of items with specified user data. More...

void *	D4D_MenuGetItemUserData (D4D_OBJECT_PTR pThis)
	Function gets the selected item user data. More...

D4D_STRING *	D4D_MenuGetItemText (D4D_OBJECT_PTR pThis)
	Function gets the selected item text. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

D4D_MENU_INDEX D4D_MenuFindUserDataItem	(	D4D_OBJECT_PTR	pThis,
		void *	pUser
	)

Function finds the index of items with specified user data.

Parameters

pThis	- pointer to the menu object
pUser	- user data that is used to look for the item index (must match)

Returns: index of item if it's found, if not, it returns -1.

Note: none

Definition at line 675 of file d4d_menu.c.

Here is the call graph for this function:

D4D_MENU_INDEX D4D_MenuGetIndex ( D4D_OBJECT * pThis )

Function returns the current selected item index.

Parameters

pThis - pointer to the menu object

Returns: index on current selct item

Note: none

Definition at line 620 of file d4d_menu.c.

D4D_MENU_INDEX D4D_MenuGetItemCount ( D4D_OBJECT_PTR pThis )

Function gets the count of menu items.

Parameters

pThis - pointer to the menu object

Returns: count of list box items.

Note: none

Definition at line 661 of file d4d_menu.c.

Here is the call graph for this function:

D4D_STRING* D4D_MenuGetItemText ( D4D_OBJECT_PTR pThis )

Function gets the selected item text.

Parameters

pThis - pointer to the menu object

Returns: pointer to selected item text

Note: none

Definition at line 708 of file d4d_menu.c.

void* D4D_MenuGetItemUserData ( D4D_OBJECT_PTR pThis )

Function gets the selected item user data.

Parameters

pThis - pointer to the menu object

Returns: user data of selected item.

Note: none

Definition at line 696 of file d4d_menu.c.

void D4D_MenuSetIndex	(	D4D_OBJECT *	pThis,
		D4D_MENU_INDEX	ix
	)

Function select new item by index.

Parameters

pThis	- pointer to the menu object
ix	- index of item that should be selected

Returns: none

Note: none

Definition at line 638 of file d4d_menu.c.

Here is the call graph for this function: