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

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

#define	D4D_DECLARE_COMBO_BOX_ITEM
	Macro that is used to add item to combo box definition. More...

#define	D4D_DECLARE_COMBO_BOX_END
	Macro that is used to close the item list for combo box definition. More...

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

#define	D4D_DECLARE_STD_COMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, pParent, itemsFontId, pOnEvent)
	Macro that create the Combo 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_RCOMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, radius, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the rounded Combo box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RCOMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, radius, pParent, itemsFontId, pOnEvent)
	Macro that create the rounded Combo 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_COMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)
	Same as D4D_DECLARE_COMBO_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

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

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

#define	D4D_DECLARE_STD_RCOMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, radius, pParent, itemsFontId, pOnEvent)
	Same as D4D_DECLARE_STD_RCOMBO_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_COMBO_BOX_BEGIN	(	type,
		name,
		x,
		y,
		cx,
		cy,
		cy_list,
		radius,
		pMargin,
		pParent,
		flags,
		pScheme,
		itemsFontId,
		maxStrLen,
		posCnt,
		comboBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of combo box object
x	- coordination of combo box in X axis
y	- coordination of combo box in Y axis
cx	- size of combo box in X axis (width)
cy	- size of combo box in Y axis (height) (with hidden list box)
cy_list	- size of combo box list in Y axis (height)
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 combo box
itemsFontId	- identification number of the used item text font
maxStrLen	- max lenght of the item texts
posCnt	- count of visible positions
comboBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_CMBBX_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_COMBO_BOX structure, including the object data sub structure. Is used to define all properties of combo box. In fact the combo box is created fromthe three chilren object D4D_BUTTON, D4D_EDIT_BOX and D4D_LIST_BOX handled in one combo box. It must be followed by D4D_DECLARE_COMBO_BOX_ITEM or at least D4D_DECLARE_COMBO_BOX_END.

Definition at line 199 of file d4d_combo_box.h.

#define D4D_DECLARE_COMBO_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		cy_list,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		maxStrLen,
		posCnt,
		comboBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

name	- name of combo box object
x	- coordination of combo box in X axis
y	- coordination of combo box in Y axis
cx	- size of combo box in X axis (width)
cy	- size of combo box in Y axis (height)
cy_list	- size of combo box list in Y axis (height)
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 combo box
itemsFontId	- identification number of the used item text font
maxStrLen	- max lenght of the item texts
posCnt	- count of visible positions
comboBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_CMBBX_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_COMBO_BOX structure, including the object data sub structure. Is used to define all properties of combo box. In fact the combo box is created fromthe three chilren object D4D_BUTTON, D4D_EDIT_BOX and D4D_LIST_BOX handled in one combo box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one. It must be followed by D4D_DECLARE_COMBO_BOX_ITEM or at least D4D_DECLARE_COMBO_BOX_END.

Definition at line 276 of file d4d_combo_box.h.

#define D4D_DECLARE_COMBO_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		cy_list,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		maxStrLen,
		posCnt,
		comboBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Definition at line 362 of file d4d_combo_box.h.

#define D4D_DECLARE_COMBO_BOX_END

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

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

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

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

* D4D_DECLARE_COMBO_BOX_END()

*

Definition at line 247 of file d4d_combo_box.h.

#define D4D_DECLARE_COMBO_BOX_ITEM

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

Parameters

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

Note: This macro is used after the combo box declaration to add new item Here is an example demonstrating how to used it.
* D4D_DECLARE_STD_COMBO_BOX_BEGIN(my_comboBox, 10, 10, 100, 20, 100, NULL, MY_FONT, My_ComboBoxEventsCB)

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

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

* D4D_DECLARE_COMBO_BOX_END()

*

Definition at line 234 of file d4d_combo_box.h.

#define D4D_DECLARE_RCOMBO_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		cy_list,
		radius,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		maxStrLen,
		posCnt,
		comboBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

name	- name of combo box object
x	- coordination of combo box in X axis
y	- coordination of combo box in Y axis
cx	- size of combo box in X axis (width)
cy	- size of combo box in Y axis (height)
cy_list	- size of combo box list in Y axis (height)
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 combo box
itemsFontId	- identification number of the used item text font
maxStrLen	- max lenght of the item texts
posCnt	- count of visible positions
comboBoxItemsOff	- offset between the individual items in pixels
pUser	- user data of combo box
pOnEvent	- Pointer to an on-evnt user callback function D4D_CMBBX_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_COMBO_BOX structure, including the object data sub structure. Is used to define all properties of combo box. In fact the combo box is created fromthe three chilren object D4D_BUTTON, D4D_EDIT_BOX and D4D_LIST_BOX handled in one combo box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one. It must be followed by D4D_DECLARE_COMBO_BOX_ITEM or at least D4D_DECLARE_COMBO_BOX_END.

Definition at line 330 of file d4d_combo_box.h.

#define D4D_DECLARE_RCOMBO_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		cy_list,
		radius,
		flags,
		pParent,
		pScheme,
		itemsFontId,
		maxStrLen,
		posCnt,
		comboBoxItemsOff,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Definition at line 377 of file d4d_combo_box.h.

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

Macro that create the Combo 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 combo box object
x	- coordination of combo box in X axis
y	- coordination of combo box in Y axis
cx	- size of combo box in X axis (width)
cy	- size of combo box in Y axis (height)
cy_list	- size of combo box list in Y axis (height)
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_CMBBX_ON_EVENT

Note: This macro create complete D4D_COMBO_BOX structure, including the object data sub structure. Is used to define all properties of combo box. In fact the combo box is created fromthe three chilren object D4D_BUTTON, D4D_EDIT_BOX and D4D_LIST_BOX handled in one combo box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one. The main advantage is less parameters of this macro against the full version. It must be followed by D4D_DECLARE_COMBO_BOX_ITEM or at least D4D_DECLARE_COMBO_BOX_END.

Definition at line 299 of file d4d_combo_box.h.

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

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

Definition at line 369 of file d4d_combo_box.h.

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

Macro that create the rounded Combo 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 combo box object
x	- coordination of combo box in X axis
y	- coordination of combo box in Y axis
cx	- size of combo box in X axis (width)
cy	- size of combo box in Y axis (height)
cy_list	- size of combo box list in Y axis (height)
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_CMBBX_ON_EVENT

Note: This macro create complete D4D_COMBO_BOX structure, including the object data sub structure. Is used to define all properties of combo box. In fact the combo box is created fromthe three chilren object D4D_BUTTON, D4D_EDIT_BOX and D4D_LIST_BOX handled in one combo box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one. The main advantage is less parameters of this macro against the full version. It must be followed by D4D_DECLARE_COMBO_BOX_ITEM or at least D4D_DECLARE_COMBO_BOX_END.

Definition at line 354 of file d4d_combo_box.h.

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

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

Definition at line 384 of file d4d_combo_box.h.

Macros

Detailed Description

Macro Definition Documentation