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

Macros
#define	_D4D_DECLARE_EDIT_BOX(type, name, x, y, cx, cy, radius, pMargin, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the Edit Box object structure in memory including all substructures. More...

#define	D4D_DECLARE_EDIT_BOX(name, x, y, cx, cy, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the Edit Box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_EDIT_BOX(name, x, y, cx, cy, pRelations, pInitText, fontId, maxStr, pOnEvent)
	Macro that create the Edit 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_REDIT_BOX(name, x, y, cx, cy, radius, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)
	Macro that create the rounded Edit Box object structure in memory including all substructures with restricted count of parameters to simplify definition. More...

#define	D4D_DECLARE_STD_REDIT_BOX(name, x, y, cx, cy, radius, pRelations, pInitText, fontId, maxStr, pOnEvent)
	Macro that create the rounded Edit 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_EDIT_BOX_INRAM(name, x, y, cx, cy, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)
	Same as D4D_DECLARE_EDIT_BOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_EDIT_BOX_INRAM(name, x, y, cx, cy, pRelations, pInitText, fontId, maxStr, pOnEvent)
	Same as D4D_DECLARE_STD_EDIT_BOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_REDIT_BOX_INRAM(name, x, y, cx, cy, radius, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)
	Same as D4D_DECLARE_REDIT_BOX, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_REDIT_BOX_INRAM(name, x, y, cx, cy, radius, pRelations, pInitText, fontId, maxStr, pOnEvent)
	Same as D4D_DECLARE_STD_REDIT_BOX, 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_EDIT_BOX	(	type,
		name,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pRelations,
		flags,
		pScheme,
		pInitText,
		fontId,
		maxStr,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of edit box object
x	- coordination of edit box in X axis
y	- coordination of edit box in Y axis
cx	- size of edit box in X axis (width)
cy	- size of edit 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
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw button
pInitText	- the initialization text of edit box (Could be NULL)
fontId	- Identification number of the used title text font
maxStr	- maximal length of string handled by edit box (it allocates the memory)
pUser	- user data of button
pOnEvent	- Pointer to an on-event user callback function D4D_EDIT_BOX_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_EDIT_BOX structure, including the object data sub structure. Is used to define all properties of Edit Box.

Definition at line 175 of file d4d_edit_box.h.

#define D4D_DECLARE_EDIT_BOX	(	name,
		x,
		y,
		cx,
		cy,
		pRelations,
		flags,
		pScheme,
		pInitText,
		fontId,
		maxStr,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

name	- name of edit box object
x	- coordination of edit box in X axis
y	- coordination of edit box in Y axis
cx	- size of edit box in X axis (width)
cy	- size of edit box in Y axis (height)
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 button
pInitText	- the initialization text of edit box (Could be NULL)
fontId	- Identification number of the used title text font
maxStr	- maximal length of string handled by edit box (it allocates the memory)
pUser	- user data of button
pOnEvent	- Pointer to an on-event user callback function D4D_EDIT_BOX_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_EDIT_BOX structure, including the object data sub structure. Is used to define all properties of Edit Box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_EDIT_BOX instead of this one.

Definition at line 211 of file d4d_edit_box.h.

#define D4D_DECLARE_EDIT_BOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		pRelations,
		flags,
		pScheme,
		pInitText,
		fontId,
		maxStr,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Definition at line 291 of file d4d_edit_box.h.

#define D4D_DECLARE_REDIT_BOX	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pRelations,
		flags,
		pScheme,
		pInitText,
		fontId,
		maxStr,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Parameters

name	- name of edit box object
x	- coordination of edit box in X axis
y	- coordination of edit box in Y axis
cx	- size of edit box in X axis (width)
cy	- size of edit box in Y axis (height)
radius	- radius of corners
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 button
pInitText	- the initialization text of edit box (Could be NULL)
fontId	- Identification number of the used title text font
maxStr	- maximal length of string handled by edit box (it allocates the memory)
pUser	- user data of button
pOnEvent	- Pointer to an on-event user callback function D4D_EDIT_BOX_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_EDIT_BOX structure, including the object data sub structure. Is used to define all properties of Edit Box. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_EDIT_BOX instead of this one.

Definition at line 260 of file d4d_edit_box.h.

#define D4D_DECLARE_REDIT_BOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pRelations,
		flags,
		pScheme,
		pInitText,
		fontId,
		maxStr,
		pUser,
		pOnEvent,
		pOnUsrMsg
	)

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

Definition at line 305 of file d4d_edit_box.h.

#define D4D_DECLARE_STD_EDIT_BOX	(	name,
		x,
		y,
		cx,
		cy,
		pRelations,
		pInitText,
		fontId,
		maxStr,
		pOnEvent
	)

Macro that create the Edit 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 edit box object
x	- coordination of edit box in X axis
y	- coordination of edit box in Y axis
cx	- size of edit box in X axis (width)
cy	- size of edit box in Y axis (height)
pRelations	- pointer to object relation array (Could be NULL)
pInitText	- the initialization text of edit box (Could be NULL)
fontId	- Identification number of the used title text font
maxStr	- maximal length of string handled by edit box (it allocates the memory)
pOnEvent	- Pointer to an on-event user callback function D4D_EDIT_BOX_ON_EVENT

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

Definition at line 233 of file d4d_edit_box.h.

#define D4D_DECLARE_STD_EDIT_BOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		pRelations,
		pInitText,
		fontId,
		maxStr,
		pOnEvent
	)

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

Definition at line 298 of file d4d_edit_box.h.

#define D4D_DECLARE_STD_REDIT_BOX	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pRelations,
		pInitText,
		fontId,
		maxStr,
		pOnEvent
	)

Macro that create the rounded Edit 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 edit box object
x	- coordination of edit box in X axis
y	- coordination of edit box in Y axis
cx	- size of edit box in X axis (width)
cy	- size of edit box in Y axis (height)
radius	- radius of corners
pRelations	- pointer to object relation array (Could be NULL)
pInitText	- the initialization text of edit box (Could be NULL)
fontId	- Identification number of the used title text font
maxStr	- maximal length of string handled by edit box (it allocates the memory)
pOnEvent	- Pointer to an on-event user callback function D4D_EDIT_BOX_ON_EVENT

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

Definition at line 283 of file d4d_edit_box.h.

#define D4D_DECLARE_STD_REDIT_BOX_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		pRelations,
		pInitText,
		fontId,
		maxStr,
		pOnEvent
	)

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

Definition at line 312 of file d4d_edit_box.h.

Macros

Detailed Description

Macro Definition Documentation