Console

console I/O support

static if(BACKEND_CONSOLE)

class Console {

int width [@property getter];

int height [@property getter];

int cursorX [@property getter];

int cursorY [@property getter];

int cursorX [@property setter];

int cursorY [@property setter];

version(Windows)

HANDLE _hstdin;

version(Windows)

HANDLE _hstdout;

version(Windows)

version(Windows)

ushort COMMON_LVB_UNDERSCORE;

version(!Windows)

int READ_BUF_SIZE;

version(!Windows)

char[READ_BUF_SIZE] readBuf;

version(!Windows)

int readBufPos;

version(!Windows)

bool isSequenceCompleted();

version(!Windows)

string rawRead(int pollTimeout);

version(!Windows)

bool rawWrite(string s);

version(Windows)

DWORD savedStdinMode;

version(Windows)

DWORD savedStdoutMode;

import core.sys.posix.termios;;

import core.sys.posix.fcntl;;

import core.sys.posix.sys.ioctl;;

version(!Windows)

termios savedStdinState;

void uninit();

void resize(int width, int height);

void clearScreen();

void setCursor(int x, int y);

void flush();

void writeText(dstring str);

void rawSetCursor(int x, int y);

void setWindowCaption(dstring str);

void rawSetCursorType(ConsoleCursorType type);

void setCursorType(ConsoleCursorType type);

void rawWriteTextAt(int x, int y, uint attr, dstring str);

void rawWriteText(dstring str);

void rawSetAttributes(uint attr);

void checkResize();

void calcAttributes();

void updateAttributes();

bool _batchMode;

bool batchMode [@property getter];

bool batchMode [@property setter];

bool _dirtyAttributes;

ubyte _textColor;

ubyte _backgroundColor;

bool _underline;

bool underline [@property getter];

bool underline [@property setter];

ubyte textColor [@property getter];

ubyte textColor [@property setter];

ubyte backgroundColor [@property getter];

ubyte backgroundColor [@property setter];

Signal!OnMouseEvent mouseEvent;

Signal!OnKeyEvent keyEvent;

Signal!OnConsoleResize resizeEvent;

Signal!OnInputIdle inputIdleEvent;

bool handleKeyEvent(KeyEvent event);

bool handleMouseEvent(MouseEvent event);

bool handleConsoleResize(int width, int height);

bool handleInputIdle();

ButtonDetails _lbutton;

ButtonDetails _mbutton;

ButtonDetails _rbutton;

bool pollInput();

}

Members

Functions

calcAttributes void calcAttributes(): Undocumented in source. Be warned that the author may not have intended to support it.
checkResize void checkResize(): Undocumented in source. Be warned that the author may not have intended to support it.
clearScreen void clearScreen(): clear screen and set cursor position to 0,0
flush void flush(): flush batched updates
handleConsoleResize bool handleConsoleResize(int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
handleInputIdle bool handleInputIdle(): Undocumented in source. Be warned that the author may not have intended to support it.
handleKeyEvent bool handleKeyEvent(KeyEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
handleMouseEvent bool handleMouseEvent(MouseEvent event): Undocumented in source. Be warned that the author may not have intended to support it.
init bool init(): Undocumented in source. Be warned that the author may not have intended to support it.
isSequenceCompleted bool isSequenceCompleted(): Undocumented in source. Be warned that the author may not have intended to support it.
pollInput bool pollInput(): wait for input, handle input
rawRead string rawRead(int pollTimeout): Undocumented in source. Be warned that the author may not have intended to support it.
rawSetAttributes void rawSetAttributes(uint attr): Undocumented in source. Be warned that the author may not have intended to support it.
rawSetCursor void rawSetCursor(int x, int y): Undocumented in source. Be warned that the author may not have intended to support it.
rawSetCursorType void rawSetCursorType(ConsoleCursorType type): Undocumented in source. Be warned that the author may not have intended to support it.
rawWrite bool rawWrite(string s): Undocumented in source. Be warned that the author may not have intended to support it.
rawWriteText void rawWriteText(dstring str): Undocumented in source. Be warned that the author may not have intended to support it.
rawWriteTextAt void rawWriteTextAt(int x, int y, uint attr, dstring str): Undocumented in source. Be warned that the author may not have intended to support it.
resize void resize(int width, int height): Undocumented in source. Be warned that the author may not have intended to support it.
setCursor void setCursor(int x, int y): set cursor position
setCursorType void setCursorType(ConsoleCursorType type): Undocumented in source. Be warned that the author may not have intended to support it.
setWindowCaption void setWindowCaption(dstring str): Undocumented in source. Be warned that the author may not have intended to support it.
uninit void uninit(): Undocumented in source. Be warned that the author may not have intended to support it.
updateAttributes void updateAttributes(): Undocumented in source. Be warned that the author may not have intended to support it.
writeText void writeText(dstring str): write text string

Properties

backgroundColor ubyte backgroundColor [@property getter]: get background color
backgroundColor ubyte backgroundColor [@property setter]: set background color
batchMode bool batchMode [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
batchMode bool batchMode [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
cursorX int cursorX [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
cursorX int cursorX [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
cursorY int cursorY [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
cursorY int cursorY [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.
height int height [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
textColor ubyte textColor [@property getter]: get text color
textColor ubyte textColor [@property setter]: set text color
underline bool underline [@property getter]: get underline text attribute flag
underline bool underline [@property setter]: set underline text attrubute flag
width int width [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Variables

COMMON_LVB_UNDERSCORE ushort COMMON_LVB_UNDERSCORE;: Undocumented in source.
READ_BUF_SIZE int READ_BUF_SIZE;: Undocumented in source.
_attr WORD _attr;: Undocumented in source.
_backgroundColor ubyte _backgroundColor;: Undocumented in source.
_batchMode bool _batchMode;: Undocumented in source.
_dirtyAttributes bool _dirtyAttributes;: Undocumented in source.
_hstdin HANDLE _hstdin;: Undocumented in source.
_hstdout HANDLE _hstdout;: Undocumented in source.
_lbutton ButtonDetails _lbutton;: Undocumented in source.
_mbutton ButtonDetails _mbutton;: Undocumented in source.
_rbutton ButtonDetails _rbutton;: Undocumented in source.
_textColor ubyte _textColor;: Undocumented in source.
_underline bool _underline;: Undocumented in source.
inputIdleEvent Signal!OnInputIdle inputIdleEvent;: console input is idle
keyEvent Signal!OnKeyEvent keyEvent;: keyboard event signal
mouseEvent Signal!OnMouseEvent mouseEvent;: mouse event signal
readBuf char[READ_BUF_SIZE] readBuf;: Undocumented in source.
readBufPos int readBufPos;: Undocumented in source.
resizeEvent Signal!OnConsoleResize resizeEvent;: console size changed signal
savedStdinMode DWORD savedStdinMode;: Undocumented in source.
savedStdinState termios savedStdinState;: Undocumented in source.
savedStdoutMode DWORD savedStdoutMode;: Undocumented in source.

Meta

Source

See Implementation

dlangui platforms console dconsole classes

Console

enums

functions

interfaces

static variables

SIGHUP_flag

structs

variables