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

Macros
#define	_D4D_DECLARE_TEXTBOX(type, name, x, y, cx, cy, radius, pMargin, pParent, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Macro that create the Text box object structure in memory including all substructures. More...

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

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

#define	D4D_DECLARE_STD_RTEXTBOX(name, x, y, cx, cy, radius, pTextArray, pTabTable,fontId)
	Macro that create the rounded Text 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_TEXTBOX_INRAM(name, x, y, cx, cy, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_TEXTBOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_TEXTBOX_INRAM(name, x, y, cx, cy, pTextArray, pTabTable,fontId)
	Same as D4D_DECLARE_STD_TEXTBOX, but is created in RAM instead of the ROM memory. More...

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

#define	D4D_DECLARE_STD_RTEXTBOX_INRAM(name, x, y, cx, cy, radius, pTextArray, pTabTable,fontId)
	Same as D4D_DECLARE_STD_RTEXTBOX, 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_TEXTBOX	(	type,
		name,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pParent,
		pTextArray,
		pTabTable,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of text box object
x	- coordination of text box in X axis
y	- coordination of text box in Y axis
cx	- size of text box in X axis (width)
cy	- size of text box 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)
pTextArray	- pointer to text array that will be showed in text box
pTabTable	- pointer to tabulator table
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 text box
fontId	- identification number of the used text font
pUser	- user data of text box
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_TEXT_BOX structure, including the object data sub structure. Is used to define all properties of text box.

Definition at line 166 of file d4d_text_box.h.

#define D4D_DECLARE_RTEXTBOX	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pTextArray,
		pTabTable,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

name	- name of text box object
x	- coordination of text box in X axis
y	- coordination of text box in Y axis
cx	- size of text box in X axis (width)
cy	- size of text box in Y axis (height)
radius	- radius of corners
pTextArray	- pointer to text array that will be showed in text box
pTabTable	- pointer to tabulator table
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 text box
fontId	- identification number of the used text font
pUser	- user data of text box
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_TEXT_BOX structure, including the object data sub structure. Is used to define all properties of text box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_TEXTBOX instead of this one.

Definition at line 248 of file d4d_text_box.h.

#define D4D_DECLARE_RTEXTBOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pTextArray,
		pTabTable,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 288 of file d4d_text_box.h.

#define D4D_DECLARE_STD_RTEXTBOX	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pTextArray,
		pTabTable,
		fontId
	)

Macro that create the rounded Text 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 text box object
x	- coordination of text box in X axis
y	- coordination of text box in Y axis
cx	- size of text box in X axis (width)
cy	- size of text box in Y axis (height)
radius	- radius of corners
pTextArray	- pointer to text array that will be showed in text box
pTabTable	- pointer to tabulator table
fontId	- identification number of the used text font

Note: This macro create complete D4D_TEXT_BOX structure, including the object data sub structure. Is used to define all properties of text box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_TEXTBOX instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 268 of file d4d_text_box.h.

#define D4D_DECLARE_STD_RTEXTBOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pTextArray,
		pTabTable,
		fontId
	)

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

Definition at line 294 of file d4d_text_box.h.

#define D4D_DECLARE_STD_TEXTBOX	(	name,
		x,
		y,
		cx,
		cy,
		pTextArray,
		pTabTable,
		fontId
	)

Macro that create the Text 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 text box object
x	- coordination of text box in X axis
y	- coordination of text box in Y axis
cx	- size of text box in X axis (width)
cy	- size of text box in Y axis (height)
pTextArray	- pointer to text array that will be showed in text box
pTabTable	- pointer to tabulator table
fontId	- identification number of the used text font

Note: This macro create complete D4D_TEXT_BOX structure, including the object data sub structure. Is used to define all properties of text box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_TEXTBOX instead of this one. The main advantage is less parameters of this macro against the full version.

Definition at line 224 of file d4d_text_box.h.

#define D4D_DECLARE_STD_TEXTBOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		pTextArray,
		pTabTable,
		fontId
	)

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

Definition at line 281 of file d4d_text_box.h.

#define D4D_DECLARE_TEXTBOX	(	name,
		x,
		y,
		cx,
		cy,
		pTextArray,
		pTabTable,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

name	- name of text box object
x	- coordination of text box in X axis
y	- coordination of text box in Y axis
cx	- size of text box in X axis (width)
cy	- size of text box in Y axis (height)
pTextArray	- pointer to text array that will be showed in text box
pTabTable	- pointer to tabulator table
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 text box
fontId	- identification number of the used text font
pUser	- user data of text box
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_TEXT_BOX structure, including the object data sub structure. Is used to define all properties of text box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_TEXTBOX instead of this one.

Definition at line 205 of file d4d_text_box.h.

#define D4D_DECLARE_TEXTBOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		pTextArray,
		pTabTable,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 275 of file d4d_text_box.h.

Macros

Detailed Description

Macro Definition Documentation