PLCore::ConsoleWindows Class Reference

Windows 'Console' implementation. More...

#include <ConsoleWindows.h>

Inheritance diagram for PLCore::ConsoleWindows:

List of all members.

Public Member Functions
virtual void	Print (const String &sString) const override
	Print a string to the console.
virtual int	IsKeyHit () const override
	Checks whether or not there's some keyboard input waiting on the console ('_kbhit()')
virtual int	GetCharacter (bool bEcho=false) const override
	Reads a single character from the console ('_getch()')
virtual void	ClearScreen () const override
	Clears the console screen ('clrscr()')
virtual void	GetCursorPosition (uint16 &nX, uint16 &nY) const override
	Gets the absolute console cursor position ('wherex()' and 'wherey()')
virtual void	SetCursorPosition (uint16 nX, uint16 nY) const override
	Sets the absolute console cursor position ('gotoxy()')

---

Detailed Description

Windows 'Console' implementation.

---

Member Function Documentation

virtual void PLCore::ConsoleWindows::Print

(

const String &

sString

)

const [override, virtual]

Print a string to the console.

Parameters:

[in]

sString

String that shall be printed

Implements PLCore::Console.

virtual int PLCore::ConsoleWindows::IsKeyHit

(

)

const [override, virtual]

Checks whether or not there's some keyboard input waiting on the console ('_kbhit()')

Returns:

0 if no key has been pressed, else not null

Implements PLCore::Console.

virtual int PLCore::ConsoleWindows::GetCharacter

(

bool

bEcho = false

)

const [override, virtual]

Reads a single character from the console ('_getch()')

Parameters:

[in]

bEcho

Echo on the console?

Returns:

The read character - note that there's no error code

Implements PLCore::Console.

virtual void PLCore::ConsoleWindows::ClearScreen

(

)

const [override, virtual]

Clears the console screen ('clrscr()')

Implements PLCore::Console.

virtual void PLCore::ConsoleWindows::GetCursorPosition	(	uint16 &	nX,
		uint16 &	nY
	)		const [override, virtual]

Gets the absolute console cursor position ('wherex()' and 'wherey()')

Parameters:

[out]	nX	Receives the absolute x position of the console cursor, (0,0)=(left,top)
[out]	nY	Receives the absolute y position of the console cursor, (0,0)=(left,top)

Implements PLCore::Console.

virtual void PLCore::ConsoleWindows::SetCursorPosition	(	uint16	nX,
		uint16	nY
	)		const [override, virtual]

Sets the absolute console cursor position ('gotoxy()')

Parameters:

[in]	nX	New x absolute position of the console cursor, (0,0)=(left,top)
[in]	nY	New y absolute position of the console cursor, (0,0)=(left,top)

Implements PLCore::Console.

---

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

• ConsoleWindows.h