eGUI alias D4D  Release 3.0
Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
D4D SCREEN API Functions Specification
D4D SCREEN Handler
Collaboration diagram for D4D SCREEN API Functions Specification:

Functions

D4D_SCREEN * D4D_GetActiveScreen (void)
 Returns pointer to current active screen. More...
 
void D4D_ActivateScreen (const D4D_SCREEN *pNewScreen, D4D_BOOL bReplaceCurrent)
 The function activate the new screen. More...
 
void D4D_EscapeScreen (void)
 The function return to previous screen recorded in the history. More...
 
void D4D_EscapeToBaseScreen (void)
 The function return to base screen recorded in the history. More...
 
void D4D_InitScreen (const D4D_SCREEN *pScreen)
 The function inits the screen and its objects for first time case. More...
 
void D4D_InvalidateScreen (const D4D_SCREEN *pScreen, D4D_BOOL bComplete)
 The function mark the screen and its abject as "redraw pending". More...
 
D4D_OBJECT_PTR D4D_GetFocusedObject (const D4D_SCREEN *pScreen)
 The function returns pointer to object that is focused in given screen. More...
 
void D4D_FocusNextObject (const D4D_SCREEN *pScreen, D4D_BOOL bInitialSearch)
 The function change focus to the next object in the given screen. More...
 
void D4D_FocusPrevObject (const D4D_SCREEN *pScreen)
 The function change focus to the previous object in the given screen. More...
 
void D4D_FocusSet (const D4D_SCREEN *pScreen, D4D_OBJECT_PTR pObject)
 The function set the obejct focus to new object. More...
 
void D4D_SetScreenFontProperties (const D4D_SCREEN *pScreen, D4D_FONT_PROPERTIES property)
 The function sets the screen font properties. More...
 
void D4D_SetScreenTextProperties (const D4D_SCREEN *pScreen, D4D_TEXT_PROPERTIES property)
 The function sets the screen text properties. More...
 
D4D_POINT D4D_GetClientToScreenPoint (D4D_OBJECT *pObject, D4D_POINT *nClientPoint)
 The function convert client point on the screen to the global screen point. More...
 
D4D_POINT D4D_GetScreenToClientPoint (D4D_OBJECT *pObject, D4D_POINT *nScreenPoint)
 The function convert global screen point on the screen to the client point. More...
 
D4D_BOOL D4D_ScrCheckCoor (D4D_SCREEN *pScreen, D4D_POINT *point)
 The function check if the coordination are in screen area. More...
 

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

void D4D_ActivateScreen ( const D4D_SCREEN *  pNewScreen,
D4D_BOOL  bReplaceCurrent 
)

The function activate the new screen.

Parameters
pNewScreen- the pointer to new screen
bReplaceCurrent- the flag to tell function if the new screen should replace previous one in screen buffer
Returns
None
Note
Enter new screen, remember the history if not only replacing

Definition at line 94 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_EscapeScreen ( void  )

The function return to previous screen recorded in the history.

Returns
None
Note
Recall the previous screen in screen history buffer

Definition at line 130 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_EscapeToBaseScreen ( void  )

The function return to base screen recorded in the history.

Returns
None
Note
Recall the base (first) screen in screen history buffer

Definition at line 156 of file d4d_screen.c.

Here is the call graph for this function:

void D4D_FocusNextObject ( const D4D_SCREEN *  pScreen,
D4D_BOOL  bInitialSearch 
)

The function change focus to the next object in the given screen.

Parameters
pScreen- the pointer to screen
bInitialSearch- flag force start looking from the first object in screen object table
Returns
None
Note
In case that there is no other usable object (visible, enable ...) the focus is not changed

Definition at line 286 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_FocusPrevObject ( const D4D_SCREEN *  pScreen)

The function change focus to the previous object in the given screen.

Parameters
pScreen- the pointer to screen
Returns
None
Note
In case that there is no other usable object (visible, enable ...) the focus is not changed

Definition at line 356 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_FocusSet ( const D4D_SCREEN *  pScreen,
D4D_OBJECT_PTR  pObject 
)

The function set the obejct focus to new object.

Parameters
pScreen- the pointer to screen
pObject- the pointer to object that should be focused
Returns
None
Note
In case that there is no other issue (obejct exists, visible, enable ...) the focus is changed to given one

Definition at line 430 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_SCREEN* D4D_GetActiveScreen ( void  )

Returns pointer to current active screen.

Returns
pointer to current active screen
Note
none

Definition at line 78 of file d4d_screen.c.

Here is the caller graph for this function:

D4D_POINT D4D_GetClientToScreenPoint ( D4D_OBJECT *  pObject,
D4D_POINT *  nClientPoint 
)

The function convert client point on the screen to the global screen point.

Parameters
pObject- the pointer to object
nClientPoint- pointer to client point structure
Returns
global screen point
Note
The function already handles also the compounded objects.

Definition at line 536 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_OBJECT_PTR D4D_GetFocusedObject ( const D4D_SCREEN *  pScreen)

The function returns pointer to object that is focused in given screen.

Parameters
pScreen- the pointer to screen
Returns
pointer of focused object in given screen
Note
None.

Definition at line 266 of file d4d_screen.c.

Here is the caller graph for this function:

D4D_POINT D4D_GetScreenToClientPoint ( D4D_OBJECT *  pObject,
D4D_POINT *  nScreenPoint 
)

The function convert global screen point on the screen to the client point.

Parameters
pObject- the pointer to object
nScreenPoint- pointer to global screen point structure
Returns
client screen point
Note
The function already handles also the compounded objects.

Definition at line 586 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_InitScreen ( const D4D_SCREEN *  pScreen)

The function inits the screen and its objects for first time case.

Parameters
pScreen- the pointer to screen
Returns
None
Note
Initialize the the screen. This is keep as a public API to allow user application initialize the screen before it native first use.

Definition at line 184 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_InvalidateScreen ( const D4D_SCREEN *  pScreen,
D4D_BOOL  bComplete 
)

The function mark the screen and its abject as "redraw pending".

Parameters
pScreen- the pointer to screen that should be invalidate
bComplete- flag to mark the the screen and object MUST be redrawed completely, not only the active areas
Returns
None
Note
Invalidate screen and its object in two ways - complete or active areas only.

Definition at line 238 of file d4d_screen.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_BOOL D4D_ScrCheckCoor ( D4D_SCREEN *  pScreen,
D4D_POINT *  point 
)

The function check if the coordination are in screen area.

Parameters
pScreen- the pointer to screen
point- pointer to input point structure
Returns
D4D_TRUE - in case that the coordination fits to the screen area, D4D_FALSE if not
Note
None

Definition at line 634 of file d4d_screen.c.

Here is the call graph for this function:

void D4D_SetScreenFontProperties ( const D4D_SCREEN *  pScreen,
D4D_FONT_PROPERTIES  property 
)

The function sets the screen font properties.

Parameters
pScreen- the pointer to screen
property- font property
Returns
None
Note
Sets the font property for text used natively by screen (title)

Definition at line 503 of file d4d_screen.c.

Here is the call graph for this function:

void D4D_SetScreenTextProperties ( const D4D_SCREEN *  pScreen,
D4D_TEXT_PROPERTIES  property 
)

The function sets the screen text properties.

Parameters
pScreen- the pointer to screen
property- text property
Returns
None
Note
Sets the text property for text used natively by screen (title)

Definition at line 519 of file d4d_screen.c.

Here is the call graph for this function: