Collaboration diagram for D4D CONSOLE API Macro's Specification:

Macros
#define	_D4D_DECLARE_CONSOLE(type, name, x, y, cx, cy, radius, pMargin, pParent, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Macro that create the Console object structure in memory including all substructures. More...

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

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

#define	D4D_DECLARE_STD_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId)
	Macro that create the rounded Console 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_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_CONSOLE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, fontId)
	Same as D4D_DECLARE_STD_CONSOLE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
	Same as D4D_DECLARE_RCONSOLE, but is created in RAM instead of the ROM memory. More...

#define	D4D_DECLARE_STD_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId)
	Same as D4D_DECLARE_STD_RCONSOLE, 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_CONSOLE	(	type,
		name,
		x,
		y,
		cx,
		cy,
		radius,
		pMargin,
		pParent,
		line_cnt,
		char_cnt,
		tabSize,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

type	- type of object <D4D_CONST; D4D_NO_CONST>
name	- name of console object
x	- coordination of console in X axis
y	- coordination of console in Y axis
cx	- size of console in X axis (width)
cy	- size of console 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)
line_cnt	- count of lines to allocate memory array
char_cnt	- count of characters per line to allocate memory array
tabSize	- size of tabulator in characteres (to meet standard behaviour of console)
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 console
fontId	- Identification number of the used text font
pUser	- user data of console
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_CONSOLE structure, including the object data sub structure. Is used to define all properties of console.

Definition at line 195 of file d4d_console.h.

#define D4D_DECLARE_CONSOLE	(	name,
		x,
		y,
		cx,
		cy,
		line_cnt,
		char_cnt,
		tabSize,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

name	- name of console object
x	- coordination of console in X axis
y	- coordination of console in Y axis
cx	- size of console in X axis (width)
cy	- size of console in Y axis (height)
line_cnt	- count of lines to allocate memory array
char_cnt	- count of characters per line to allocate memory array
tabSize	- size of tabulator in characteres (to meet standard behaviour of console)
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 console
fontId	- Identification number of the used text font
pUser	- user data of console
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_CONSOLE structure, including the object data sub structure. Is used to define all properties of console. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CONSOLE instead of this one.

Definition at line 241 of file d4d_console.h.

#define D4D_DECLARE_CONSOLE_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		line_cnt,
		char_cnt,
		tabSize,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 313 of file d4d_console.h.

#define D4D_DECLARE_RCONSOLE	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		line_cnt,
		char_cnt,
		tabSize,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Parameters

name	- name of console object
x	- coordination of console in X axis
y	- coordination of console in Y axis
cx	- size of console in X axis (width)
cy	- size of console in Y axis (height)
radius	- radius of corners
line_cnt	- count of lines to allocate memory array
char_cnt	- count of characters per line to allocate memory array
tabSize	- size of tabulator in characteres (to meet standard behaviour of console)
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 console
fontId	- Identification number of the used text font
pUser	- user data of console
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_CONSOLE structure, including the object data sub structure. Is used to define all properties of console. If there is missing parameter that is needed by user application used the full macro _D4D_DECLARE_CONSOLE instead of this one.

Definition at line 285 of file d4d_console.h.

#define D4D_DECLARE_RCONSOLE_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		line_cnt,
		char_cnt,
		tabSize,
		flags,
		pScheme,
		fontId,
		pUser,
		pOnUsrMsg
	)

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

Definition at line 326 of file d4d_console.h.

#define D4D_DECLARE_STD_CONSOLE	(	name,
		x,
		y,
		cx,
		cy,
		line_cnt,
		char_cnt,
		fontId
	)

Macro that create the Console 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 console object
x	- coordination of console in X axis
y	- coordination of console in Y axis
cx	- size of console in X axis (width)
cy	- size of console in Y axis (height)
line_cnt	- count of lines to allocate memory array
char_cnt	- count of characters per line to allocate memory array
fontId	- Identification number of the used text font

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

Definition at line 260 of file d4d_console.h.

#define D4D_DECLARE_STD_CONSOLE_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		line_cnt,
		char_cnt,
		fontId
	)

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

Definition at line 319 of file d4d_console.h.

#define D4D_DECLARE_STD_RCONSOLE	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		line_cnt,
		char_cnt,
		fontId
	)

Macro that create the rounded Console 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 console object
x	- coordination of console in X axis
y	- coordination of console in Y axis
cx	- size of console in X axis (width)
cy	- size of console in Y axis (height)
radius	- radius of corners
line_cnt	- count of lines to allocate memory array
char_cnt	- count of characters per line to allocate memory array
fontId	- Identification number of the used text font

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

Definition at line 305 of file d4d_console.h.

#define D4D_DECLARE_STD_RCONSOLE_INRAM	(	name,
		x,
		y,
		cx,
		cy,
		radius,
		line_cnt,
		char_cnt,
		fontId
	)

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

Definition at line 332 of file d4d_console.h.

Macros

Detailed Description

Macro Definition Documentation