Choco OS  V.0.16.9.0
Join to the chocolate world
oC_Terminal_IfCfg_t Struct Reference

#include <oc_terminal.h>

Data Fields

bool(* ResetDevice )(void *Context)
 
bool(* ClearScreen )(void *Context)
 
oC_Terminal_CursorPos_t(* GetCursorPosition )(void *Context)
 
bool(* EnableLineWrap )(void *Context)
 
bool(* DisableLineWrap )(void *Context)
 
bool(* SetCursorHome )(void *Context, oC_Terminal_CursorPos_t CursorPos)
 
bool(* CursorHome )(void *Context)
 
bool(* CursorUp )(void *Context, int Count)
 
bool(* CursorDown )(void *Context, int Count)
 
bool(* CursorForward )(void *Context, int Count)
 
bool(* CursorBackward )(void *Context, int Count)
 
bool(* SaveCursorPosition )(void *Context)
 
bool(* RestoreCursorPosition )(void *Context)
 
bool(* SaveCursorPositionAndAttrs )(void *Context)
 
bool(* RestoreCursorPositionAndAttrs )(void *Context)
 
bool(* EnableScrollScreen )(void *Context)
 
bool(* EnableScrollScreenTo )(void *Context, int startRow, int endRow)
 
bool(* ScrollUp )(void *Context)
 
bool(* ScrollDown )(void *Context)
 
bool(* SetTab )(void *Context)
 
bool(* ClearTab )(void *Context)
 
bool(* ClearAllTabs )(void *Context)
 
bool(* EraseToEndOfLine )(void *Context)
 
bool(* EraseToStartOfLine )(void *Context)
 
bool(* EraseCurrentLine )(void *Context)
 
bool(* SetKeyDefinition )(void *Context, char Key, char *String)
 
bool(* ResetAllAttributes )(void *Context)
 
bool(* SetBright )(void *Context)
 
bool(* SetDim )(void *Context)
 
bool(* SetUnderscore )(void *Context)
 
bool(* SetBlink )(void *Context)
 
bool(* SetReverese )(void *Context)
 
bool(* SetHidden )(void *Context)
 
bool(* SetForegroundColor )(void *Context, oC_Terminal_Color_t Color)
 
bool(* SetBackgroundColor )(void *Context, oC_Terminal_Color_t Color)
 

Detailed Description

The structure with interface configuration

Definition at line 76 of file oc_terminal.h.

Field Documentation

bool(* ClearAllTabs) (void *Context)

Clears all tabs

Returns
true if success

Definition at line 287 of file oc_terminal.h.

bool(* ClearScreen) (void *Context)

Clears screen

Returns
true if success

Definition at line 94 of file oc_terminal.h.

bool(* ClearTab) (void *Context)

Clears tab at current position

Returns
true if success

Definition at line 278 of file oc_terminal.h.

bool(* CursorBackward) (void *Context, int Count)

Moves cursor the Count number characters backward

Parameters
CountCharacters to moves cursor
Returns
true if success

Definition at line 185 of file oc_terminal.h.

bool(* CursorDown) (void *Context, int Count)

Moves cursor the Count line down

Parameters
CountLines to moves cursor
Returns
true if success

Definition at line 163 of file oc_terminal.h.

bool(* CursorForward) (void *Context, int Count)

Moves cursor the Count number characters forward

Parameters
CountCharacters to moves cursor
Returns
true if success

Definition at line 174 of file oc_terminal.h.

bool(* CursorHome) (void *Context)

Sets cursor to home position

Returns
true if success

Definition at line 141 of file oc_terminal.h.

bool(* CursorUp) (void *Context, int Count)

Moves cursor the Count line up

Parameters
CountLines to moves cursor
Returns
true if success

Definition at line 152 of file oc_terminal.h.

bool(* DisableLineWrap) (void *Context)

The function disable wrapping of lines

Returns
true if success

Definition at line 121 of file oc_terminal.h.

bool(* EnableLineWrap) (void *Context)

The function enables wrapping of lines

Returns
true if success

Definition at line 112 of file oc_terminal.h.

bool(* EnableScrollScreen) (void *Context)

Enable scrolling for entire display.

Returns
true if success

Definition at line 230 of file oc_terminal.h.

bool(* EnableScrollScreenTo) (void *Context, int startRow, int endRow)

Enable scrolling from row {startRow} to row {endRow}.

Parameters
startRowstart row of scroll
endRowend row of scroll
Returns
true if success

Definition at line 242 of file oc_terminal.h.

bool(* EraseCurrentLine) (void *Context)

Erases current line

Returns
true if success

Definition at line 314 of file oc_terminal.h.

bool(* EraseToEndOfLine) (void *Context)

Erases from the current cursor position to the end of the current line.

Returns
true if success

Definition at line 296 of file oc_terminal.h.

bool(* EraseToStartOfLine) (void *Context)

Erases from the current cursor position to the start of the current line.

Returns
true if success

Definition at line 305 of file oc_terminal.h.

oC_Terminal_CursorPos_t(* GetCursorPosition) (void *Context)

The function returns current position of the cursor

Returns
structure with position of the cursor

Definition at line 103 of file oc_terminal.h.

bool(* ResetAllAttributes) (void *Context)

Reset all set attributes and restore default values

Returns
true if success

Definition at line 335 of file oc_terminal.h.

bool(* ResetDevice) (void *Context)

The function for reseting terminal device

Returns
true if success

Definition at line 85 of file oc_terminal.h.

bool(* RestoreCursorPosition) (void *Context)

Restores previous saved cursor position

Returns
true if success

Definition at line 203 of file oc_terminal.h.

bool(* RestoreCursorPositionAndAttrs) (void *Context)

Restores cursor position from last save and attributes from last save

Returns
true if success

Definition at line 221 of file oc_terminal.h.

bool(* SaveCursorPosition) (void *Context)

Saves current position of the cursor to restore it later

Returns
true if success

Definition at line 194 of file oc_terminal.h.

bool(* SaveCursorPositionAndAttrs) (void *Context)

Saves current position of the cursor and attributes to restore it later

Returns
true if success

Definition at line 212 of file oc_terminal.h.

bool(* ScrollDown) (void *Context)

Scrolls screen one line down

Returns
true if success

Definition at line 260 of file oc_terminal.h.

bool(* ScrollUp) (void *Context)

Scrolls screen one line up

Returns
true if success

Definition at line 251 of file oc_terminal.h.

bool(* SetBackgroundColor) (void *Context, oC_Terminal_Color_t Color)

Sets background color

Parameters
ColorColor to set
Returns
true if success

Definition at line 411 of file oc_terminal.h.

bool(* SetBlink) (void *Context)

Sets blink

Returns
true if success

Definition at line 371 of file oc_terminal.h.

bool(* SetBright) (void *Context)

Sets bright

Returns
true if success

Definition at line 344 of file oc_terminal.h.

bool(* SetCursorHome) (void *Context, oC_Terminal_CursorPos_t CursorPos)

Sets home position of the cursor

Parameters
CursorPosPosition to set
Returns
true if success

Definition at line 132 of file oc_terminal.h.

bool(* SetDim) (void *Context)

Sets dim

Returns
true if success

Definition at line 353 of file oc_terminal.h.

bool(* SetForegroundColor) (void *Context, oC_Terminal_Color_t Color)

Sets foreground color

Parameters
ColorColor to set
Returns
true if success

Definition at line 400 of file oc_terminal.h.

bool(* SetHidden) (void *Context)

Sets hidden

Returns
true if success

Definition at line 389 of file oc_terminal.h.

bool(* SetKeyDefinition) (void *Context, char Key, char *String)

Associates a string of text to a keyboard key. {key} indicates the key by its ASCII value.

Parameters
KeyAscii code of key to define
StringString to associate with the Key
Returns
true if success

Definition at line 326 of file oc_terminal.h.

bool(* SetReverese) (void *Context)

Sets reverse

Returns
true if success

Definition at line 380 of file oc_terminal.h.

bool(* SetTab) (void *Context)

Sets tab at current position

Returns
true if success

Definition at line 269 of file oc_terminal.h.

bool(* SetUnderscore) (void *Context)

Sets underscore

Returns
true if success

Definition at line 362 of file oc_terminal.h.


The documentation for this struct was generated from the following file: