Collaboration diagram for D4D LIST BOX API Macro's Specification:

Macros
#define	_D4D_DECLARE_LIST_BOX_BEGIN(type, name, x, y, cx, cy, radius, pMargin, pParent, flags, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the List box object structure in memory including all substructures. More...

#define	D4D_DECLARE_LIST_BOX_ITEM(pText, pUser)
	Macro that is used to add item to list box definition. More...

#define	D4D_DECLARE_LIST_BOX_END()
	Macro that is used to close the item list for list box definition. More...

#define	D4D_DECLARE_LIST_BOX_BEGIN(name, x, y, cx, cy, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the List box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_LIST_BOX_BEGIN(name, x, y, cx, cy, pParent, itemsFontId, pOnEvent)
	Macro that create the List box object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_RLIST_BOX_BEGIN(name, x, y, cx, cy, radius, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the rounded List box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RLIST_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, itemsFontId, pOnEvent)
	Macro that create the rounded List box object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_LIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Same as D4D_DECLARE_LIST_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_LIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, pParent, itemsFontId, pOnEvent)
	Same as D4D_DECLARE_STD_LIST_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RLIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Same as D4D_DECLARE_RLIST_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RLIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, itemsFontId, pOnEvent)
	Same as D4D_DECLARE_STD_RLIST_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define _D4D_DECLARE_LIST_BOX_BEGIN	(	type,
		name,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pParent,
		flags,
		pScheme,
		itemsFontId,
		posCnt,
		listBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

Macro that create the List box object structure in memory including all substructures.

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of list box object
x	- coordination of list box in X axis
y	- coordination of list box in Y axis
cx	- size of list box in X axis (width)
cy	- size of list box in Y axis (height) (with hidden list box)
radius	- radius of corners
pMargin	- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
pParent	- pointer to parent object (Could be NULL)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw list box
itemsFontId	- identification number of the used item text font
posCnt	- count of visible positions
listBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_LSTBX_ON_EVENT
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_LIST_BOX structure, including the object data sub structure. Is used to define all properties of list box. It must be followed by D4D_DECLARE_LIST_BOX_ITEM or at least D4D_DECLARE_LIST_BOX_END.

Definition at line 203 of file d4d_list_box.h.

#define D4D_DECLARE_LIST_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		posCnt,
		listBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

Macro that create the List box object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of list box object
x	- coordination of list box in X axis
y	- coordination of list box in Y axis
cx	- size of list box in X axis (width)
cy	- size of list box in Y axis (height) (with hidden list box)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pParent	- pointer to parent object (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw list box
itemsFontId	- identification number of the used item text font
posCnt	- count of visible positions
listBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_LSTBX_ON_EVENT
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_LIST_BOX structure, including the object data sub structure. Is used to define all properties of list box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LIST_BOX_BEGIN instead of this one. It must be followed by D4D_DECLARE_LIST_BOX_ITEM or at least D4D_DECLARE_LIST_BOX_END.

Definition at line 278 of file d4d_list_box.h.

#define D4D_DECLARE_LIST_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		posCnt,
		listBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

Same as D4D_DECLARE_LIST_BOX_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 357 of file d4d_list_box.h.

#define D4D_DECLARE_LIST_BOX_END ( )

Macro that is used to close the item list for list box definition.

Note: This macro is used after the list box items declaration to close the list of items Here is an example demonstrating how to used it.
* D4D_DECLARE_STD_LIST_BOX_BEGIN(my_listBox, 10, 10, 100, 20, NULL, MY_FONT, My_ListBoxEventsCB)

* D4D_DECLARE_LIST_BOX_ITEM(D4D_DEFSTR("My Item1"), 0)

* D4D_DECLARE_LIST_BOX_ITEM(D4D_DEFSTR("My Item2"), 1)

* D4D_DECLARE_LIST_BOX_END()

*

Definition at line 253 of file d4d_list_box.h.

#define D4D_DECLARE_LIST_BOX_ITEM	(	pText,
		pUser
	)

Macro that is used to add item to list box definition.

Parameters

pText	- text of item
pUser	- user data of item (*void)

Note: This macro is used after the list box declaration to add new item Here is an example demonstrating how to used it.
* D4D_DECLARE_STD_LIST_BOX_BEGIN(my_listBox, 10, 10, 100, 20, NULL, MY_FONT, My_ListBoxEventsCB)

* D4D_DECLARE_LIST_BOX_ITEM(D4D_DEFSTR("My Item1"), 0)

* D4D_DECLARE_LIST_BOX_ITEM(D4D_DEFSTR("My Item2"), 1)

* D4D_DECLARE_LIST_BOX_END()

*

Definition at line 240 of file d4d_list_box.h.

#define D4D_DECLARE_RLIST_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		posCnt,
		listBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

Macro that create the rounded List box object structure in memory including all substructures with restricted count of parameters to simplify definition.

Parameters

name	- name of list box object
x	- coordination of list box in X axis
y	- coordination of list box in Y axis
cx	- size of list box in X axis (width)
cy	- size of list box in Y axis (height) (with hidden list box)
radius	- radius of corners
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags
pParent	- pointer to parent object (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw list box
itemsFontId	- identification number of the used item text font
posCnt	- count of visible positions
listBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_LSTBX_ON_EVENT
pOnUsrMsg	-Pointer to an on user message callback function D4D_ON_USR_MSG. This callback is called before this message event is sent to the object itself. The message can be skipped by the D4D_MSG_SKIP return value, in a normal case the return value must be D4D_MSG_NOSKIP

Note: This macro create complete D4D_LIST_BOX structure, including the object data sub structure. Is used to define all properties of list box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LIST_BOX_BEGIN instead of this one. It must be followed by D4D_DECLARE_LIST_BOX_ITEM or at least D4D_DECLARE_LIST_BOX_END.

Definition at line 327 of file d4d_list_box.h.

#define D4D_DECLARE_RLIST_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		posCnt,
		listBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

Same as D4D_DECLARE_RLIST_BOX_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 372 of file d4d_list_box.h.

#define D4D_DECLARE_STD_LIST_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		pParent,
		itemsFontId,
		pOnEvent
	)

Macro that create the List box object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of list box object
x	- coordination of list box in X axis
y	- coordination of list box in Y axis
cx	- size of list box in X axis (width)
cy	- size of list box in Y axis (height) (with hidden list box)
pParent	- pointer to parent object (Could be NULL)
itemsFontId	- identification number of the used item text font
pOnEvent	- Pointer to an on-evnt user callback function D4D_LSTBX_ON_EVENT

Note: This macro create complete D4D_LIST_BOX structure, including the object data sub structure. Is used to define all properties of list box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LIST_BOX_BEGIN instead of this one. The main advantage is less parameters of this macro against the full version. It must be followed by D4D_DECLARE_LIST_BOX_ITEM or at least D4D_DECLARE_LIST_BOX_END.

Definition at line 299 of file d4d_list_box.h.

#define D4D_DECLARE_STD_LIST_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		pParent,
		itemsFontId,
		pOnEvent
	)

Same as D4D_DECLARE_STD_LIST_BOX_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 364 of file d4d_list_box.h.

#define D4D_DECLARE_STD_RLIST_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		itemsFontId,
		pOnEvent
	)

Macro that create the rounded List box object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values.

Parameters

name	- name of list box object
x	- coordination of list box in X axis
y	- coordination of list box in Y axis
cx	- size of list box in X axis (width)
cy	- size of list box in Y axis (height) (with hidden list box)
radius	- radius of corners
pParent	- pointer to parent object (Could be NULL)
itemsFontId	- identification number of the used item text font
pOnEvent	- Pointer to an on-evnt user callback function D4D_LSTBX_ON_EVENT

Note: This macro create complete D4D_LIST_BOX structure, including the object data sub structure. Is used to define all properties of list box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LIST_BOX_BEGIN instead of this one. The main advantage is less parameters of this macro against the full version. It must be followed by D4D_DECLARE_LIST_BOX_ITEM or at least D4D_DECLARE_LIST_BOX_END.

Definition at line 349 of file d4d_list_box.h.

#define D4D_DECLARE_STD_RLIST_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		itemsFontId,
		pOnEvent
	)

Same as D4D_DECLARE_STD_RLIST_BOX_BEGIN, but is created in RAM instead of the ROM memory.

Definition at line 379 of file d4d_list_box.h.

Macros

Detailed Description

Macro Definition Documentation