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

Macros
#define	_D4D_DECLARE_CHECKBOX(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)
	Macro that create the Check box object structure in memory including all substructures. More...

#define	D4D_DECLARE_CHECKBOX(name, text, x, y, cx, cy, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)
	Macro that create the Check box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_CHECKBOX(name, text, x, y, cx, cy, pbmpChecked, pbmpUnChecked, fontId, onchange)
	Macro that create the Check 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_RCHECKBOX(name, text, x, y, cx, cy, radius, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)
	Macro that create the rounded Check box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_RCHECKBOX(name, text, x, y, cx, cy, radius, pbmpChecked, pbmpUnChecked, fontId, onchange)
	Macro that create the rounded Check 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_CHECKBOX_INRAM(name, text, x, y, cx, cy, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)
	Same as D4D_DECLARE_CHECKBOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_CHECKBOX_INRAM(name, text, x, y, cx, cy, pbmpChecked, pbmpUnChecked, fontId, onchange)
	Same as D4D_DECLARE_STD_CHECKBOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RCHECKBOX_INRAM(name, text, x, y, cx, cy, radius, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)
	Same as D4D_DECLARE_RCHECKBOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RCHECKBOX_INRAM(name, text, x, y, cx, cy, radius, pbmpChecked, pbmpUnChecked, fontId, onchange)
	Same as D4D_DECLARE_STD_RCHECKBOX, 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_CHECKBOX	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		flags,
		pbmpChecked,
		pbmpUnChecked,
		pScheme,
		fontId,
		pUser,
		onchange,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of check box object
text	- title text of check box
x	- coordination of check box in X axis
y	- coordination of check box in Y axis
cx	- size of check box in X axis (width)
cy	- size of check box in Y axis (height)
radius	- radius of corners
pMargin	- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
pRelations	- pointer to object relation array (Could be NULL)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D CHECK BOX Defines masks of check box specific behaviour flags
pbmpChecked	- pointer to a bitmap that is shown in a checked state of the check box (Could be NULL)
pbmpUnChecked	- pointer to a bitmap that is shown in a unchecked state of the check box (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw check box
fontId	- Identification number of the used title text font
pUser	- user data of check box
onchange	- Pointer to an on-change user callback function D4D_CHCKBX_ON_CHANGE
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_CHECK_BOX structure, including the object data sub structure. Is used to define all properties of check box.

Definition at line 197 of file d4d_check_box.h.

#define D4D_DECLARE_CHECKBOX	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pbmpChecked,
		pbmpUnChecked,
		pScheme,
		fontId,
		pUser,
		onchange,
		pOnUsrMsg
	)

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

Parameters

name	- name of check box object
text	- title text of check box
x	- coordination of check box in X axis
y	- coordination of check box in Y axis
cx	- size of check box in X axis (width)
cy	- size of check box in Y axis (height)
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D CHECK BOX Defines masks of check box specific behaviour flags
pbmpChecked	- pointer to a bitmap that is shown in a checked state of the check box (Could be NULL)
pbmpUnChecked	- pointer to a bitmap that is shown in a unchecked state of the check box (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw check box
fontId	- Identification number of the used title text font
pUser	- user data of check box
onchange	- Pointer to an on-change user callback function D4D_CHCKBX_ON_CHANGE
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_CHECK_BOX structure, including the object data sub structure. Is used to define all properties of check box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one.

Definition at line 233 of file d4d_check_box.h.

#define D4D_DECLARE_CHECKBOX_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pbmpChecked,
		pbmpUnChecked,
		pScheme,
		fontId,
		pUser,
		onchange,
		pOnUsrMsg
	)

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

Definition at line 312 of file d4d_check_box.h.

#define D4D_DECLARE_RCHECKBOX	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pbmpChecked,
		pbmpUnChecked,
		pScheme,
		fontId,
		pUser,
		onchange,
		pOnUsrMsg
	)

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

Parameters

name	- name of check box object
text	- title text of check box
x	- coordination of check box in X axis
y	- coordination of check box in Y axis
cx	- size of check box in X axis (width)
cy	- size of check box in Y axis (height)
radius	- radius of corners
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D CHECK BOX Defines masks of check box specific behaviour flags
pbmpChecked	- pointer to a bitmap that is shown in a checked state of the check box (Could be NULL)
pbmpUnChecked	- pointer to a bitmap that is shown in a unchecked state of the check box (Could be NULL)
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw check box
fontId	- Identification number of the used title text font
pUser	- user data of check box
onchange	- Pointer to an on-change user callback function D4D_CHCKBX_ON_CHANGE
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_CHECK_BOX structure, including the object data sub structure. Is used to define all properties of check box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CHECKBOX instead of this one.

Definition at line 282 of file d4d_check_box.h.

#define D4D_DECLARE_RCHECKBOX_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		flags,
		pbmpChecked,
		pbmpUnChecked,
		pScheme,
		fontId,
		pUser,
		onchange,
		pOnUsrMsg
	)

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

Definition at line 326 of file d4d_check_box.h.

#define D4D_DECLARE_STD_CHECKBOX	(	name,
		text,
		x,
		y,
		cx,
		cy,
		pbmpChecked,
		pbmpUnChecked,
		fontId,
		onchange
	)

Macro that create the Check 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 check box object
text	- title text of check box
x	- coordination of check box in X axis
y	- coordination of check box in Y axis
cx	- size of check box in X axis (width)
cy	- size of check box in Y axis (height)
pbmpChecked	- pointer to a bitmap that is shown in a checked state of the check box (Could be NULL)
pbmpUnChecked	- pointer to a bitmap that is shown in a unchecked state of the check box (Could be NULL)
fontId	- Identification number of the used title text font
onchange	- Pointer to an on-change user callback function D4D_CHCKBX_ON_CHANGE

Note: This macro create complete D4D_CHECK_BOX structure, including the object data sub structure. Is used to define all properties of check 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.

Definition at line 254 of file d4d_check_box.h.

#define D4D_DECLARE_STD_CHECKBOX_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		pbmpChecked,
		pbmpUnChecked,
		fontId,
		onchange
	)

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

Definition at line 318 of file d4d_check_box.h.

#define D4D_DECLARE_STD_RCHECKBOX	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pbmpChecked,
		pbmpUnChecked,
		fontId,
		onchange
	)

Macro that create the rounded Check 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 check box object
text	- title text of check box
x	- coordination of check box in X axis
y	- coordination of check box in Y axis
cx	- size of check box in X axis (width)
cy	- size of check box in Y axis (height)
radius	- radius of corners
pbmpChecked	- pointer to a bitmap that is shown in a checked state of the check box (Could be NULL)
pbmpUnChecked	- pointer to a bitmap that is shown in a unchecked state of the check box (Could be NULL)
fontId	- Identification number of the used title text font
onchange	- Pointer to an on-change user callback function D4D_CHCKBX_ON_CHANGE

Note: This macro create complete D4D_CHECK_BOX structure, including the object data sub structure. Is used to define all properties of check 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.

Definition at line 304 of file d4d_check_box.h.

#define D4D_DECLARE_STD_RCHECKBOX_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pbmpChecked,
		pbmpUnChecked,
		fontId,
		onchange
	)

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

Definition at line 332 of file d4d_check_box.h.

Macros

Detailed Description

Macro Definition Documentation