D4D COMBO BOX API Functions Specification

Collaboration diagram for D4D COMBO BOX API Functions Specification:

Macros
#define	D4D_ComboBoxGetItemCount(pThis)
	Function gets the count of combo box items. More...
#define	D4D_ComboBoxFindUserDataItem(pThis, pUser)
	Function finds the index of items with specified user data. More...
#define	D4D_ComboBoxGetItemUserData(pThis)
	Function gets the selected item user data. More...
#define	D4D_ComboBoxGetItemText(pThis)
	Function gets the selected item text. More...
#define	D4D_ComboBoxGetItemTextIx(pThis, ix)
	Function gets the text of item choosed by item index. More...
#define	D4D_ComboBoxEnsureVisible(pThis)
	Function ensure that the selected item in list will be scrolled to visible area. More...
#define	D4D_ComboBoxChangeItemList(pThis, pItems)
	Function change the items list using by combo box. More...
#define	D4D_ComboBoxGetItemList(pThis)
	Function gets the current using item list. More...

Detailed Description

This section specifies the exact usage for each API function.

Macro Definition Documentation

#define D4D_ComboBoxChangeItemList	(		pThis,
			pItems
	)

Function change the items list using by combo box.

Parameters

pThis	- pointer to the combo box object
pItems	- pointer to the new item list

Returns

none

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 461 of file d4d_combo_box.h.

#define D4D_ComboBoxEnsureVisible

(

pThis

)

Function ensure that the selected item in list will be scrolled to visible area.

Parameters

pThis

- pointer to the combo box object

Returns

noen

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 452 of file d4d_combo_box.h.

#define D4D_ComboBoxFindUserDataItem	(		pThis,
			pUser
	)

Function finds the index of items with specified user data.

Parameters

pThis	- pointer to the combo box 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

Because the combo box is based on the list box, this calls the list box API.

Definition at line 419 of file d4d_combo_box.h.

#define D4D_ComboBoxGetItemCount

(

pThis

)

Function gets the count of combo box items.

Parameters

pThis

- pointer to the combo box object

Returns

count of combo box items.

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 410 of file d4d_combo_box.h.

#define D4D_ComboBoxGetItemList

(

pThis

)

Function gets the current using item list.

Parameters

pThis

- pointer to the combo box object

Returns

pointer to current using item list

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 469 of file d4d_combo_box.h.

#define D4D_ComboBoxGetItemText

(

pThis

)

Function gets the selected item text.

Parameters

pThis

- pointer to the combo box object

Returns

pointer to slected item text

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 435 of file d4d_combo_box.h.

#define D4D_ComboBoxGetItemTextIx	(		pThis,
			ix
	)

Function gets the text of item choosed by item index.

Parameters

pThis	- pointer to the combo box object
ix	- index to item array

Returns

pointer to item text

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 444 of file d4d_combo_box.h.

#define D4D_ComboBoxGetItemUserData

(

pThis

)

Function gets the selected item user data.

Parameters

pThis

- pointer to the combo box object

Returns

user data of selected item.

Note

Because the combo box is based on the list box, this calls the list box API.

Definition at line 427 of file d4d_combo_box.h.