Libraries
Console Source Code
 previous   up   next 

Types
console_file
Text implementation type for text console/window.

console_file

const type: console_file

Text implementation type for text console/window. This type allows writing to text terminals, terminal emulations and console windows.


Variable Summary
console_file
STD_CONSOLE
Standard console file of the current process.

Function Summary
console_file
open (CONSOLE)
Creates a console_file at the upper left corner of the console/window.
void
flush (in console_file: aFile)
Forces that all buffered data of aFile is sent to its destination.
integer
height (in console_file: aConsoleFile)
Get the height of 'aConsoleFile'.
integer
width (in console_file: aConsoleFile)
Get the width of 'aConsoleFile'.
void
setPos (in console_file: aConsoleFile, in integer: line, in integer: column)
Set the current position of 'aConsoleFile' to 'line' and 'column'.
integer
column (in console_file: aConsoleFile)
Get the cursor column of 'aConsoleFile'.
integer
line (in console_file: aConsoleFile)
Get the cursor line of 'aConsoleFile'.
void
clear (in console_file: aConsoleFile, in integer: upper, in integer: left, in integer: lower, in integer: right)
Clear an area of aConsoleFile with space characters.
void
clear (in console_file: aConsoleFile)
Clear 'aConsoleFile' with space characters.
void
write (in console_file: aConsoleFile, in string: stri)
Write a string to the current position of 'aConsoleFile'.

Variable Detail

STD_CONSOLE

var console_file: STD_CONSOLE

Standard console file of the current process. When characters are written to STD_CONSOLE they are displayed on the console/terminal (if it exists and is able to display them). Unlike the byte file STD_OUT STD_CONSOLE accepts also Unicode characters. Unicode characters are written with the encoding of the operating system. If the standard output file of the operating system has been redirected UTF-8 encoded characters are written to the redirected file.


Function Detail

open

const func console_file: open (CONSOLE)

Creates a console_file at the upper left corner of the console/window. The console_file extends over the whole text console/window.

Returns:
the file opened.

flush

const proc: flush (in console_file: aFile)

Forces that all buffered data of aFile is sent to its destination. This causes data to be sent to the text console/window of the OS.


height

const func integer: height (in console_file: aConsoleFile)

Get the height of 'aConsoleFile'.

Returns:
the height of 'aConsoleFile'.

width

const func integer: width (in console_file: aConsoleFile)

Get the width of 'aConsoleFile'.

Returns:
the width of 'aConsoleFile'.

setPos

const proc: setPos (in console_file: aConsoleFile, in integer: line, in integer: column)

Set the current position of 'aConsoleFile' to 'line' and 'column'.


column

const func integer: column (in console_file: aConsoleFile)

Get the cursor column of 'aConsoleFile'.

Returns:
the cursor column of 'aConsoleFile'.

line

const func integer: line (in console_file: aConsoleFile)

Get the cursor line of 'aConsoleFile'.

Returns:
the cursor line of 'aConsoleFile'.

clear

const proc: clear (in console_file: aConsoleFile, in integer: upper, in integer: left, in integer: lower, in integer: right)

Clear an area of aConsoleFile with space characters. The area is specified in (line, column) coordinates and is between the (upper, left) and (lower, right).


clear

const proc: clear (in console_file: aConsoleFile)

Clear 'aConsoleFile' with space characters.


write

const proc: write (in console_file: aConsoleFile, in string: stri)

Write a string to the current position of 'aConsoleFile'. Unicode characters are written with the encoding of the operating system. The cursor position is changed, if one of the characters '\n', '\r' and '\b' is written. If the standard output file of the operating system has been redirected UTF-8 encoded characters are written to the redirected file.



 previous   up   next