Collaboration diagram for D4D LABEL API Macro's Specification:

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

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

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

#define	D4D_DECLARE_STD_RLABEL(name, text, x, y, cx, cy, radius, fontId)
	Macro that create the rounded Label 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_LABEL_INRAM(name, text, x, y, cx, cy, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_LABEL, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_LABEL_INRAM(name, text, x, y, cx, cy, font)
	Same as D4D_DECLARE_STD_LABEL, but is created in RAM instead of the ROM memory. More...

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

#define	D4D_DECLARE_STD_RLABEL_INRAM(name, text, x, y, cx, cy, radius, font)
	Same as D4D_DECLARE_STD_RLABEL, 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_LABEL	(	type,
		name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of label object
text	- title text of label
x	- coordination of label in X axis
y	- coordination of label in Y axis
cx	- size of label in X axis (width)
cy	- size of label 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
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw object
fontId	- Identification number of the used title text font
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_LABEL structure, including the object data sub structure. Is used to define all properties of label. The code example:
_D4D_DECLARE_LABEL(D4D_CONST, my_label, D4D_DEFSTR("My label"), 10, 10, 120, 120, 6, NULL, NULL, (D4D_LABEL_F_DEFAULT), NULL, MY_FONT, NULL, NULL)

Definition at line 132 of file d4d_label.h.

#define D4D_DECLARE_LABEL	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

name	- name of label object
text	- title text of label
x	- coordination of label in X axis
y	- coordination of label in Y axis
cx	- size of label in X axis (width)
cy	- size of label in Y axis (height)
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 object
fontId	- Identification number of the used title text font
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_LABEL structure, including the object data sub structure. Is used to define all properties of label.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LABEL instead of this one. The code example:
D4D_DECLARE_LABEL(my_label, D4D_DEFSTR("My label"), 10, 10, 120, 120, (D4D_LABEL_F_DEFAULT), NULL, MY_FONT, NULL, NULL)

Definition at line 165 of file d4d_label.h.

#define D4D_DECLARE_LABEL_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 245 of file d4d_label.h.

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

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

Parameters

name	- name of label object
text	- title text of label
x	- coordination of label in X axis
y	- coordination of label in Y axis
cx	- size of label in X axis (width)
cy	- size of label in Y axis (height)
radius	- radius of corners
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 object
fontId	- Identification number of the used title text font
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_LABEL structure, including the object data sub structure. Is used to define all properties of label.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LABEL instead of this one. The code example:
D4D_DECLARE_LABEL(my_label, D4D_DEFSTR("My label"), 10, 10, 120, 120, (D4D_LABEL_F_DEFAULT), NULL, MY_FONT, NULL, NULL)

Definition at line 215 of file d4d_label.h.

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

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

Definition at line 258 of file d4d_label.h.

#define D4D_DECLARE_STD_LABEL	(	name,
		text,
		x,
		y,
		cx,
		cy,
		fontId
	)

Macro that create the Label 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 label object
text	- title text of label
x	- coordination of label in X axis
y	- coordination of label in Y axis
cx	- size of label in X axis (width)
cy	- size of label in Y axis (height)
fontId	- Identification number of the used title text font

Note: This macro create complete D4D_LABEL structure, including the object data sub structure. Is used to define all properties of label.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LABEL instead of this one. The main advantage is less parameters of this macro against the full version. The code example:
D4D_DECLARE_STD_LABEL(my_label, D4D_DEFSTR("My label"), 10, 10, 120, 120, MY_FONT)

Definition at line 187 of file d4d_label.h.

#define D4D_DECLARE_STD_LABEL_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		font
	)

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

Definition at line 251 of file d4d_label.h.

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

Macro that create the rounded Label 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 label object
text	- title text of label
x	- coordination of label in X axis
y	- coordination of label in Y axis
cx	- size of label in X axis (width)
cy	- size of label in Y axis (height)
radius	- radius of corners
fontId	- Identification number of the used title text font

Note: This macro create complete D4D_LABEL structure, including the object data sub structure. Is used to define all properties of label.If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_LABEL instead of this one. The main advantage is less parameters of this macro against the full version. The code example:
D4D_DECLARE_STD_LABEL(my_label, D4D_DEFSTR("My label"), 10, 10, 120, 120, MY_FONT)

Definition at line 238 of file d4d_label.h.

#define D4D_DECLARE_STD_RLABEL_INRAM	(	name,
		text,
		x,
		y,
		cx,
		cy,
		radius,
		font
	)

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

Definition at line 264 of file d4d_label.h.

Macros

Detailed Description

Macro Definition Documentation