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

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

#define	D4D_DECLARE_GROUP_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, pMargin, text, fontId, flags, pScheme, pUser, pOnUsrMsg)
	Macro that create the Group box object structure in memory including all substructures with start of relation object list. More...

#define	D4D_DECLARE_GROUP_BOX_OBJECT(name)
	Macro that adds one child object to group box object relations table declaration. More...

#define	D4D_DECLARE_GROUP_BOX_OBJECT_END
	Macro that ends children group box object relations table declaration. More...

#define	D4D_DECLARE_STD_GROUP_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, text, fontId)
	Macro that create the Group box object structure in memory including all substructures with start of relation object list The missing parameters are replaced by default values. More...

#define	D4D_DECLARE_GROUP_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, pMargin, text, fontId, flags, pScheme, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_GROUP_BOX_BEGIN, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_GROUP_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, text, fontId)
	Same as D4D_DECLARE_STD_GROUP_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_GROUP_BOX	(	type,
		name,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		text,
		fontId,
		flags,
		pScheme,
		pUser,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of group box object
x	- coordination of group box in X axis
y	- coordination of group box in Y axis
cx	- size of group box in X axis (width)
cy	- size of group 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)
text	- title text of group box
fontId	- Identification number of the used title text font
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D GRUOP BOX Defines masks of its specific behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
pUser	- user data of object
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_GROUP_BOX structure, including the object data sub structure. Is used to define all properties of group box.

Definition at line 148 of file d4d_group_box.h.

#define D4D_DECLARE_GROUP_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		pMargin,
		text,
		fontId,
		flags,
		pScheme,
		pUser,
		pOnUsrMsg
	)

Macro that create the Group box object structure in memory including all substructures with start of relation object list.

Parameters

name	- name of group box object
x	- coordination of group box in X axis
y	- coordination of group box in Y axis
cx	- size of group box in X axis (width)
cy	- size of group box in Y axis (height)
radius	- radius of corners
pParent	- pointer to parent object(Could be NULL)
pMargin	- pointer to margin structure (*D4D_MARGIN)(Could be NULL)
text	- title text of group box
fontId	- Identification number of the used title text font
flags	- bitmask that specifies initial D4D OBJECT Defines masks of object behaviour flags and D4D GRUOP BOX Defines masks of its specific behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
pUser	- user data of object
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_GROUP_BOX structure, including the object data sub structure. Is used to define all properties of group box. This macro also opens the object relations array for chidren obejct definition. The code example:
D4D_DECLARE_GROUP_BOX_BEGIN(my_group_box, 10, 10, 120, 120, 6, &my_parent_object, &groupBox_marginDefault, D4D_DEFSTR("My Group Box"), MY_FONT, (D4D_GROUP_BOX_F_DEFAULT), NULL, NULL, NULL)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object1)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object2)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object3)

D4D_DECLARE_GROUP_BOX_OBJECT_END

Definition at line 190 of file d4d_group_box.h.

#define D4D_DECLARE_GROUP_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		pMargin,
		text,
		fontId,
		flags,
		pScheme,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 258 of file d4d_group_box.h.

#define D4D_DECLARE_GROUP_BOX_OBJECT ( name )

Macro that adds one child object to group box object relations table declaration.

Parameters

name	- pointer to the child object

Note: This macro is used with D4D_DECLARE_GROUP_BOX_BEGIN & D4D_DECLARE_GROUP_BOX_OBJECT_END to create the goup box children relations table in eGUI Here is an example demonstrating how to used it.
D4D_DECLARE_GROUP_BOX_BEGIN(my_group_box, 10, 10, 120, 120, 6, &my_parent_object, &groupBox_marginDefault, D4D_DEFSTR("My Group Box"), MY_FONT, (D4D_GROUP_BOX_F_DEFAULT), NULL, NULL, NULL)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object1)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object2)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object3)

D4D_DECLARE_GROUP_BOX_OBJECT_END

*

Definition at line 208 of file d4d_group_box.h.

#define D4D_DECLARE_GROUP_BOX_OBJECT_END

Macro that ends children group box object relations table declaration.

Note: This macro is used with D4D_DECLARE_GROUP_BOX_BEGIN & D4D_DECLARE_GROUP_BOX_OBJECT to create the goup box children relations table in eGUI Here is an example demonstrating how to used it.
D4D_DECLARE_GROUP_BOX_BEGIN(my_group_box, 10, 10, 120, 120, 6, &my_parent_object, &groupBox_marginDefault, D4D_DEFSTR("My Group Box"), MY_FONT, (D4D_GROUP_BOX_F_DEFAULT), NULL, NULL, NULL)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object1)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object2)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object3)

D4D_DECLARE_GROUP_BOX_OBJECT_END

*

Definition at line 222 of file d4d_group_box.h.

#define D4D_DECLARE_STD_GROUP_BOX_BEGIN	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		text,
		fontId
	)

Macro that create the Group box object structure in memory including all substructures with start of relation object list The missing parameters are replaced by default values.

Parameters

name	- name of group box object
x	- coordination of group box in X axis
y	- coordination of group box in Y axis
cx	- size of group box in X axis (width)
cy	- size of group box in Y axis (height)
radius	- radius of corners
pParent	- pointer to parent object(Could be NULL)
text	- title text of group box
fontId	- Identification number of the used title text font

Note: This macro create complete D4D_GROUP_BOX structure, including the object data sub structure. Is used to define all properties of group box. This macro also opens the object relations array for chidren obejct definition.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_GROUP_BOX instead of this one. The main advantage is less parameters of this macro against the full version. The code example:
D4D_DECLARE_STD_GROUP_BOX_BEGIN(my_group_box, 10, 10, 120, 120, 6, &my_parent_object, D4D_DEFSTR("My Group Box"), MY_FONT)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object1)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object2)

D4D_DECLARE_GROUP_BOX_OBJECT(&my_child_object3)

D4D_DECLARE_GROUP_BOX_OBJECT_END

Definition at line 250 of file d4d_group_box.h.

#define D4D_DECLARE_STD_GROUP_BOX_BEGIN_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pParent,
		text,
		fontId
	)

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

Definition at line 266 of file d4d_group_box.h.

Macros

Detailed Description

Macro Definition Documentation