Collaboration diagram for D4D CONSOLE API Functions Specification:

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

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

void	D4D_CnslClearLine (D4D_OBJECT_PTR pObj, D4D_INDEX line)
	The function clear one line in console. More...

void	D4D_CnslGoToXY (D4D_OBJECT_PTR pObj, D4D_POINT newPosition)
	The function move cursor on new position if possible. More...

D4D_POINT	D4D_CnslGetCursor (D4D_OBJECT_PTR pObj)
	The function returns the cursor position. More...

void	D4D_CnslEnsureVisible (D4D_OBJECT_PTR pObj)
	The function update automatically the scroll bars to ensure visible position of cursor. More...

void	D4D_CnslSetScrollBarPosition (D4D_OBJECT_PTR pObj, D4D_INDEX hor, D4D_INDEX ver)
	The function move the scroll bars on to new position if it's applicable. More...

D4D_POINT	D4D_CnslGetScrollBarPosition (D4D_OBJECT_PTR pObj)
	The function returns the scroll bars position. More...

void	D4D_CnslClearAll (D4D_OBJECT_PTR pObj)
	The function clear whole console data. More...

Detailed Description

This section specifies the exact usage for each API function.

THE EXTERNAL API FUNCTIONS

Function Documentation

void D4D_CnslClearAll ( D4D_OBJECT_PTR pObj )

The function clear whole console data.

Parameters

pObj	- pointer to the console object

Returns: none

Note: It's take something like software reset to default state of console.

Definition at line 734 of file d4d_console.c.

Here is the call graph for this function:

void D4D_CnslClearLine	(	D4D_OBJECT_PTR	pObj,
		D4D_INDEX	line
	)

The function clear one line in console.

Parameters

pObj	- pointer to the console object
line	- index of line that should be cleared

Returns: none

Note: none

Definition at line 619 of file d4d_console.c.

Here is the caller graph for this function:

void D4D_CnslEnsureVisible ( D4D_OBJECT_PTR pObj )

The function update automatically the scroll bars to ensure visible position of cursor.

Parameters

pObj	- pointer to the console object

Returns: none

Note: none

Definition at line 680 of file d4d_console.c.

Here is the call graph for this function:

D4D_POINT D4D_CnslGetCursor ( D4D_OBJECT_PTR pObj )

The function returns the cursor position.

Parameters

pObj	- pointer to the console object

Returns: cursor position

Note: none

Definition at line 664 of file d4d_console.c.

D4D_POINT D4D_CnslGetScrollBarPosition ( D4D_OBJECT_PTR pObj )

The function returns the scroll bars position.

Parameters

pObj	- pointer to the console object

Returns: scroll bars position

Note: none

Definition at line 715 of file d4d_console.c.

Here is the call graph for this function:

void D4D_CnslGoToXY	(	D4D_OBJECT_PTR	pObj,
		D4D_POINT	newPosition
	)

The function move cursor on new position if possible.

Parameters

pObj	- pointer to the console object
newPosition	- new cursor position

Returns: none

Note: The new position of cursor is set if it's possible.

Definition at line 643 of file d4d_console.c.

D4D_BOOL D4D_CnslPutChar	(	D4D_OBJECT_PTR	pObj,
		D4D_TCHAR	ch
	)

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

Parameters

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

Returns: D4D_TRUE - cursor was wrapped / D4D_FALSE - cursor was not wrapped

Note: The result returns if the cursor has been wrapped or not.

Definition at line 498 of file d4d_console.c.

Here is the call graph for this function:

Here is the caller graph for this function:

D4D_BOOL D4D_CnslPutString	(	D4D_OBJECT_PTR	pObj,
		D4D_TCHAR *	pText
	)

The function puts string on cursor position and updates cursor.

Parameters

pObj	- pointer to the console object
pText	- string that will be puts on console

Returns: D4D_TRUE - cursor was wrapped / D4D_FALSE - cursor was not wrapped

Note: The result returns if the cursor has been wrapped or not.

Definition at line 579 of file d4d_console.c.

Here is the call graph for this function:

void D4D_CnslSetScrollBarPosition	(	D4D_OBJECT_PTR	pObj,
		D4D_INDEX	hor,
		D4D_INDEX	ver
	)

The function move the scroll bars on to new position if it's applicable.

Parameters

pObj	- pointer to the console object
hor	- new position of horizontal scroll bar
ver	- new position of vertical scroll bar

Returns: none

Note: none

Definition at line 696 of file d4d_console.c.

Here is the call graph for this function: