Collaboration diagram for D4D OBJECT API Functions Specification:

Functions
void	D4D_InvalidateObject (D4D_OBJECT_PTR pObject, D4D_BOOL bComplete)
	Function invalidate object to redraw on screen. More...

void	D4D_ShowObject (D4D_OBJECT_PTR pObject, D4D_BOOL bShow)
	Function control visibility of object on screen. More...

void *	D4D_GetUserPointer (D4D_OBJECT *pThis)
	Function return the object user data. More...

void	D4D_EnableTouchScreen (D4D_OBJECT_PTR pObj, D4D_BOOL bEnable, D4D_BOOL bFastTouch)
	Function enables touchs screen capability and sets also mode of touch event. More...

void	D4D_EnableTimeTicks (D4D_OBJECT_PTR pObj, D4D_BOOL bEnable)
	Function enable or diasble receiving timeticks for an OBJECT. More...

void	D4D_CaptureKeys (D4D_OBJECT_PTR pObj)
	Function switch on capturing the keys to objects. More...

D4D_OBJECT *	D4D_GetCapturedObject (void)
	Function returns the current keys capturing object pointer. More...

void	D4D_EnableTabStop (D4D_OBJECT_PTR pObj, D4D_BOOL bEnable)
	Function enables TabStop on the object. More...

void	D4D_EnableObject (D4D_OBJECT_PTR pObj, D4D_BOOL bEnable)
	Function enables object. More...

D4D_BOOL	D4D_IsEnabled (D4D_OBJECT *pObject)
	Function find out if the object is enabled or not. More...

D4D_BOOL	D4D_IsVisible (D4D_OBJECT *pObject)
	Function find out if the object is visible or not. More...

D4D_BOOL	D4D_IsMineFocus (D4D_OBJECT *pObject)
	Function find out if the object (including compounded objects) is focused. More...

D4D_SIZE	D4D_GetClientScreenSize (D4D_OBJECT *pObject)
	The function return the real client size of object. More...

Detailed Description

This section specifies the exact usage for each API function.

Global variables

Function Documentation

void D4D_CaptureKeys ( D4D_OBJECT_PTR pObj )

Function switch on capturing the keys to objects.

Parameters

pObj	- pointer to the object. if the parameter is handled as NULL, the function switch off the capturing the keys to object.

Returns: none.

Note: This function sets the object to the capture keys state. In this state the object obtains all the keys inputs including system navigation keys (escape, up, and down). In this state the object is using capture colors from a color scheme. To switch off from this state the active screen has to be changed or this function has to be called with the input parameter set to NULL.

Definition at line 190 of file d4d_object.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void D4D_EnableObject	(	D4D_OBJECT_PTR	pObj,
		D4D_BOOL	bEnable
	)

Function enables object.

Parameters

pObj	- pointer to the object
bEnable	- <D4D_TRUE - object enabled, D4D_FALSE - enabled disabled>

Returns: none.

Note: This function sets the enabled property. When the object is enabled, it can accept all user inputs and use normal colors. In the disable state the object is redrawn by grayscale colors and all user inputs are ignored. The initialization state is set by parameter flags in the object declaration. This function is targeted for using at run-time.

Definition at line 273 of file d4d_object.c.

Here is the call graph for this function:

void D4D_EnableTabStop	(	D4D_OBJECT_PTR	pObj,
		D4D_BOOL	bEnable
	)

Function enables TabStop on the object.

Parameters

pObj	- pointer to the object
bEnable	- <D4D_TRUE - tabStop enabled, D4D_FALSE - tabStop disabled>

Returns: none.

Note: This function sets the tab stop property. When the tab stop is enabled, the object can be focused. The initialization state is set by the parameter flags in the object declaration. This function is targeted at using for run-time.

Definition at line 255 of file d4d_object.c.

void D4D_EnableTimeTicks	(	D4D_OBJECT_PTR	pObj,
		D4D_BOOL	bEnable
	)

Function enable or diasble receiving timeticks for an OBJECT.

Parameters

pObj	- pointer to the object.
bEnable	- <D4D_TRUE - object will receive periodic time ticks events, D4D_FALSE - object won't receive the time ticks events>

Returns: none.

Note: This function enables gettings the time tick events to object.

Definition at line 172 of file d4d_object.c.

Here is the caller graph for this function:

void D4D_EnableTouchScreen	(	D4D_OBJECT_PTR	pObj,
		D4D_BOOL	bEnable,
		D4D_BOOL	bFastTouch
	)

Function enables touchs screen capability and sets also mode of touch event.

Parameters

pObj	- pointer to the object.
bEnable	- <D4D_TRUE - touch event enabled, D4D_FALSE - touch event disabled>
bFastTouch	- <D4D_TRUE - fast touch mode, D4D_FALSE -standard touch event>

Returns: none.

Note

This function enables touch event for the object and also sets the mode of touch event:

standard mode and fast touch mode. For example for object button the first touch just focused the obejct and second one do click action.
fast touch mode - do both actions at once (more user friendly for touch control).

Definition at line 151 of file d4d_object.c.

D4D_OBJECT* D4D_GetCapturedObject ( void )

Function returns the current keys capturing object pointer.

Returns: Pointer to object that is capturing keys or NULL if no object is capturing keys.

Note: This function returns the pointer to the current object and sets it as a capture keys object. If neither object is set as capture keys, the function returns NULL..

Definition at line 241 of file d4d_object.c.

Here is the caller graph for this function:

D4D_SIZE D4D_GetClientScreenSize ( D4D_OBJECT * pObject )

The function return the real client size of object.

Parameters

pObject - the pointer to object

Returns: client area object size

Note: The function already handles also the compounded objects.

Definition at line 382 of file d4d_object.c.

Here is the call graph for this function:

void* D4D_GetUserPointer ( D4D_OBJECT * pThis )

Function return the object user data.

Parameters

pThis - pointer to the object.

Returns: User data of object.

Note: Each object has user data that could be used what ever user needs and this function returns it.

Definition at line 131 of file d4d_object.c.

void D4D_InvalidateObject	(	D4D_OBJECT_PTR	pObject,
		D4D_BOOL	bComplete
	)

Function invalidate object to redraw on screen.

Parameters

pObject	- pointer to the object that should be invalidate.
bComplete	- force complete redraw of object.

Returns: none.

Note: This function invalidate object what in fact is that force eGUI to redraw object on screen. By the bComplete parameter is select that will be redraw also static parts of object.

Definition at line 71 of file d4d_object.c.

Here is the call graph for this function: