EHS
ehs::Console Class Reference

#include <Console.h>

Static Public Member Functions

static void Attach ()
 
static bool Create ()
 
static void Free ()
 Frees the current console being used. More...
 
static bool CanRead ()
 
static bool CanWrite ()
 
static void Write_32 (const Str_32 &str, const bool newLine=true)
 
static void Write_16 (const Str_16 &str, const bool newLine=true)
 
static void Write_8 (const Str_8 &str, const bool newLine=true)
 
static Str_32 Read_32 (const UInt_64 bufferSize=1024)
 
static Str_16 Read_16 (const UInt_64 bufferSize=1024)
 
static Str_8 Read_8 (const UInt_64 bufferSize=1024)
 
static void Clear ()
 Clears the console. More...
 
static void SetTitle_32 (const Str_32 &title)
 
static void SetTitle_16 (const Str_16 &title)
 
static void SetTitle_8 (const Str_8 &title)
 
static Str_32 GetTitle_32 ()
 
static Str_16 GetTitle_16 ()
 
static Str_8 GetTitle_8 ()
 
static Vector< Str_32GetArgs_32 (const UInt_64 bufferSize=1024)
 
static Vector< Str_16GetArgs_16 (const UInt_64 bufferSize=1024)
 
static Vector< Str_8GetArgs_8 (const UInt_64 bufferSize=1024)
 

Member Function Documentation

◆ Attach()

void ehs::Console::Attach ( )
static

◆ CanRead()

bool ehs::Console::CanRead ( )
static

◆ CanWrite()

bool ehs::Console::CanWrite ( )
static

◆ Clear()

void ehs::Console::Clear ( )
static

Clears the console.

◆ Create()

bool ehs::Console::Create ( )
static

Creates a console using standard input and output.

Parameters
[in]inputRequiredWhether or not input is required from the console.

◆ Free()

void ehs::Console::Free ( )
static

Frees the current console being used.

◆ GetArgs_16()

Vector< Str_16 > ehs::Console::GetArgs_16 ( const UInt_64  bufferSize = 1024)
static

Retrieves the string used when executing the end application through a command line interface in UTF16.

Returns
The result.

◆ GetArgs_32()

Vector< Str_32 > ehs::Console::GetArgs_32 ( const UInt_64  bufferSize = 1024)
static

Retrieves the string used when executing the end application through a command line interface in UTF32.

Returns
The result.

◆ GetArgs_8()

Vector< Str_8 > ehs::Console::GetArgs_8 ( const UInt_64  bufferSize = 1024)
static

Retrieves the string used when executing the end application through a command line interface in UTF8.

Returns
The result.

◆ GetTitle_16()

Str_16 ehs::Console::GetTitle_16 ( )
static

Retrieves the console's title in UTF16.

Returns
The console's title.

◆ GetTitle_32()

Str_32 ehs::Console::GetTitle_32 ( )
static

Retrieves the console's title in UTF32.

Returns
The console's title.
Warning
Has to convert from UTF16 to UTF32 for the Windows API.

◆ GetTitle_8()

Str_8 ehs::Console::GetTitle_8 ( )
static

Retrieves the console's title in UTF8.

Returns
The console's title.
Warning
Has to convert from UTF16 to UTF8 for the Windows API.

◆ Read_16()

Str_16 ehs::Console::Read_16 ( const UInt_64  bufferSize = 1024)
static

Reads from the console using UTF16.

Returns
The text the user wrote to the console.

◆ Read_32()

Str_32 ehs::Console::Read_32 ( const UInt_64  bufferSize = 1024)
static

Reads from the console using UTF32.

Returns
The text the user wrote to the console.
Warning
Has to convert from UTF16 to UTF32 for the Windows API.

◆ Read_8()

Str_8 ehs::Console::Read_8 ( const UInt_64  bufferSize = 1024)
static

Reads from the console using UTF8.

Returns
The text the user wrote to the console.
Warning
Has to convert from UTF8 to UTF16 for the Windows API.

◆ SetTitle_16()

void ehs::Console::SetTitle_16 ( const Str_16 title)
static

Changes the console's title.

Parameters
[in]titleThe text to change the title to.

◆ SetTitle_32()

void ehs::Console::SetTitle_32 ( const Str_32 title)
static

Changes the console's title.

Parameters
[in]titleThe text to change the title to.
Warning
Has to convert from UTF32 to UTF16 for the Windows API.

◆ SetTitle_8()

void ehs::Console::SetTitle_8 ( const Str_8 title)
static

Changes the console's title.

Parameters
[in]titleThe text to change the title to.
Warning
Has to convert from UTF8 to UTF16 for the Windows API.

◆ Write_16()

void ehs::Console::Write_16 ( const Str_16 str,
const bool  newLine = true 
)
static

Writes to console using UTF16.

Parameters
[in]strThe text to write to the console.
[in]newLineTo make a new line after the given text.

◆ Write_32()

void ehs::Console::Write_32 ( const Str_32 str,
const bool  newLine = true 
)
static

Writes to console using UTF32.

Parameters
[in]strThe text to write to the console.
[in]newLineTo make a new line after the given text.
Warning
Has to convert from UTF32 to UTF16 for the Windows API.

◆ Write_8()

void ehs::Console::Write_8 ( const Str_8 str,
const bool  newLine = true 
)
static

Writes to console using UTF8.

Parameters
[in]strThe text to write to the console.
[in]newLineTo make a new line after the given text.
Warning
Has to convert from UTF8 to UTF16 for the Windows API.

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