Collaboration diagram for D4D OBJECT API Types Specification:

Data Structures
struct	D4D_OBJECT_SYS_FUNCTION_S
	The object system function needed for each object - this is part of D4D_OBJECT main structure. More...

struct	D4D_OBJECT_DATA_S
	The object changeble data structure - this is part of D4D_OBJECT main structure. More...

struct	D4D_OBJECT_S
	The object main structure type definition. More...

Typedefs
typedef LWord	D4D_OBJECT_FLAGS
	The object flags type. The masks are described here D4D OBJECT Defines masks of object behaviour flags. More...

typedef LWord	D4D_OBJECT_INITFLAGS
	The object init flags type. The masks are described here D4D OBJECT Defines masks of object behaviour flags. More...

typedef struct D4D_OBJECT_SYS_FUNCTION_S	D4D_OBJECT_SYS_FUNCTION
	The object system function needed for each object - this is part of D4D_OBJECT main structure. More...

typedef struct D4D_OBJECT_DATA_S	D4D_OBJECT_DATA
	The object changeble data structure - this is part of D4D_OBJECT main structure. More...

typedef struct D4D_OBJECT_DATA_S *	D4D_OBJECT_DATA_PTR

typedef void *	D4D_OBJECT_USR_DATA
	The object user data type definition. More...

typedef struct D4D_OBJECT_S const	D4D_OBJECT_RELATIONS
	The object relations type definition. In fact this is array of object pointer , where on position 0 is parent object(if exists) and on other positions are children. More...

typedef Byte(*	D4D_ON_USR_MSG )(struct D4D_MESSAGE_S *pMsg)
	Type definition of object on User message handler function. More...

typedef struct D4D_OBJECT_S	D4D_OBJECT
	The object main structure type definition. More...

typedef const D4D_OBJECT *	D4D_OBJECT_PTR
	The type definition of object pointer to ROM. More...

Detailed Description

This section specifies the exact type for each typedef definition.

Data Structure Documentation

struct D4D_OBJECT_SYS_FUNCTION_S

Collaboration diagram for D4D_OBJECT_SYS_FUNCTION_S:

Data Fields
D4D_TCHAR *	strName
	Object type (widget) name, it also could be used as a identifier of object type. More...

void(*	OnSysMessage )(struct D4D_MESSAGE_S *pMsg)
	Object system message receiver function pointer. More...

D4D_BOOL(*	CheckCoordinates )(struct D4D_OBJECT_S *pObj, D4D_POINT point)
	Object check coordinates function pointer (return true or false if the input point fits into the object, is used just for non standard objects) More...

struct D4D_STRING_S (	GetTextBuffer )(struct D4D_OBJECT_S *pObj)
	Object get text buffer function pointer (the function returns the pointer of the object text buffer, if exists) More...

Field Documentation

D4D_BOOL(* CheckCoordinates)(struct D4D_OBJECT_S *pObj, D4D_POINT point)

Object check coordinates function pointer (return true or false if the input point fits into the object, is used just for non standard objects)

Definition at line 138 of file d4d_object.h.

struct D4D_STRING_S*(* GetTextBuffer)(struct D4D_OBJECT_S *pObj)

Object get text buffer function pointer (the function returns the pointer of the object text buffer, if exists)

Definition at line 139 of file d4d_object.h.

void(* OnSysMessage)(struct D4D_MESSAGE_S *pMsg)

Object system message receiver function pointer.

Definition at line 137 of file d4d_object.h.

D4D_TCHAR* strName

Object type (widget) name, it also could be used as a identifier of object type.

Definition at line 136 of file d4d_object.h.

struct D4D_OBJECT_DATA_S

Collaboration diagram for D4D_OBJECT_DATA_S:

Data Fields
D4D_OBJECT_FLAGS	flags
	runtime object flags More...

struct D4D_SCREEN_S *	pScreen
	pointer to object screen owner - it is placed in RAM bacause one object could be used in multiply screens More...

Field Documentation

D4D_OBJECT_FLAGS flags

runtime object flags

Definition at line 145 of file d4d_object.h.

struct D4D_SCREEN_S* pScreen

pointer to object screen owner - it is placed in RAM bacause one object could be used in multiply screens

Definition at line 146 of file d4d_object.h.

struct D4D_OBJECT_S

Collaboration diagram for D4D_OBJECT_S:

Data Fields
D4D_POINT	position
	Position on the screen/object. More...

D4D_SIZE	size
	Size of the object. More...

D4D_COOR	radius
	Object corners radius. More...

D4D_MARGIN *	pMargin
	Object inner margin. More...

void *	pParam
	The object depends parameters. More...

D4D_OBJECT_SYS_FUNCTION *	pObjFunc
	The pointer on object system functions. More...

D4D_ON_USR_MSG	OnUsrMessage
	The pointer on user message. More...

D4D_OBJECT_USR_DATA	userData
	The pointer on user data container (user pointer and optionaly parent/children). More...

D4D_OBJECT_RELATIONS	pRelations
	Relationship between the objects. More...

D4D_OBJECT_INITFLAGS	initFlags
	The initializations object flags. More...

struct D4D_CLR_SCHEME_S *	clrScheme
	Pointer on used color scheme. More...

D4D_OBJECT_DATA_PTR	pData
	Pointer on runtime object data. More...

Field Documentation

struct D4D_CLR_SCHEME_S* clrScheme

Pointer on used color scheme.

Definition at line 179 of file d4d_object.h.

D4D_OBJECT_INITFLAGS initFlags

The initializations object flags.

Definition at line 178 of file d4d_object.h.

D4D_ON_USR_MSG OnUsrMessage

The pointer on user message.

Definition at line 175 of file d4d_object.h.

D4D_OBJECT_DATA_PTR pData

Pointer on runtime object data.

Definition at line 180 of file d4d_object.h.

D4D_MARGIN* pMargin

Object inner margin.

Definition at line 172 of file d4d_object.h.

D4D_OBJECT_SYS_FUNCTION* pObjFunc

The pointer on object system functions.

Definition at line 174 of file d4d_object.h.

D4D_POINT position

Position on the screen/object.

Definition at line 169 of file d4d_object.h.

void* pParam

The object depends parameters.

Definition at line 173 of file d4d_object.h.

D4D_OBJECT_RELATIONS pRelations

Relationship between the objects.

Definition at line 177 of file d4d_object.h.

D4D_COOR radius

Object corners radius.

Definition at line 171 of file d4d_object.h.

D4D_SIZE size

Size of the object.

Definition at line 170 of file d4d_object.h.

D4D_OBJECT_USR_DATA userData

The pointer on user data container (user pointer and optionaly parent/children).

Definition at line 176 of file d4d_object.h.

Typedef Documentation

typedef struct D4D_OBJECT_S D4D_OBJECT

The object main structure type definition.

Note: This is main object (widget) data structure typically placed in ROM. It contains all common properties of objects

typedef struct D4D_OBJECT_DATA_S D4D_OBJECT_DATA

The object changeble data structure - this is part of D4D_OBJECT main structure.

typedef struct D4D_OBJECT_DATA_S * D4D_OBJECT_DATA_PTR

typedef LWord D4D_OBJECT_FLAGS

The object flags type. The masks are described here D4D OBJECT Defines masks of object behaviour flags.

Definition at line 128 of file d4d_object.h.

typedef LWord D4D_OBJECT_INITFLAGS

The object init flags type. The masks are described here D4D OBJECT Defines masks of object behaviour flags.

Definition at line 131 of file d4d_object.h.

typedef const D4D_OBJECT* D4D_OBJECT_PTR

The type definition of object pointer to ROM.

Definition at line 184 of file d4d_object.h.

typedef struct D4D_OBJECT_S* const* D4D_OBJECT_RELATIONS

The object relations type definition. In fact this is array of object pointer , where on position 0 is parent object(if exists) and on other positions are children.

Definition at line 153 of file d4d_object.h.

typedef struct D4D_OBJECT_SYS_FUNCTION_S D4D_OBJECT_SYS_FUNCTION

The object system function needed for each object - this is part of D4D_OBJECT main structure.

typedef void* D4D_OBJECT_USR_DATA

The object user data type definition.

Definition at line 150 of file d4d_object.h.

typedef Byte(* D4D_ON_USR_MSG)(struct D4D_MESSAGE_S *pMsg)

Type definition of object on User message handler function.

Parameters

pMsg	- pointer to message structure

Returns: none

Note: This is button call back function used to notify user application about On Click button event.

Definition at line 162 of file d4d_object.h.

Data Structures

Typedefs

Detailed Description

Data Structure Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Typedef Documentation