eGUI alias D4D  Release 3.0
Reference Manual
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
d4d_console.h File Reference
This graph shows which files directly or indirectly include this file:

Macros

#define D4D_CNSL_F_DEFAULT
 This is console init flags. If not defined, it sets to (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_DENTED) as a default. More...
 
#define D4D_CNSL_F_SCRLBRS_DEFAULT
 This is console init flags for embedded scroll bars. If not defined, it sets to (D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED) as a default. More...
 
#define D4D_CNSL_TXT_PRTY_DEFAULT
 This is console init text properties. If not defined, it sets to (D4D_ALIGN_H_LEFT_MASK | D4D_ALIGN_V_CENTER_MASK) as a default. More...
 
#define D4D_CNSL_FNT_PRTY_DEFAULT
 This is console init font properties. If not defined, it sets to ( 0 ) as a default. More...
 
#define D4D_CNSL_CURSOR_HEIGHT
 This is definition of console cursor height . If not defined, it sets to ( 1 ) as a default. More...
 
#define D4D_CNSL_STD_TAB_SIZE
 This is definition of console tab size in pixels. If not defined, it sets to ( 8 ) as a default. More...
 
#define D4D_CNSL_SCRLBR_WIDTH
 This is definition of console scroll bars height . If not defined, it sets to ( 20 ) as a default. More...
 
#define D4D_CNSL_SCRLBR_STEP_V
 This is definition of console vertical scroll bar step (in lines on text). If not defined, it sets to ( 2 ) as a default. More...
 
#define D4D_CNSL_SCRLBR_STEP_H
 This is definition of console horizontal scroll bar step (in characters). If not defined, it sets to ( 8 ) as a default. More...
 
#define D4D_CNSL_CURSOR_BLINK_TICK_COUNTER
 This is definition of console cursor blink time (in ticks of eGUI time ticks - D4D_TimeTickPut). If not defined, it sets to ( 1 ) as a default. More...
 
#define D4D_CNSL_FLAGS_CHECKLINE
 
#define D4D_CNSL_FLAGS_REDRAWALL
 
#define D4D_CNSL_FLAGS_REDRAWLINE
 
#define D4D_CNSL_FLAGS_REDRAWCURSOR
 
#define D4D_CNSL_FLAGS_CURSORSTATE
 
#define D4D_LIST_BOX_CHILD_SCROLL_BAR_HOR_IX
 
#define D4D_LIST_BOX_CHILD_SCROLL_BAR_VER_IX
 
#define D4D_GET_CONSOLE(pObj)
 
#define D4D_GET_CONSOLE_DATA(pObj)
 
#define D4D_GET_LIST_BOX_SCROLL_BAR_HOR(pObj)
 
#define D4D_GET_LIST_BOX_SCROLL_BAR_VER(pObj)
 
#define _D4D_DECLARE_CONSOLE(type, name, x, y, cx, cy, radius, pMargin, pParent, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
 Macro that create the Console object structure in memory including all substructures. More...
 
#define D4D_DECLARE_CONSOLE(name, x, y, cx, cy, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
 Macro that create the Console object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_CONSOLE(name, x, y, cx, cy, line_cnt, char_cnt, fontId)
 Macro that create the Console object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...
 
#define D4D_DECLARE_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
 Macro that create the rounded Console object structure in memory including all substructures with restricted count of parameters to simplify definition. More...
 
#define D4D_DECLARE_STD_RCONSOLE(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId)
 Macro that create the rounded Console object structure in memory including all substructures with restricted count of parameters to simplify definition The missing parameters are replaced by default values. More...
 
#define D4D_DECLARE_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
 Same as D4D_DECLARE_CONSOLE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_CONSOLE_INRAM(name, x, y, cx, cy, line_cnt, char_cnt, fontId)
 Same as D4D_DECLARE_STD_CONSOLE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, tabSize, flags, pScheme, fontId, pUser, pOnUsrMsg)
 Same as D4D_DECLARE_RCONSOLE, but is created in RAM instead of the ROM memory. More...
 
#define D4D_DECLARE_STD_RCONSOLE_INRAM(name, x, y, cx, cy, radius, line_cnt, char_cnt, fontId)
 Same as D4D_DECLARE_STD_RCONSOLE, but is created in RAM instead of the ROM memory. More...
 

Typedefs

typedef Byte D4D_CNSL_FLAGS
 
typedef struct D4D_CNSL_DATA_S D4D_CNSL_DATA
 

Functions

void D4D_CnslScrollBarsFeedBack (D4D_OBJECT *pThis, D4D_INDEX old_position, D4D_INDEX new_position)
 
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...
 
void D4D_CnslEnsureVisible (D4D_OBJECT_PTR pObj)
 The function update automatically the scroll bars to ensure visible position of cursor. More...
 
void D4D_CnslClearAll (D4D_OBJECT_PTR pObj)
 The function clear whole console data. More...
 
D4D_POINT D4D_CnslGetCursor (D4D_OBJECT_PTR pObj)
 The function returns the cursor position. 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...
 

Variables

const D4D_OBJECT_SYS_FUNCTION d4d_consoleSysFunc
 

Detailed Description

D4D Driver label object header file.

Author
Petr Gargulak
Version
0.0.20.0
Date
Oct-14-2013

Definition in file d4d_console.h.

Macro Definition Documentation

#define D4D_CNSL_FLAGS_CHECKLINE

Definition at line 124 of file d4d_console.h.

#define D4D_CNSL_FLAGS_CURSORSTATE

Definition at line 128 of file d4d_console.h.

#define D4D_CNSL_FLAGS_REDRAWALL

Definition at line 125 of file d4d_console.h.

#define D4D_CNSL_FLAGS_REDRAWCURSOR

Definition at line 127 of file d4d_console.h.

#define D4D_CNSL_FLAGS_REDRAWLINE

Definition at line 126 of file d4d_console.h.

#define D4D_GET_CONSOLE (   pObj)

Definition at line 159 of file d4d_console.h.

#define D4D_GET_CONSOLE_DATA (   pObj)

Definition at line 160 of file d4d_console.h.

#define D4D_GET_LIST_BOX_SCROLL_BAR_HOR (   pObj)

Definition at line 161 of file d4d_console.h.

#define D4D_GET_LIST_BOX_SCROLL_BAR_VER (   pObj)

Definition at line 162 of file d4d_console.h.

#define D4D_LIST_BOX_CHILD_SCROLL_BAR_HOR_IX

Definition at line 151 of file d4d_console.h.

#define D4D_LIST_BOX_CHILD_SCROLL_BAR_VER_IX

Definition at line 152 of file d4d_console.h.

Typedef Documentation

Definition at line 122 of file d4d_console.h.

Function Documentation

void D4D_CnslScrollBarsFeedBack ( D4D_OBJECT pThis,
D4D_INDEX  old_position,
D4D_INDEX  new_position 
)

Definition at line 394 of file d4d_console.c.

Here is the call graph for this function:

Variable Documentation

const D4D_OBJECT_SYS_FUNCTION d4d_consoleSysFunc

Definition at line 62 of file d4d_console.c.