D4D BASE API Types Specification

Collaboration diagram for D4D BASE API Types Specification:

Data Structures
struct	D4D_MESSAGE_S
	D4D object messages structure. More...

Macros
#define	D4D_OBJECT_DRAWFLAGS_COMPLETE
	Draw complete flag. More...
#define	D4D_OBJECT_DRAWFLAGS_FOCUSED
	Draw fosused state flag. More...
#define	D4D_OBJECT_DRAWFLAGS_CAPTURING
	Draw capturing state flag. More...
#define	D4D_OBJECT_DRAWFLAGS_STATE
	Draw just change of state flag. More...

Typedefs
typedef Byte	D4D_OBJECT_DRAWFLAGS
	Drawing object flags type, handled to object in D4D_MSG_DRAW events. More...
typedef struct D4D_MESSAGE_S	D4D_MESSAGE
	D4D object messages structure. More...

Enumerations
enum	D4D_MSGID {   D4D_MSG_NONE, D4D_MSG_ONINIT, D4D_MSG_DRAW, D4D_MSG_DRAWDONE, D4D_MSG_SETFOCUS, D4D_MSG_KILLFOCUS, D4D_MSG_SETCAPTURE, D4D_MSG_KILLCAPTURE, D4D_MSG_KEYUP, D4D_MSG_KEYDOWN, D4D_MSG_TOUCHED, D4D_MSG_TOUCH_AUTO, D4D_MSG_TOUCH_LOST, D4D_MSG_UNTOUCHED, D4D_MSG_MOUSE_BTN_LEFT_DOWN, D4D_MSG_MOUSE_BTN_LEFT_UP, D4D_MSG_MOUSE_BTN_RIGHT_DOWN, D4D_MSG_MOUSE_BTN_RIGHT_UP, D4D_MSG_MOUSE_BTN_MIDDLE_DOWN, D4D_MSG_MOUSE_BTN_MIDDLE_UP,   D4D_MSG_MOUSE_BTN_WHEEL_UP, D4D_MSG_MOUSE_BTN_WHEEL_DOWN, D4D_MSG_MOUSE_ENTER, D4D_MSG_MOUSE_LEAVE, D4D_MSG_TIMETICK }
	D4D object messages types enumeration. More...
enum	D4D_MSG_HANDLER_ACTION { D4D_MSG_NOSKIP, D4D_MSG_SKIP }
enum	D4D_EVENTID { D4D_EVENT_ONCLICK, D4D_EVENT_ONDOUBLECLICK, D4D_EVENT_ONCHANGE, D4D_EVENT_ONCHANGEDONE, D4D_EVENT_ONRELOAD, D4D_EVENT_ONCLEAR, D4D_EVENT_CNT }
	D4D events that is handled by object callback functions. More...

Detailed Description

This section specifies the exact type for each typedef definition.

---

Data Structure Documentation

struct D4D_MESSAGE_S

Collaboration diagram for D4D_MESSAGE_S:

Data Fields
struct D4D_OBJECT_S *	pObject
	Pointer to object who is receiver of this message. If the receiver is just screen this field must be NULL. More...
struct D4D_SCREEN_S *	pScreen
	Pointer to screen who is receiver of this message. More...
D4D_MSGID	nMsgId
	Type of message. More...
union {
D4D_OBJECT_DRAWFLAGS   draw
	Contains draw flags - is valid with D4D_MSG_DRAW and D4D_MSG_DRAWDONE message. More...
D4D_KEY_SCANCODE   key
	There will be stored only code of key without release / press information - is valid with D4D_MSG_KEYUP and D4D_MSG_KEYDOWN message. More...
}	prm
	Additional data for some type of messages. More...

Field Documentation

D4D_OBJECT_DRAWFLAGS draw

Contains draw flags - is valid with D4D_MSG_DRAW and D4D_MSG_DRAWDONE message.

Definition at line 408 of file d4d_base.h.

D4D_KEY_SCANCODE key

There will be stored only code of key without release / press information - is valid with D4D_MSG_KEYUP and D4D_MSG_KEYDOWN message.

Definition at line 409 of file d4d_base.h.

D4D_MSGID nMsgId

Type of message.

Definition at line 404 of file d4d_base.h.

struct D4D_OBJECT_S* pObject

Pointer to object who is receiver of this message. If the receiver is just screen this field must be NULL.

Definition at line 402 of file d4d_base.h.

union { ... } prm

Additional data for some type of messages.

struct D4D_SCREEN_S* pScreen

Pointer to screen who is receiver of this message.

Definition at line 403 of file d4d_base.h.

Macro Definition Documentation

#define D4D_OBJECT_DRAWFLAGS_CAPTURING

Draw capturing state flag.

Definition at line 363 of file d4d_base.h.

#define D4D_OBJECT_DRAWFLAGS_COMPLETE

Draw complete flag.

Definition at line 361 of file d4d_base.h.

#define D4D_OBJECT_DRAWFLAGS_FOCUSED

Draw fosused state flag.

Definition at line 362 of file d4d_base.h.

#define D4D_OBJECT_DRAWFLAGS_STATE

Draw just change of state flag.

Definition at line 364 of file d4d_base.h.

Typedef Documentation

typedef struct D4D_MESSAGE_S D4D_MESSAGE

D4D object messages structure.

typedef Byte D4D_OBJECT_DRAWFLAGS

Drawing object flags type, handled to object in D4D_MSG_DRAW events.

Definition at line 359 of file d4d_base.h.

Enumeration Type Documentation

enum D4D_EVENTID

D4D events that is handled by object callback functions.

Enumerator
D4D_EVENT_ONCLICK	On Click Event.
D4D_EVENT_ONDOUBLECLICK	On Double Click Event.
D4D_EVENT_ONCHANGE	On Change Event.
D4D_EVENT_ONCHANGEDONE	On Change done (complete change is finished.
D4D_EVENT_ONRELOAD	On Reload.
D4D_EVENT_ONCLEAR
D4D_EVENT_CNT	Keep it on end of list (there is stored count of events)

Definition at line 429 of file d4d_base.h.

enum D4D_MSG_HANDLER_ACTION

Enumerator
D4D_MSG_NOSKIP	The return value of user/application message function - continue handling of message by eGUI.
D4D_MSG_SKIP	The return value of user/application message function - skip handling of message by eGUI.

Definition at line 416 of file d4d_base.h.

enum D4D_MSGID

D4D object messages types enumeration.

Enumerator
D4D_MSG_NONE	Dummy message - could be strached.
D4D_MSG_ONINIT	On Init message - is send for first time when the object is inicialized.
D4D_MSG_DRAW	Draw message - is send when the object should be redrawed.
D4D_MSG_DRAWDONE	Draw Done message - is send after the object is redrawed.
D4D_MSG_SETFOCUS	Set Focus message - is send when the object is getting focus.
D4D_MSG_KILLFOCUS	Kill Focus message - is send when the object is losing focus.
D4D_MSG_SETCAPTURE	Set Capture message - is send when the object is getting capture keys status.
D4D_MSG_KILLCAPTURE	Kill Capture message - is send when the object is losing capture keys status.
D4D_MSG_KEYUP	Key Up message - is send when the object get new Key Up event.
D4D_MSG_KEYDOWN	Key Down message - is send when the object get new Key Down event.
D4D_MSG_TOUCHED	Touched message - is send when the object is touched by touch screen driver.
D4D_MSG_TOUCH_AUTO	Auto Touched message - is send when the object is still keep touch by touch screen driver .
D4D_MSG_TOUCH_LOST	Lost Touch message - is send when the screen is still touch but the coordination leaves the original touched object.
D4D_MSG_UNTOUCHED	UnTouched message - is send when the screen is untouched.
D4D_MSG_MOUSE_BTN_LEFT_DOWN	Mouse Left Button Click message - is send in case that mouse left click is detected on this object.
D4D_MSG_MOUSE_BTN_LEFT_UP	Mouse Left Button Release message - is send in case that mouse left release is detected on this object.
D4D_MSG_MOUSE_BTN_RIGHT_DOWN	Mouse Right Button Click message - is send in case that mouse right click is detected on this object.
D4D_MSG_MOUSE_BTN_RIGHT_UP	Mouse Right Button Release message - is send in case that mouse right release is detected on this object.
D4D_MSG_MOUSE_BTN_MIDDLE_DOWN	Mouse Middle Button Click message - is send in case that mouse middle click is detected on this object.
D4D_MSG_MOUSE_BTN_MIDDLE_UP	Mouse Middle Button Release message - is send in case that mouse middle release is detected on this object.
D4D_MSG_MOUSE_BTN_WHEEL_UP	Mouse Whell Move Up message - is send in case that mouse whell move up is detected on this object.
D4D_MSG_MOUSE_BTN_WHEEL_DOWN	Mouse Whell Move Down message - is send in case that mouse whell move down is detected on this object.
D4D_MSG_MOUSE_ENTER	Mouse Cursor Enter message - is send in case that mouse cursor enter to object area.
D4D_MSG_MOUSE_LEAVE	Mouse Cursor Leave message - is send in case that mouse cursor leave the object area.
D4D_MSG_TIMETICK	Time Tick Occur message - is send with each time tick to object.

Definition at line 367 of file d4d_base.h.