D4D SCREEN API Macro's Specification

Collaboration diagram for D4D SCREEN API Macro's Specification:

Macros
#define	_D4D_DECLARE_SCREEN_BEGIN(type, name, funcPrefix, x,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)
	Macro that create the screen structure in memory including all substructures. More...
#define	D4D_DECLARE_SCREEN_BEGIN(name, funcPrefix, x,y, cx, cy, text, fontId, icon, initFlags, pScheme)
	Macro that create the screen structure in ROM memory including all substructures. More...
#define	D4D_DECLARE_STD_SCREEN_BEGIN(name, funcPrefix)
	Macro that create the screen structure in ROM memory with standard settings. More...
#define	D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN(name, funcPrefix)
	Macro that create the screen structure in ROM memory with standard settings in portrait orientation. More...
#define	D4D_DECLARE_RSCREEN_BEGIN(name, funcPrefix, x,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)
	Macro that create the screen structure in ROM memory including all substructures with round corners. More...
#define	D4D_DECLARE_SCREEN_OBJECT(name)
	Macro that is used to add object to screen definition. More...
#define	D4D_DECLARE_SCREEN_END()
	Macro that is used to make end of object array in screen definition. More...
#define	D4D_DECLARE_SCREEN_BEGIN_INRAM(name, funcPrefix, x,y, cx, cy, text, fontId, icon, initFlags, pScheme)
	Macro that create the screen structure in RAM memory including all substructures. More...
#define	D4D_DECLARE_STD_SCREEN_BEGIN_INRAM(name, funcPrefix)
	Macro that create the screen structure in RAM memory with standard settings. More...
#define	D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN_INRAM(name, funcPrefix)
	Macro that create the screen structure in RAM memory with standard settings in portrait orientation. More...
#define	D4D_DECLARE_RSCREEN_BEGIN_INRAM(name, funcPrefix, x,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)
	Macro that create the screen structure in RAM memory including all substructures with round corners. More...
#define	D4D_EXTERN_SCREEN(name)
	Macro that externs the D4D_SCREEN struxture. More...

Detailed Description

This section specifies the exact usage for each API macro.

Macro Definition Documentation

#define _D4D_DECLARE_SCREEN_BEGIN	(		type,
			name,
			funcPrefix,
			x,
			y,
			cx,
			cy,
			radius,
			text,
			fontId,
			icon,
			initFlags,
			pScheme
	)

Macro that create the screen structure in memory including all substructures.

Parameters

type	- type of screen <D4D_CONST; D4D_NO_CONST>
name	- name of screen
funcPrefix	- Prefix Name of screen event handlers
x	- coordination of screen in X axis
y	- coordination of screen in Y axis
cx	- size of screen in X axis
cy	- size of screen in Y axis
radius	- radius of corners
text	- title bar text (if used)
fontId	- title bar text font
icon	- title bar icon picture
initFlags	- init flags of screen corresponding to D4D SCREEN Defines masks of screen behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw screen and objects

Note

This macro create complete D4D_SCREEN structure, including the screen data sub structure. Is used to declare the eGUI screen. This is complete screen declaration macro.

Definition at line 221 of file d4d_screen.h.

#define D4D_DECLARE_RSCREEN_BEGIN	(		name,
			funcPrefix,
			x,
			y,
			cx,
			cy,
			radius,
			text,
			fontId,
			icon,
			initFlags,
			pScheme
	)

Macro that create the screen structure in ROM memory including all substructures with round corners.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers
x	- coordination of screen in X axis
y	- coordination of screen in Y axis
cx	- size of screen in X axis
cy	- size of screen in Y axis
radius	- radius of corners
text	- title bar text (if used)
fontId	- title bar text font
icon	- title bar icon picture
initFlags	- init flags of screen corresponding to D4D SCREEN Defines masks of screen behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw screen and objects

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is screen declaration macro to create screen in ROM with round corners.

Definition at line 310 of file d4d_screen.h.

#define D4D_DECLARE_RSCREEN_BEGIN_INRAM	(		name,
			funcPrefix,
			x,
			y,
			cx,
			cy,
			radius,
			text,
			fontId,
			icon,
			initFlags,
			pScheme
	)

Macro that create the screen structure in RAM memory including all substructures with round corners.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers
x	- coordination of screen in X axis
y	- coordination of screen in Y axis
cx	- size of screen in X axis
cy	- size of screen in Y axis
radius	- radius of corners
text	- title bar text (if used)
fontId	- title bar text font
icon	- title bar icon picture
initFlags	- init flags of screen corresponding to D4D SCREEN Defines masks of screen behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw screen and objects

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is screen declaration macro to create screen in ROM with round corners.

Definition at line 399 of file d4d_screen.h.

#define D4D_DECLARE_SCREEN_BEGIN	(		name,
			funcPrefix,
			x,
			y,
			cx,
			cy,
			text,
			fontId,
			icon,
			initFlags,
			pScheme
	)

Macro that create the screen structure in ROM memory including all substructures.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers
x	- coordination of screen in X axis
y	- coordination of screen in Y axis
cx	- size of screen in X axis
cy	- size of screen in Y axis
text	- title bar text (if used)
fontId	- title bar text font
icon	- title bar icon picture
initFlags	- init flags of screen corresponding to D4D SCREEN Defines masks of screen behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw screen and objects

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is screen declaration macro to create screen in ROM without round corners.

Definition at line 268 of file d4d_screen.h.

#define D4D_DECLARE_SCREEN_BEGIN_INRAM	(		name,
			funcPrefix,
			x,
			y,
			cx,
			cy,
			text,
			fontId,
			icon,
			initFlags,
			pScheme
	)

Macro that create the screen structure in RAM memory including all substructures.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers
x	- coordination of screen in X axis
y	- coordination of screen in Y axis
cx	- size of screen in X axis
cy	- size of screen in Y axis
text	- title bar text (if used)
fontId	- title bar text font
icon	- title bar icon picture
initFlags	- init flags of screen corresponding to D4D SCREEN Defines masks of screen behaviour flags
pScheme	- pointer to color scheme. In case that this parameter is NULL, the default scheme color will be used for draw screen and objects

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is screen declaration macro to create screen in ROM without round corners.

Definition at line 357 of file d4d_screen.h.

#define D4D_DECLARE_SCREEN_END

(

)

Macro that is used to make end of object array in screen definition.

Note

This macro is used after the last D4D_DECLARE_SCREEN_OBJECT declaration to finish the screen object array. Here is an example demonstrating how to used it.

*       D4D_DECLARE_STD_SCREEN_BEGIN(my_screen, MyScreen_)
*       D4D_DECLARE_SCREEN_OBJECT(my_object1)
*       D4D_DECLARE_SCREEN_OBJECT(my_object2)
*       D4D_DECLARE_SCREEN_END()
* 

Definition at line 338 of file d4d_screen.h.

#define D4D_DECLARE_SCREEN_OBJECT

(

name

)

Macro that is used to add object to screen definition.

Parameters

name	- name of object

Note

This macro is used after the screen declaration to add to screen object array new object. Here is an example demonstrating how to used it.

*       D4D_DECLARE_STD_SCREEN_BEGIN(my_screen, MyScreen_)
*       D4D_DECLARE_SCREEN_OBJECT(my_object1)
*       D4D_DECLARE_SCREEN_OBJECT(my_object2)
*       D4D_DECLARE_SCREEN_END()
* 

Definition at line 325 of file d4d_screen.h.

#define D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN	(		name,
			funcPrefix
	)

Macro that create the screen structure in ROM memory with standard settings in portrait orientation.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is simplified screen declaration macro to create screen in ROM without round corners. Instead of some missing parameters are used default one.

Definition at line 289 of file d4d_screen.h.

#define D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN_INRAM	(		name,
			funcPrefix
	)

Macro that create the screen structure in RAM memory with standard settings in portrait orientation.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is simplified screen declaration macro to create screen in ROM without round corners. Instead of some missing parameters are used default one.

Definition at line 378 of file d4d_screen.h.

#define D4D_DECLARE_STD_SCREEN_BEGIN	(		name,
			funcPrefix
	)

Macro that create the screen structure in ROM memory with standard settings.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is simplified screen declaration macro to create screen in ROM without round corners. Instead of some missing parameters are used default one.

Definition at line 278 of file d4d_screen.h.

#define D4D_DECLARE_STD_SCREEN_BEGIN_INRAM	(		name,
			funcPrefix
	)

Macro that create the screen structure in RAM memory with standard settings.

Parameters

name	- name of screen
funcPrefix	- Prefix Name of screen event handlers

Note

This macro create complete D4D_SCREEN structure in ROM, including the screen data sub structure. Is used to declare the eGUI screen. This is simplified screen declaration macro to create screen in ROM without round corners. Instead of some missing parameters are used default one.

Definition at line 367 of file d4d_screen.h.

#define D4D_EXTERN_SCREEN

(

name

)

Macro that externs the D4D_SCREEN struxture.

Parameters

name	of screen structure

Note

This is help macro to write clear D4D code to extern D4D_SCREEN to other C file

Definition at line 407 of file d4d_screen.h.