D4D TYPES API Types Specification

Collaboration diagram for D4D TYPES API Types Specification:

Data Structures
struct	D4D_POINT
	Type definition of eGUI point structure. More...
struct	D4D_SIZE
	Type definition of eGUI size structure. More...
struct	D4D_GEOMETRY
	Type definition of eGUI geometry structure. More...
struct	D4D_MARGIN
	Type definition of eGUI client area margin structure. More...
struct	D4D_TAB
	Type definition of eGUI tabulation structure. More...
struct	D4D_TOUCHSCREEN_CALIB
	Type definition of eGUI touch screen calibration structure. More...
struct	D4D_TOUCHSCREEN_EVENT
	Type definition of eGUI touch screen event structure. More...

Macros
#define	NULL
	Type definition of null pointer. More...
#define	D4D_WCHAR_TYPE
	User type definition of eGUI wide char. More...

Typedefs
typedef unsigned char	Byte
	Type definition of Byte (unsigned 8-bit). More...
typedef signed char	sByte
	Type definition of sByte (signed 8-bit). More...
typedef unsigned short	Word
	Type definition of Word (unsigned 16-bit). More...
typedef signed short	sWord
	Type definition of sWord (signed 16-bit). More...
typedef unsigned long	LWord
	Type definition of LWord (unsigned 32-bit). More...
typedef signed long	sLWord
	Type definition of sLWord (signed 32-bit). More...
typedef unsigned long long	DLWord
	Type definition of DLWord (unsigned 64-bit). More...
typedef signed long long	sDLWord
	Type definition of sDLWord (signed 64-bit). More...
typedef LWord	D4D_BOOL
	Type definition of eGUI boolean. More...
typedef LWord	D4D_INDEX
	Type definition of eGUI general index variables. More...
typedef sLWord	D4D_INDEX_DELTA
	Type definition of eGUI general index variables for signed offsets. More...
typedef Byte	D4D_COOR
	Type definition of eGUI coordination variables. More...
typedef struct D4D_MARGIN *	D4D_MARGIN_PTR
typedef LWord	D4D_COLOR
	Type definition of eGUI color variables. More...
typedef D4D_WCHAR_TYPE	D4D_WCHAR
	Type definition of eGUI wide char. More...
typedef char	D4D_CHAR
	Type definition of eGUI ASCII character. More...
typedef D4D_WCHAR	D4D_TCHAR
	Type definition of eGUI character (it depends on UNICODE setting if this is D4D_CHAR or D4D_WCHAR). More...
typedef void *	D4D_FILEPTR
	Type definition of eGUI file pointer. More...
typedef Byte	D4D_KEYS
	Type definition of eGUI keys - this is obsolete type that is kept just only for backward compatibility. More...
typedef Byte	D4D_KEY_SCANCODE
	Type definition of eGUI keys scan code. More...

Enumerations
enum	D4D_LINETYPE { D4D_LINE_THIN, D4D_LINE_THICK }
	Type definition of eGUI line type. More...
enum	D4D_DIRECTION { D4D_DIR_UP, D4D_DIR_DOWN, D4D_DIR_RIGHT, D4D_DIR_LEFT }
	Type definition of eGUI direction type. More...
enum	D4D_TREND { D4D_CLOCK_WISE, D4D_ANTI_CLOCK_WISE }
	Type definition of eGUI trend type. More...
enum	D4D_QUADRANT { D4D_QUAD_1, D4D_QUAD_2, D4D_QUAD_3, D4D_QUAD_4 }
	Type definition of eGUI circle quadrant. More...
enum	D4D_BEVEL { D4D_BEVEL_NONE, D4D_BEVEL_RAISED, D4D_BEVEL_DENTED, D4D_BEVEL_RESERVED }
	Type definition of eGUI bevel type. More...
enum	D4D_ORIENTATION { D4D_ORIENT_PORTRAIT, D4D_ORIENT_PORTRAIT180, D4D_ORIENT_LANDSCAPE, D4D_ORIENT_LANDSCAPE180 }
	Type definition of eGUI display orientation. More...

Detailed Description

This section specifies the exact type for each typedef definition.

---

Data Structure Documentation

struct D4D_POINT

Collaboration diagram for D4D_POINT:

Data Fields
D4D_COOR	x
	Coordination in axis X. More...
D4D_COOR	y
	Coordination in axis Y. More...

Field Documentation

D4D_COOR x

Coordination in axis X.

Definition at line 225 of file d4d_types.h.

D4D_COOR y

Coordination in axis Y.

Definition at line 226 of file d4d_types.h.

struct D4D_SIZE

Collaboration diagram for D4D_SIZE:

Data Fields
D4D_COOR	cx
	Size in axis X (width) More...
D4D_COOR	cy
	Size in axis Y (height) More...

Field Documentation

D4D_COOR cx

Size in axis X (width)

Definition at line 232 of file d4d_types.h.

D4D_COOR cy

Size in axis Y (height)

Definition at line 233 of file d4d_types.h.

struct D4D_GEOMETRY

Collaboration diagram for D4D_GEOMETRY:

Data Fields
D4D_POINT	pnt
	Left Top corner point. More...
D4D_SIZE	sz
	Size of object. More...

Field Documentation

D4D_POINT pnt

Left Top corner point.

Definition at line 239 of file d4d_types.h.

D4D_SIZE sz

Size of object.

Definition at line 240 of file d4d_types.h.

struct D4D_MARGIN

Collaboration diagram for D4D_MARGIN:

Data Fields
D4D_COOR	left
	Margin of left side. More...
D4D_COOR	top
	Margin of top side. More...
D4D_COOR	right
	Margin of right side. More...
D4D_COOR	bottom
	Margin of bottom side. More...

Field Documentation

D4D_COOR bottom

Margin of bottom side.

Definition at line 249 of file d4d_types.h.

D4D_COOR left

Margin of left side.

Definition at line 246 of file d4d_types.h.

D4D_COOR right

Margin of right side.

Definition at line 248 of file d4d_types.h.

D4D_COOR top

Margin of top side.

Definition at line 247 of file d4d_types.h.

struct D4D_TAB

Collaboration diagram for D4D_TAB:

Data Fields
D4D_COOR *	pTabTable
	Pointer to tabulator table. More...
D4D_COOR	tabOffset
	Start offset of tabulator. More...

Field Documentation

D4D_COOR* pTabTable

Pointer to tabulator table.

Definition at line 255 of file d4d_types.h.

D4D_COOR tabOffset

Start offset of tabulator.

Definition at line 256 of file d4d_types.h.

struct D4D_TOUCHSCREEN_CALIB

Collaboration diagram for D4D_TOUCHSCREEN_CALIB:

Data Fields
unsigned char	ScreenCalibrated
	Boolean if the values are valid. More...
unsigned short	TouchScreenXoffset
	Input value offset in axis X. More...
unsigned short	TouchScreenYoffset
	Input value offset in axis Y. More...
unsigned short	TouchScreenXBitsPerPixelx16
	Input value gain per 16 pixels in axis X. More...
unsigned short	TouchScreenYBitsPerPixelx16
	Input value gain per 16 pixels in axis Y. More...

Field Documentation

unsigned char ScreenCalibrated

Boolean if the values are valid.

Definition at line 352 of file d4d_types.h.

unsigned short TouchScreenXBitsPerPixelx16

Input value gain per 16 pixels in axis X.

Definition at line 355 of file d4d_types.h.

unsigned short TouchScreenXoffset

Input value offset in axis X.

Definition at line 353 of file d4d_types.h.

unsigned short TouchScreenYBitsPerPixelx16

Input value gain per 16 pixels in axis Y.

Definition at line 356 of file d4d_types.h.

unsigned short TouchScreenYoffset

Input value offset in axis Y.

Definition at line 354 of file d4d_types.h.

struct D4D_TOUCHSCREEN_EVENT

Collaboration diagram for D4D_TOUCHSCREEN_EVENT:

Data Fields
D4D_BOOL	touched
	Boolean of touch state (touched or non touched) More...
D4D_POINT	point
	Point of touch event or lost of touch event. More...

Field Documentation

D4D_POINT point

Point of touch event or lost of touch event.

Definition at line 363 of file d4d_types.h.

D4D_BOOL touched

Boolean of touch state (touched or non touched)

Definition at line 362 of file d4d_types.h.

Macro Definition Documentation

#define D4D_WCHAR_TYPE

User type definition of eGUI wide char.

Definition at line 273 of file d4d_types.h.

#define NULL

Type definition of null pointer.

Definition at line 184 of file d4d_types.h.

Typedef Documentation

typedef unsigned char Byte

Type definition of Byte (unsigned 8-bit).

Definition at line 151 of file d4d_types.h.

typedef LWord D4D_BOOL

Type definition of eGUI boolean.

Definition at line 204 of file d4d_types.h.

typedef char D4D_CHAR

Type definition of eGUI ASCII character.

Definition at line 280 of file d4d_types.h.

typedef LWord D4D_COLOR

Type definition of eGUI color variables.

Definition at line 262 of file d4d_types.h.

typedef Byte D4D_COOR

Type definition of eGUI coordination variables.

Definition at line 219 of file d4d_types.h.

typedef void* D4D_FILEPTR

Type definition of eGUI file pointer.

Definition at line 298 of file d4d_types.h.

typedef LWord D4D_INDEX

Type definition of eGUI general index variables.

Definition at line 206 of file d4d_types.h.

typedef sLWord D4D_INDEX_DELTA

Type definition of eGUI general index variables for signed offsets.

Definition at line 208 of file d4d_types.h.

typedef Byte D4D_KEY_SCANCODE

Type definition of eGUI keys scan code.

Definition at line 304 of file d4d_types.h.

typedef Byte D4D_KEYS

Type definition of eGUI keys - this is obsolete type that is kept just only for backward compatibility.

Definition at line 301 of file d4d_types.h.

typedef struct D4D_MARGIN * D4D_MARGIN_PTR

typedef D4D_WCHAR D4D_TCHAR

Type definition of eGUI character (it depends on UNICODE setting if this is D4D_CHAR or D4D_WCHAR).

Definition at line 284 of file d4d_types.h.

typedef D4D_WCHAR_TYPE D4D_WCHAR

Type definition of eGUI wide char.

Definition at line 277 of file d4d_types.h.

typedef unsigned long long DLWord

Type definition of DLWord (unsigned 64-bit).

Definition at line 175 of file d4d_types.h.

typedef unsigned long LWord

Type definition of LWord (unsigned 32-bit).

Definition at line 167 of file d4d_types.h.

typedef signed char sByte

Type definition of sByte (signed 8-bit).

Definition at line 155 of file d4d_types.h.

typedef signed long long sDLWord

Type definition of sDLWord (signed 64-bit).

Definition at line 179 of file d4d_types.h.

typedef signed long sLWord

Type definition of sLWord (signed 32-bit).

Definition at line 171 of file d4d_types.h.

typedef signed short sWord

Type definition of sWord (signed 16-bit).

Definition at line 163 of file d4d_types.h.

typedef unsigned short Word

Type definition of Word (unsigned 16-bit).

Definition at line 159 of file d4d_types.h.

Enumeration Type Documentation

enum D4D_BEVEL

Type definition of eGUI bevel type.

Enumerator
D4D_BEVEL_NONE	None Bevel is used.
D4D_BEVEL_RAISED	Raised bevel type.
D4D_BEVEL_DENTED	Dented bevel type.
D4D_BEVEL_RESERVED	Reserved for future use.

Definition at line 332 of file d4d_types.h.

enum D4D_DIRECTION

Type definition of eGUI direction type.

Enumerator
D4D_DIR_UP	Direction UP.
D4D_DIR_DOWN	Direction DOWN.
D4D_DIR_RIGHT	Direction RIGHT.
D4D_DIR_LEFT	Direction LEFT.

Definition at line 307 of file d4d_types.h.

enum D4D_LINETYPE

Type definition of eGUI line type.

Enumerator
D4D_LINE_THIN	Line type thin.
D4D_LINE_THICK	Line type thick.

Definition at line 291 of file d4d_types.h.

enum D4D_ORIENTATION

Type definition of eGUI display orientation.

Enumerator
D4D_ORIENT_PORTRAIT	Portrait orientation.
D4D_ORIENT_PORTRAIT180	Portrait up side down orientation.
D4D_ORIENT_LANDSCAPE	Landscape orientation.
D4D_ORIENT_LANDSCAPE180	Landscape up side down orientation.

Definition at line 341 of file d4d_types.h.

enum D4D_QUADRANT

Type definition of eGUI circle quadrant.

Enumerator
D4D_QUAD_1	First quadrant <0-90)
D4D_QUAD_2	Second quadrant <90-180)
D4D_QUAD_3	Third quadrant <180-270)
D4D_QUAD_4	Fourth quadrant <270-360)

Definition at line 323 of file d4d_types.h.

enum D4D_TREND

Type definition of eGUI trend type.

Enumerator
D4D_CLOCK_WISE	Trend Clock Wise.
D4D_ANTI_CLOCK_WISE	Trend Anti Clock Wise.

Definition at line 316 of file d4d_types.h.