Collaboration diagram for D4D EDIT BOX API Functions Specification:

Functions
D4D_BOOL	D4D_EditBoxPutChar (D4D_OBJECT_PTR pObj, D4D_TCHAR ch)
	The function puts one char on cursor position and updates cursor. More...

D4D_BOOL	D4D_EditBoxPutString (D4D_OBJECT_PTR pObj, D4D_TCHAR *pText)
	The function puts string on cursor position and updates cursor. More...

D4D_INDEX	D4D_EditBoxSetCursor (D4D_OBJECT_PTR pObj, D4D_INDEX newPos)
	The function chenge the cursor position to new one. More...

D4D_INDEX	D4D_EditBoxGetCursor (D4D_OBJECT_PTR pObj)
	The function returns the cursor position. More...

void	D4D_EditBoxClearAll (D4D_OBJECT_PTR pObj)
	The function clear whole edit box data. More...

D4D_TCHAR *	D4D_EditBoxGetText (D4D_OBJECT_PTR pObj)
	The function returns the pointer to the edit box text buffer. More...

Detailed Description

This section specifies the exact usage for each API function.

Function Documentation

void D4D_EditBoxClearAll ( D4D_OBJECT_PTR pObj )

The function clear whole edit box data.

Parameters

pObj	- pointer to the edit box object

Returns: none

Note: none

Definition at line 621 of file d4d_edit_box.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_INDEX D4D_EditBoxGetCursor ( D4D_OBJECT_PTR pObj )

The function returns the cursor position.

Parameters

pObj	- pointer to the edit box object

Returns: the position of cursor

Note: none

Definition at line 604 of file d4d_edit_box.c.

D4D_TCHAR* D4D_EditBoxGetText ( D4D_OBJECT_PTR pObj )

The function returns the pointer to the edit box text buffer.

Parameters

pObj	- pointer to the edit box object

Returns: pointer to edit box text

Note: none

Definition at line 652 of file d4d_edit_box.c.

Here is the caller graph for this function:

D4D_BOOL D4D_EditBoxPutChar	(	D4D_OBJECT_PTR	pObj,
		D4D_TCHAR	ch
	)

The function puts one char on cursor position and updates cursor.

Parameters

pObj	- pointer to the edit box object
ch	- char that will be puts on edit box

Returns: D4D_TRUE - character has been add / D4D_FALSE - character hasn't been add

Note: The result returns if the character was add or not (non printed characters, max count of characters achived).

Definition at line 393 of file d4d_edit_box.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_BOOL D4D_EditBoxPutString	(	D4D_OBJECT_PTR	pObj,
		D4D_TCHAR *	pText
	)

The function puts string on cursor position and updates cursor.

Parameters

pObj	- pointer to the edit box object
pText	- pointer to string that should be added

Returns: D4D_TRUE - string has been completely add / D4D_FALSE - string hasn't ben complete add

Note: The result returns if the string was add or not (non printed characters, max count of characters achived).

Definition at line 455 of file d4d_edit_box.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_INDEX D4D_EditBoxSetCursor	(	D4D_OBJECT_PTR	pObj,
		D4D_INDEX	newPos
	)

The function chenge the cursor position to new one.

Parameters

pObj	- pointer to the edit box object
newPos	- new position index

Returns: the real position of cursor after this operation

Note: The real position could be different to request one in case the the limits are exceed.

Definition at line 490 of file d4d_edit_box.c.

Here is the call graph for this function:

Here is the caller graph for this function: