Collaboration diagram for D4D BASE API Functions Specification:

Macros
#define	D4D_GetTextBuffWidthTabAdj(text_buffer, pTab)
	Function gets the string width in pixels and counts with tabulator table. More...

#define	D4D_GetTextBuffWidth(text_buffer)
	Function gets the string width in pixels. More...

Functions
D4D_BOOL	D4D_Init (const D4D_SCREEN *pInitScreen)
	Function inits the eGUI itself including all low level drivers. More...

void	D4D_Poll (void)
	Main eGUI function. Must be periodically called in main loop/task loop. More...

void	D4D_SetOrientation (D4D_ORIENTATION orient)
	Set screen orientation function. More...

void	D4D_TimeTickPut (void)
	Notify eGui about new tick tick occur. More...

void	D4D_ClearKeysBuffer (void)
	Clear all rest information about pushed Keys in buffer. More...

void	D4D_EnableSystemKeys (D4D_BOOL bEnable)
	Function enable or disable handling system keys (ESC, UP/DOWN, LEFT/RIGHT) automatically. More...

void	D4D_KeysChanged (D4D_KEYS keys)
	Place to keys buffer new keys events by binary mask. More...

void	D4D_NewKeyEvent (D4D_KEY_SCANCODE scanCode)
	Place to key event into key buffer. More...

void	D4D_SetFontProperties (D4D_OBJECT_PTR pObject, D4D_FONT_PROPERTIES property)
	Function sets object text font properties. More...

void	D4D_SetTextProperties (D4D_OBJECT_PTR pObject, D4D_TEXT_PROPERTIES property)
	Function sets object text properties. More...

D4D_POINT	D4D_SwapCoor (D4D_POINT point)
	Function swap the point coordination. More...

D4D_COOR	D4D_GetLongerSide (D4D_SIZE *pSz)
	Function returns longer side of size structure. More...

void	D4D_FlushOutput (void)
	Function force flush output to LCD. More...

Detailed Description

This section specifies the exact usage for each API function.

Macro Definition Documentation

#define D4D_GetTextBuffWidth ( text_buffer )

Function gets the string width in pixels.

Parameters

text_buffer - pointer to string structure

Returns: width in pixels of text

Note: Obsolete function name -keeped here just for backward compatibility. Replaced by D4D_GetTextBuffWidthTab(text_buffer, pTab).

Definition at line 553 of file d4d_base.h.

#define D4D_GetTextBuffWidthTabAdj	(	text_buffer,
		pTab
	)

Function gets the string width in pixels and counts with tabulator table.

Parameters

text_buffer	- pointer to string structure
pTab	- pointer to tabulator structure

Returns: width in pixels of text and function counts with tabulator table

Note: Obsolete function name -keeped here just for backward compatibility. Replaced by D4D_GetTextBuffWidthTab(text_buffer, pTab).

Definition at line 544 of file d4d_base.h.

Function Documentation

void D4D_ClearKeysBuffer ( void )

Clear all rest information about pushed Keys in buffer.

Returns: none

Note: Function clears the input keys buffer.

Definition at line 244 of file d4d_base.c.

Here is the caller graph for this function:

void D4D_EnableSystemKeys ( D4D_BOOL bEnable )

Function enable or disable handling system keys (ESC, UP/DOWN, LEFT/RIGHT) automatically.

Parameters

bEnable - <D4D_TRUE - eGUI will handle system keys automatically, D4D_FALSE - the system keys will be ignored and it will be normally handled to screen and focused object

Returns: none.

Note: This function enables handling the system keys.

Definition at line 256 of file d4d_base.c.

void D4D_FlushOutput ( void )

Function force flush output to LCD.

Returns: none

Note: It usable in system with cache etc.

Definition at line 563 of file d4d_base.c.

D4D_COOR D4D_GetLongerSide ( D4D_SIZE * pSz )

Function returns longer side of size structure.

Parameters

pSz	- input size coordination

Returns: longer size of size input structure

Note: none

Definition at line 550 of file d4d_base.c.

D4D_BOOL D4D_Init ( const D4D_SCREEN * pInitScreen )

Function inits the eGUI itself including all low level drivers.

Parameters

pInitScreen - the first initialized screen. Could be NULL in case that no screen should be initialized after startup.

Returns: result of init operation. D4D_TRUE - everything runs OK, D4D_FALSE initialization failed.

Note: This function initialized complete eGUI, after this function runs, the HW is ready and all internal variables are also prepared to run eGUI. Must be run as a First function of eGUI in project.

Definition at line 122 of file d4d_base.c.

Here is the call graph for this function:

void D4D_KeysChanged ( D4D_KEYS keys )

Place to keys buffer new keys events by binary mask.

Parameters

keys	- keys mask

Returns: none

Note: This is obsolete function, kept here just for backward application compatibility. It's recommended to use void D4D_NewKeyEvent(D4D_KEY_SCANCODE scanCode).

Definition at line 272 of file d4d_base.c.

Here is the call graph for this function:

void D4D_NewKeyEvent ( D4D_KEY_SCANCODE scanCode )

Place to key event into key buffer.

Parameters

scanCode - new key scan event

Returns: none

Note: This function puts the new key event. It's recommanded fuction for input the keys.

Definition at line 347 of file d4d_base.c.

Here is the caller graph for this function:

void D4D_Poll ( void )

Main eGUI function. Must be periodically called in main loop/task loop.

Returns: none

Note: This is the main function that is handling all eGUI inputs and also drawings.

Definition at line 159 of file d4d_base.c.

Here is the call graph for this function:

void D4D_SetFontProperties	(	D4D_OBJECT_PTR	pObject,
		D4D_FONT_PROPERTIES	property
	)

Function sets object text font properties.

Parameters

pObject	- pointer to object that has to have changed font properties
property	- new font properties

Returns: none

Note: Function sets the font properties of major object text.

Definition at line 485 of file d4d_base.c.

Here is the call graph for this function:

void D4D_SetOrientation ( D4D_ORIENTATION orient )

Set screen orientation function.

Parameters

orient - the requested new orientation

Returns: none

Note: Function change the orientation of screen, invoke complete redraw

Definition at line 213 of file d4d_base.c.

Here is the call graph for this function:

void D4D_SetTextProperties	(	D4D_OBJECT_PTR	pObject,
		D4D_TEXT_PROPERTIES	property
	)

Function sets object text properties.

Parameters

pObject	- pointer to object that has to have changed text properties
property	- new text properties

Returns: none

Note: Function sets the text properties of major object string.

Definition at line 511 of file d4d_base.c.

Here is the call graph for this function:

D4D_POINT D4D_SwapCoor ( D4D_POINT point )

Function swap the point coordination.

Parameters

point - input size coordination

Returns: swapped X&Y point structure

Note: none

Definition at line 534 of file d4d_base.c.

Here is the caller graph for this function:

void D4D_TimeTickPut ( void )

Notify eGui about new tick tick occur.

Returns: none

Note: Function is used to periodical notify eGUI that time tick occur. It usually call from any periodic source. It also could be called from interrupt.

Definition at line 234 of file d4d_base.c.

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation