xtd::console Class Reference

Definition

Represents the standard input, output, and error streams for console applications.

Header

#include <xtd/console> 

Namespace

xtd

Library

xtd.core

Examples

The following example demonstrates how to read data from, and write data to, the standard input and output streams. Note that these streams can be redirected by using the set_in and set_out methods.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  console::write("Hello ");
  console::write_line("World!");
  console::write("Enter your name: ");
  ustring name = console::read_line();
  console::write("Good day, ");
  console::write(name);
  console::write_line("!");
}

// This code produces the following output:
//
// Hello World!
// Enter your name: James
// Good day, James!

#include <xtd/console>

using namespace std;
using namespace xtd;

auto main()->int {
  auto& is = console::in;
  auto& os = console::out;
  
  os << "Ola Mundo!" << endl;
  os << "What is your name: ";
  auto name = ustring::empty_string;
  is >> name;
  
  os << "Buenos Dias, " << name << endl;
}

// This code produces the following output:
//
// Ola Mundo!
// What is your name: James
// Buenos Dias, James!

Fields
static std::ostream	error
	Gets the error output stream. A std::basic_ostream<char_t> that represents the error output stream. More...
static std::istream	in
	Gets the standard input stream. A std::basic_istream<char_t> that represents the standard input stream. More...
static std::ostream	out
	Gets the standard output stream. A std::basic_ostream<char_t> that represents the standard output stream. More...

Properties
static bool	auto_flush_out ()
	Gets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line. More...
static void	auto_flush_out (bool value)
	Sets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line. More...
static console_color	background_color ()
	Gets the background color of the console. More...
static void	background_color (console_color color)
	Sets the background color of the console. More...
static int32	buffer_height ()
	Gets the height of the buffer area. More...
static void	buffer_height (int32 height)
	Sets or sets the height of the buffer area. More...
static int32	buffer_width ()
	Gets the width of the buffer area. More...
static void	buffer_width (int32 width)
	Sets the width of the buffer area. More...
static bool	caps_lock ()
	Gets a value indicating whether the CAPS LOCK keyboard toggle is turned on or turned off. More...
static int32	cursor_left ()
	Gets the column position of the cursor within the buffer area. More...
static void	cursor_left (int32 left)
	Sets the column position of the cursor within the buffer area. More...
static int32	cursor_size ()
	Gets or sets the height of the cursor within a character cell. More...
static void	cursor_size (int32 size)
	Sets the height of the cursor within a character cell. More...
static int32	cursor_top ()
	Gets the row position of the cursor within the buffer area. More...
static void	cursor_top (int32 top)
	Sets the row position of the cursor within the buffer area. More...
static bool	cursor_visible ()
	Gets a value indicating whether the cursor is visible. More...
static void	cursor_visible (bool visible)
	Sets a value indicating whether the cursor is visible. More...
static console_color	foreground_color ()
	Gets the foreground color of the console. More...
static bool	foreground_color (console_color color)
	Sets the foreground color of the console. More...
static int32	input_code_page ()
	Gets the code page the console uses to read input. More...
static bool	input_code_page (int32 code_page)
	Sets the code page the console uses to read input. More...
static bool	is_error_redirected ()
	Gets a value that indicates whether the error output stream has been redirected from the standard error stream. More...
static bool	is_input_redirected ()
	Gets a value that indicates whether the input stream has been redirected from the standard input stream. More...
static bool	is_output_redirected ()
	Gets a value that indicates whether the output stream has been redirected from the standard output stream. More...
static bool	key_available ()
	Gets a value indicating whether a key press is available in the input stream. More...
static int32	largest_window_height ()
	Gets the largest possible number of console window rows, based on the current font and screen resolution. More...
static int32	largest_window_width ()
	Gets the largest possible number of console window columns, based on the current font and screen resolution. More...
static bool	number_lock ()
	Gets a value indicating whether the NUM LOCK keyboard toggle is turned on or turned off. More...
static int32	output_code_page ()
	Gets the code page the console uses to write output. More...
static bool	output_code_page (int32 code_page)
	Sets the code page the console uses to write output. More...
static xtd::ustring	title ()
	Gets the title to display in the console title bar. More...
static void	title (const xtd::ustring &title)
	Sets the title to display in the console title bar. More...
static bool	treat_control_c_as_input ()
	Gets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system. More...
static void	treat_control_c_as_input (bool treat_control_c_as_input)
	Sets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system. More...
static int32	window_height ()
	Gets the height of the console window area. More...
static void	window_height (int32 height)
	Sets the height of the console window area. More...
static int32	window_left ()
	Gets the left of the console window area. More...
static void	window_left (int32 left)
	Sets the left of the console window area. More...
static int32	window_top ()
	Gets the top of the console window area. More...
static void	window_top (int32 top)
	Sets the top of the console window area. More...
static int32	window_width ()
	Gets the width of the console window area. More...
static void	window_width (int32 width)
	Sets the width of the console window area. More...

Events
static event< console, console_cancel_event_handler >	cancel_key_press
	Occurs when the Control modifier key (Ctrl) and either the ConsoleKey.C console key (C) or the Break key are pressed simultaneously (Ctrl+C or Ctrl+Break). More...

Methods
static void	beep ()
	Plays the sound of a beep through the console speaker. More...
static void	beep (uint32 frequency, uint32 duration)
	Plays the sound of a beep of a specified frequency and duration through the console speaker. More...
static void	clear ()
	Clears the console buffer and corresponding console window of display information. More...
static std::pair< int32, int32 >	get_cursor_position ()
	Gets the position of the cursor. More...
static std::ostream	open_standard_error ()
	Acquires the standard error stream. More...
static std::istream	open_standard_input ()
	Acquires the standard input stream. More...
static std::ostream	open_standard_output ()
	Acquires the standard output stream. More...
static int32	read ()
	Reads the next character from the standard input stream. More...
static console_key_info	read_key ()
	Obtains the next character or function key pressed by the user. The pressed key is displayed in the console window. More...
static console_key_info	read_key (bool intercept)
	Obtains the next character or function key pressed by the user. The pressed key is optionally displayed in the console window. More...
static xtd::ustring	read_line ()
	Reads the next line of characters from the standard input stream. More...
static xtd::ustring	read_line (bool intercept)
	Reads the next line of characters from the standard input stream. More...
static bool	reset_color ()
	Sets the foreground and background console colors to their defaults. More...
static void	set_cursor_position (int32 left, int32 top)
	Sets the position of the cursor. More...
static void	set_error (const std::ostream &os)
	Sets the error property to the specified std::ostream object. More...
static void	set_in (const std::istream &is)
	Sets the int property to the specified std::istream object. More...
static void	set_out (const std::ostream &os)
	Sets the out property to the specified std::ostream object. More...
static void	set_window_position (int32 left, int32 top)
	Sets the position of the console window relative to the screen buffer. More...
static void	set_window_size (int32 width, int32 height)
	Sets the height and width of the console window to the specified values. More...
template<typename arg_t >
static void	write (arg_t &&value)
	Writes the text representation of the specified value to the standard output stream. More...
template<typename ... args_t>
static void	write (const xtd::ustring &fmt, args_t &&... values)
	Writes the text representation of the specified list of values to the standard output stream using the specified format information. More...
static void	write_line ()
	Writes the current line terminator to the standard output stream using the specified format information. More...
template<typename arg_t >
static void	write_line (arg_t &&value)
	Writes the text representation of the specified value, followed by the current line terminator, to the standard output stream. More...
template<typename ... args_t>
static void	write_line (const xtd::ustring &fmt, args_t &&... values)
	Writes the text representation of the specified list of values, followed by the current line terminator, to the standard output stream using the specified format information. More...

Member Function Documentation

auto_flush_out() [1/2]

static bool xtd::console::auto_flush_out ( )

static

Gets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line.

Returns

true to force xtd::console::out to flush its buffer; otherwise, false. The default value is true.

auto_flush_out() [2/2]

static void xtd::console::auto_flush_out ( bool  value )

static

Sets a value indicating whether the xtd::console::out will flush its buffer to the underlying stream after every call to xtd::console::write and xtd::console::write_line.

Parameters

value

true to force xtd::console::out to flush its buffer; otherwise, false. The default value is true.

background_color() [1/2]

static console_color xtd::console::background_color ( )

static

Gets the background color of the console.

Returns

the background xtd::console_color.

Remarks

A get operation for a Windows-based application, in which a console does not exist, returns xtd::console_color::black.

Examples

The following example saves the values of the xtd::console_color enumeration to an array and stores the current values of the xtd::console::background_color and xtd::console::foreground_color properties to variables. It then changes the foreground color to each color in the xtd::console_color enumeration except to the color that matches the current background, and it changes the background color to each color in the xtd::console_color enumeration except to the color that matches the current foreground. (If the foreground color is the same as the background color, the text isn't visible.) Finally, it calls the xtd::console::reset_color method to restore the original console colors.

#include <xtd/console>

using namespace std;
using namespace xtd;

auto main()->int {
  const auto logo = vector {
    u8"████████████████████████████████████████████████████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████",
    u8"███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████",
    u8"██████████████████████████      ▀████       ▀█████████████████████████",
    u8"███████████             ▐         ▀▀         ▐              ██████████",
    u8"█████████               ▐   ███   ▌▐   ███   ▐               █████████",
    u8"█████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████",
    u8"█████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████",
    u8"█████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████",
    u8"█████████                                                    █████████",
    u8"█████████                 █▄                ▌                █████████",
    u8"█████████                  ▌▀▀▄          ▄██                 █████████",
    u8"█████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████",
    u8"█████████                   ▐            ▄█                  █████████",
    u8"█████████                    █          ▄█                   █████████",
    u8"█████████                     ▀▄       █▀                    █████████",
    u8"█████████                       ▀▄▄▄▄██▀                     █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"██████████████████████████████████████████████████████████████████",
  };
  
  console::output_code_page(65001);
  
  for (auto index = 0ul; index < logo.size(); ++index) {
    console::write(index == 0 || index == logo.size() - 1 ? "       " : "     ");
    console::background_color(console_color::white);
    console::foreground_color(console_color::dark_blue);
    console::write(logo[index]);
    console::reset_color();
    console::write_line();
  }
  
  console::foreground_color(console_color::dark_blue);
  console::write_line(u8"                                    Gammasoft                                   ");
  console::foreground_color(console_color::dark_gray);
  console::write_line(u8" More than thirty years of passion for high technology especially in development");
  console::write_line(u8" (c++, c#, objective-c, ...).");
  console::reset_color();
}

// This code produces the following output with colors:
//
//        ████████████████████████████████████████████████████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████
//      ███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████
//      ██████████████████████████      ▀████       ▀█████████████████████████
//      ███████████             ▐         ▀▀         ▐              ██████████
//      █████████               ▐   ███   ▌▐   ███   ▐               █████████
//      █████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████
//      █████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████
//      █████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████
//      █████████                                                    █████████
//      █████████                 █▄                ▌                █████████
//      █████████                  ▌▀▀▄          ▄██                 █████████
//      █████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████
//      █████████                   ▐            ▄█                  █████████
//      █████████                    █          ▄█                   █████████
//      █████████                     ▀▄       █▀                    █████████
//      █████████                       ▀▄▄▄▄██▀                     █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//        ██████████████████████████████████████████████████████████████████
//                                    Gammasoft
// More than thirty years of passion for high technology especially in development
// (c++, c#, objective-c, ...).

Examples:

console_background_color.cpp, console_color.cpp, console_info.cpp, and hello_world_console.cpp.

background_color() [2/2]

static void xtd::console::background_color ( console_color  color )

static

Sets the background color of the console.

Parameters

color

A xtd::console_color that specifies the background color of the console; that is, the color that appears behind each character.

Exceptions

xtd::argument_exception

The color specified in a set operation is not a valid member of xtd::console_color.

Remarks

A change to the background_color method affects only output that is written to individual character cells after the background color is changed. To change the background color of the console window as a whole, set the BackgroundColor property and call the Clear method. The following example provides an illustration.

Examples

The following example saves the values of the xtd::console_color enumeration to an array and stores the current values of the xtd::console::background_color and xtd::console::foreground_color properties to variables. It then changes the foreground color to each color in the xtd::console_color enumeration except to the color that matches the current background, and it changes the background color to each color in the xtd::console_color enumeration except to the color that matches the current foreground. (If the foreground color is the same as the background color, the text isn't visible.) Finally, it calls the xtd::console::reset_color method to restore the original console colors.

#include <xtd/console>

using namespace std;
using namespace xtd;

auto main()->int {
  const auto logo = vector {
    u8"████████████████████████████████████████████████████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████",
    u8"███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████",
    u8"██████████████████████████      ▀████       ▀█████████████████████████",
    u8"███████████             ▐         ▀▀         ▐              ██████████",
    u8"█████████               ▐   ███   ▌▐   ███   ▐               █████████",
    u8"█████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████",
    u8"█████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████",
    u8"█████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████",
    u8"█████████                                                    █████████",
    u8"█████████                 █▄                ▌                █████████",
    u8"█████████                  ▌▀▀▄          ▄██                 █████████",
    u8"█████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████",
    u8"█████████                   ▐            ▄█                  █████████",
    u8"█████████                    █          ▄█                   █████████",
    u8"█████████                     ▀▄       █▀                    █████████",
    u8"█████████                       ▀▄▄▄▄██▀                     █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"██████████████████████████████████████████████████████████████████",
  };
  
  console::output_code_page(65001);
  
  for (auto index = 0ul; index < logo.size(); ++index) {
    console::write(index == 0 || index == logo.size() - 1 ? "       " : "     ");
    console::background_color(console_color::white);
    console::foreground_color(console_color::dark_blue);
    console::write(logo[index]);
    console::reset_color();
    console::write_line();
  }
  
  console::foreground_color(console_color::dark_blue);
  console::write_line(u8"                                    Gammasoft                                   ");
  console::foreground_color(console_color::dark_gray);
  console::write_line(u8" More than thirty years of passion for high technology especially in development");
  console::write_line(u8" (c++, c#, objective-c, ...).");
  console::reset_color();
}

// This code produces the following output with colors:
//
//        ████████████████████████████████████████████████████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████
//      ███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████
//      ██████████████████████████      ▀████       ▀█████████████████████████
//      ███████████             ▐         ▀▀         ▐              ██████████
//      █████████               ▐   ███   ▌▐   ███   ▐               █████████
//      █████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████
//      █████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████
//      █████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████
//      █████████                                                    █████████
//      █████████                 █▄                ▌                █████████
//      █████████                  ▌▀▀▄          ▄██                 █████████
//      █████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████
//      █████████                   ▐            ▄█                  █████████
//      █████████                    █          ▄█                   █████████
//      █████████                     ▀▄       █▀                    █████████
//      █████████                       ▀▄▄▄▄██▀                     █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//        ██████████████████████████████████████████████████████████████████
//                                    Gammasoft
// More than thirty years of passion for high technology especially in development
// (c++, c#, objective-c, ...).

beep() [1/2]

static void xtd::console::beep ( )

static

Plays the sound of a beep through the console speaker.

Remarks

By default, the beep plays at a frequency of 800 hertz for a duration of 200 milliseconds

Examples

The following example demonstrates the beep method. The example accepts a number from 1 through 9 as a command line argument, and plays the beep that number of times.

#include <xtd/threading/thread>
#include <xtd/console>
#include <xtd/int32_object>

using namespace xtd;
using namespace xtd::threading;

auto main(int argc, char* argv[])->int {
  auto x = 0;
  //
  if ((argc == 2) && (int32_object::try_parse(argv[1], x) == true) && ((x >= 1) && (x <= 9))) {
    for (auto i = 1; i <= x; ++i) {
      console::write_line("Beep number {}.", i);
      console::beep();
      thread::sleep(100_ms);
    }
  } else
    console::write_line("Usage: Enter the number of times (between 1 and 9) to beep.");
}

// This code produces the following output if 3 is entered on command line:
//
// Beep number 1.
// Beep number 2.
// Beep number 3.

Examples:

console_beep.cpp.

beep() [2/2]

static void xtd::console::beep ( uint32  frequency, uint32  duration  )

static

Plays the sound of a beep of a specified frequency and duration through the console speaker.

Parameters

frequency	The frequency of the beep, ranging from 37 to 32767 hertz
duration	The duration of the beep measured in milliseconds

Examples

This example demonstrates the beep method by playing the first few notes of a song through the console speaker.

#include <xtd/threading/thread>
#include <xtd/as>
#include <xtd/console>

using namespace std;
using namespace xtd;

// Define the frequencies of notes in an octave, as well as
// silence (rest).
enum class tone {
  rest = 0,
  g_below_c = 196,
  a = 220,
  a_sharp = 233,
  b = 247,
  c = 262,
  c_sharp = 277,
  d = 294,
  d_sharp = 311,
  e = 330,
  f = 349,
  f_sharp = 370,
  g = 392,
  g_sharp = 415,
};

// Define the duration of a note in units of milliseconds.
enum class duration {
  none = 0,
  whole = 1600,
  half = whole / 2,
  quarter = half / 2,
  eighth = quarter / 2,
  sixteenth = eighth / 2,
};

// Define a note as a frequency (tone) and the amount of
// time (duration) the note plays.
struct note final {
private:
  tone tone_val = tone::rest;
  ::duration dur_val = ::duration::none;
  
public:
  // Define a constructor to create a specific note.
  note(tone frequency, ::duration time) : tone_val(frequency), dur_val(time) {}
  
  note() = default;
  note(const note& note) = default;
  note& operator=(const note& note) = default;
  
  // Define properties to return the note's tone and duration.
  tone note_tone() const noexcept {return tone_val;}
  duration note_duration() const noexcept {return dur_val;}
};

// Play the notes in a song.
void play(const vector<note>& tune) {
  for (auto n : tune) {
    if (n.note_tone() == tone::rest)
      threading::thread::sleep(as<int>(n.note_duration()));
    else
      console::beep(as<unsigned int>(n.note_tone()), as<unsigned int>(n.note_duration()));
  }
}

auto main()->int {
  // Declare the first few notes of the song, "Mary Had A Little Lamb".
  auto mary = vector {
    note(tone::b, ::duration::quarter),
    note(tone::a, ::duration::quarter),
    note(tone::g_below_c, ::duration::quarter),
    note(tone::a, ::duration::quarter),
    note(tone::b, ::duration::quarter),
    note(tone::b, ::duration::quarter),
    note(tone::b, ::duration::half),
    note(tone::a, ::duration::quarter),
    note(tone::a, ::duration::quarter),
    note(tone::a, ::duration::half),
    note(tone::b, ::duration::quarter),
    note(tone::d, ::duration::quarter),
    note(tone::d, ::duration::half)
  };
  // Play the song
  play(mary);
}

buffer_height() [1/2]

static int32 xtd::console::buffer_height ( )

static

Gets the height of the buffer area.

Returns

The current height, in rows, of the buffer area.

Examples

This example demonstrates the buffer_height and buffer_width properties. The example reports the dimensions of an operating system window set to a buffer size of 300 rows and 85 columns.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  console::write_line("The current buffer height is {} rows.", console::buffer_height());
  console::write_line("The current buffer width is {} columns.", console::buffer_width());
}

// This code produces the following output:
//
// The current buffer height is 300 rows.
// The current buffer width is 85 columns.

Examples:

console_buffer.cpp, and console_info.cpp.

buffer_height() [2/2]

static void xtd::console::buffer_height ( int32  height )

static

Sets or sets the height of the buffer area.

Parameters

height

The current height, in rows, of the buffer area.

Exceptions

xtd::argument_out_of_range_exception

The value in a set operation is less than or equal to zero. -or- The value in a set operation is greater than or equal to xtd::int16_object::max_value.

Examples

This example demonstrates the buffer_height and buffer_width properties. The example reports the dimensions of an operating system window set to a buffer size of 300 rows and 85 columns.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  console::write_line("The current buffer height is {} rows.", console::buffer_height());
  console::write_line("The current buffer width is {} columns.", console::buffer_width());
}

// This code produces the following output:
//
// The current buffer height is 300 rows.
// The current buffer width is 85 columns.

buffer_width() [1/2]

static int32 xtd::console::buffer_width ( )

static

Gets the width of the buffer area.

Returns

The current width, in columns, of the buffer area.

Examples

This example demonstrates the BufferHeight and buffer_width properties. The example reports the dimensions of an operating system window set to a buffer size of 300 rows and 85 columns.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  console::write_line("The current buffer height is {} rows.", console::buffer_height());
  console::write_line("The current buffer width is {} columns.", console::buffer_width());
}

// This code produces the following output:
//
// The current buffer height is 300 rows.
// The current buffer width is 85 columns.

Examples:

console_buffer.cpp, and console_info.cpp.

buffer_width() [2/2]

static void xtd::console::buffer_width ( int32  width )

static

Sets the width of the buffer area.

Parameters

width

The current width, in columns, of the buffer area.

Exceptions

xtd::argument_out_of_range_exception

The value in a set operation is less than or equal to zero. -or- The value in a set operation is greater than or equal to xtd::int16_object::max_value.

Examples

This example demonstrates the BufferHeight and buffer_width properties. The example reports the dimensions of an operating system window set to a buffer size of 300 rows and 85 columns.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  console::write_line("The current buffer height is {} rows.", console::buffer_height());
  console::write_line("The current buffer width is {} columns.", console::buffer_width());
}

// This code produces the following output:
//
// The current buffer height is 300 rows.
// The current buffer width is 85 columns.

caps_lock()

static bool xtd::console::caps_lock ( )

static

Gets a value indicating whether the CAPS LOCK keyboard toggle is turned on or turned off.

Returns

true if CAPS LOCK is turned on; false if CAPS LOCK is turned off.

Examples:

console_info.cpp.

clear()

static void xtd::console::clear ( )

static

Clears the console buffer and corresponding console window of display information.

Remarks

Using the clear method is equivalent invoking the MS-DOS cls command in the command prompt window.

When the Clear method is called, the cursor automatically scrolls to the top-left corner of the window and the contents of the screen buffer are set to blanks using the current foreground background colors.

Examples

The following example uses the clear method to clear the console before it executes a loop, prompts the user to select a foreground and background color and to enter a string to display. If the user chooses not to exit the program, the console's original foreground and background colors are restored and the Clear method is called again before re-executing the loop.

#include <xtd/char32_object>
#include <xtd/console>
#include <xtd/startup>

using namespace std;
using namespace xtd;

namespace console_clear_example {
  class program {
  public:
    // The main entry point for the application.
    static auto main(const vector<ustring>& args) {
      // Save colors so they can be restored when use finishes input.
      auto dft_fore_color = console::foreground_color();
      auto dft_back_color = console::background_color();
      auto continue_flag = true;
      console::clear();
      
      do {
        auto new_fore_color = console_color::white;
        auto new_back_color = console_color::black;
        
        auto fore_color_selection = get_key_press("Select Text Color (B for Blue, R for Red, Y for Yellow): ", vector<char32_t> { 'B', 'R', 'Y' });
        switch (fore_color_selection) {
          case 'B':
          case 'b': new_fore_color = console_color::dark_blue; break;
          case 'R':
          case 'r': new_fore_color = console_color::dark_red; break;
          case 'Y':
          case 'y': new_fore_color = console_color::dark_yellow; break;
        }
        
        auto back_color_selection = get_key_press("Select Background Color (W for White, G for Green, M for Magenta): ", vector<char32_t> { 'W', 'G', 'M' });
        switch (back_color_selection) {
          case 'W':
          case 'w': new_back_color = console_color::white; break;
          case 'G':
          case 'g': new_back_color = console_color::green; break;
          case 'M':
          case 'm': new_back_color = console_color::magenta; break;
        }
        
        console::write_line();
        console::write("Enter a message to display: ");
        ustring text_to_display = console::read_line();
        console::write_line();
        console::foreground_color(new_fore_color);
        console::background_color(new_back_color);
        console::write_line(text_to_display);
        console::write_line();
        if (char32_object::to_upper(get_key_press("Display another message (Y/N): ", vector<char32_t> { 'Y', 'N' })) == 'N')
          continue_flag = false;
          
        // Restore the default settings and clear the screen.
        console::foreground_color(dft_fore_color);
        console::background_color(dft_back_color);
        console::clear();
      } while (continue_flag);
    }
    
  private:
    static char32_t get_key_press(const ustring& msg, const vector<char32_t>& valid_chars) {
      auto key_pressed = console_key_info {};
      auto valid = false;
      
      console::write_line();
      do {
        console::write(msg);
        key_pressed = console::read_key();
        console::write_line();
        if (find(valid_chars.begin(), valid_chars.end(), char32_object::to_upper(key_pressed.key_char())) != valid_chars.end())
          valid = true;
          
      } while (!valid);
      return key_pressed.key_char();
    }
  };
}

startup_(console_clear_example::program::main);

The example relies on a get_key_press method to validate the user's selection of a foreground and background color.

Examples

This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings.

#include <xtd/console>

using namespace xtd;

auto orig_row = 0;
auto orig_col = 0;

void write_at(const ustring& s, int x, int y) {
  console::set_cursor_position(orig_col + x, orig_row + y);
  console::write(s);
}

auto main()->int {
  // Clear the screen, then save the top and left coordinates.
  console::clear();
  orig_row = console::cursor_top();
  orig_col = console::cursor_left();
  
  // Draw the left side of a 5x5 rectangle, from top to bottom.
  write_at("+", 0, 0);
  write_at("|", 0, 1);
  write_at("|", 0, 2);
  write_at("|", 0, 3);
  write_at("+", 0, 4);
  
  // Draw the bottom side, from left to right.
  write_at("-", 1, 4); // shortcut: write_at("---", 1, 4)
  write_at("-", 2, 4); // ...
  write_at("-", 3, 4); // ...
  write_at("+", 4, 4);
  
  // Draw the right side, from bottom to top.
  write_at("|", 4, 3);
  write_at("|", 4, 2);
  write_at("|", 4, 1);
  write_at("+", 4, 0);
  
  // Draw the top side, from right to left.
  write_at("-", 3, 0); // shortcut: write_at("---", 1, 0)
  write_at("-", 2, 0); // ...
  write_at("-", 1, 0); // ...
  //
  write_at("All done!", 0, 6);
  console::write_line();
}

// This code produces the following output:
//
// +---+
// |   |
// |   |
// |   |
// +---+
//
// All done!

Examples:

console_cursor.cpp, and environment_cancel_signal.cpp.

cursor_left() [1/2]

static int32 xtd::console::cursor_left ( )

static

Gets the column position of the cursor within the buffer area.

Returns

The current position, in columns, of the cursor.

Examples

This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings.

#include <xtd/console>

using namespace xtd;

auto orig_row = 0;
auto orig_col = 0;

void write_at(const ustring& s, int x, int y) {
  console::set_cursor_position(orig_col + x, orig_row + y);
  console::write(s);
}

auto main()->int {
  // Clear the screen, then save the top and left coordinates.
  console::clear();
  orig_row = console::cursor_top();
  orig_col = console::cursor_left();
  
  // Draw the left side of a 5x5 rectangle, from top to bottom.
  write_at("+", 0, 0);
  write_at("|", 0, 1);
  write_at("|", 0, 2);
  write_at("|", 0, 3);
  write_at("+", 0, 4);
  
  // Draw the bottom side, from left to right.
  write_at("-", 1, 4); // shortcut: write_at("---", 1, 4)
  write_at("-", 2, 4); // ...
  write_at("-", 3, 4); // ...
  write_at("+", 4, 4);
  
  // Draw the right side, from bottom to top.
  write_at("|", 4, 3);
  write_at("|", 4, 2);
  write_at("|", 4, 1);
  write_at("+", 4, 0);
  
  // Draw the top side, from right to left.
  write_at("-", 3, 0); // shortcut: write_at("---", 1, 0)
  write_at("-", 2, 0); // ...
  write_at("-", 1, 0); // ...
  //
  write_at("All done!", 0, 6);
  console::write_line();
}

// This code produces the following output:
//
// +---+
// |   |
// |   |
// |   |
// +---+
//
// All done!

Examples:

console_cursor.cpp, and console_info.cpp.

cursor_left() [2/2]

static void xtd::console::cursor_left ( int32  left )

static

Sets the column position of the cursor within the buffer area.

Parameters

left	The current position, in columns, of the cursor.

Exceptions

xtd::argument_out_of_range_exception

The value in a set operation is less than zero -or- The value in a set operation is greater than or equal to xtd::console::buffer_width.

Examples

This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings.

#include <xtd/console>

using namespace xtd;

auto orig_row = 0;
auto orig_col = 0;

void write_at(const ustring& s, int x, int y) {
  console::set_cursor_position(orig_col + x, orig_row + y);
  console::write(s);
}

auto main()->int {
  // Clear the screen, then save the top and left coordinates.
  console::clear();
  orig_row = console::cursor_top();
  orig_col = console::cursor_left();
  
  // Draw the left side of a 5x5 rectangle, from top to bottom.
  write_at("+", 0, 0);
  write_at("|", 0, 1);
  write_at("|", 0, 2);
  write_at("|", 0, 3);
  write_at("+", 0, 4);
  
  // Draw the bottom side, from left to right.
  write_at("-", 1, 4); // shortcut: write_at("---", 1, 4)
  write_at("-", 2, 4); // ...
  write_at("-", 3, 4); // ...
  write_at("+", 4, 4);
  
  // Draw the right side, from bottom to top.
  write_at("|", 4, 3);
  write_at("|", 4, 2);
  write_at("|", 4, 1);
  write_at("+", 4, 0);
  
  // Draw the top side, from right to left.
  write_at("-", 3, 0); // shortcut: write_at("---", 1, 0)
  write_at("-", 2, 0); // ...
  write_at("-", 1, 0); // ...
  //
  write_at("All done!", 0, 6);
  console::write_line();
}

// This code produces the following output:
//
// +---+
// |   |
// |   |
// |   |
// +---+
//
// All done!

cursor_size() [1/2]

static int32 xtd::console::cursor_size ( )

static

Gets or sets the height of the cursor within a character cell.

Returns

The size of the cursor expressed as a percentage of the height of a character cell. The property value ranges from 1 to 100.

Examples

This example demonstrates the cursor_size property. The example increases the size of the cursor each time any console key is pressed, then restores the cursor to its original size before terminating.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  auto m0 = "This example increments the cursor size from 1% to 100%:\n";
  auto m1 = "Cursor size = {0}%. (Press any key to continue...)";
  auto sizes = { 1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 };

  auto save_cursor_size = console::cursor_size();
  console::write_line(m0);
  for (auto size : sizes) {
    console::cursor_size(size);
    console::write_line(m1, size);
    console::read_key();
  }
  console::cursor_size(save_cursor_size);
}

// This code produces the following output:
//
// This example increments the cursor size from 1% to 100%:
//
// Cursor size = 1%. (Press any key to continue...)
// Cursor size = 10%. (Press any key to continue...)
// Cursor size = 20%. (Press any key to continue...)
// Cursor size = 30%. (Press any key to continue...)
// Cursor size = 40%. (Press any key to continue...)
// Cursor size = 50%. (Press any key to continue...)
// Cursor size = 60%. (Press any key to continue...)
// Cursor size = 70%. (Press any key to continue...)
// Cursor size = 80%. (Press any key to continue...)
// Cursor size = 90%. (Press any key to continue...)
// Cursor size = 100%. (Press any key to continue...)

Examples:

console_cursor_size.cpp, console_cursor_visible.cpp, and console_info.cpp.

cursor_size() [2/2]

static void xtd::console::cursor_size ( int32  size )

static

Sets the height of the cursor within a character cell.

Parameters

size	The size of the cursor expressed as a percentage of the height of a character cell. The property value ranges from 1 to 100.

Exceptions

xtd::argument_out_of_range_exception

The value specified in a set operation is less than 1 or greater than 100.

Examples

This example demonstrates the cursor_size property. The example increases the size of the cursor each time any console key is pressed, then restores the cursor to its original size before terminating.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  auto m0 = "This example increments the cursor size from 1% to 100%:\n";
  auto m1 = "Cursor size = {0}%. (Press any key to continue...)";
  auto sizes = { 1, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 };

  auto save_cursor_size = console::cursor_size();
  console::write_line(m0);
  for (auto size : sizes) {
    console::cursor_size(size);
    console::write_line(m1, size);
    console::read_key();
  }
  console::cursor_size(save_cursor_size);
}

// This code produces the following output:
//
// This example increments the cursor size from 1% to 100%:
//
// Cursor size = 1%. (Press any key to continue...)
// Cursor size = 10%. (Press any key to continue...)
// Cursor size = 20%. (Press any key to continue...)
// Cursor size = 30%. (Press any key to continue...)
// Cursor size = 40%. (Press any key to continue...)
// Cursor size = 50%. (Press any key to continue...)
// Cursor size = 60%. (Press any key to continue...)
// Cursor size = 70%. (Press any key to continue...)
// Cursor size = 80%. (Press any key to continue...)
// Cursor size = 90%. (Press any key to continue...)
// Cursor size = 100%. (Press any key to continue...)

cursor_top() [1/2]

static int32 xtd::console::cursor_top ( )

static

Gets the row position of the cursor within the buffer area.

Returns

The current position, in rows, of the cursor.

Examples

This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings.

#include <xtd/console>

using namespace xtd;

auto orig_row = 0;
auto orig_col = 0;

void write_at(const ustring& s, int x, int y) {
  console::set_cursor_position(orig_col + x, orig_row + y);
  console::write(s);
}

auto main()->int {
  // Clear the screen, then save the top and left coordinates.
  console::clear();
  orig_row = console::cursor_top();
  orig_col = console::cursor_left();
  
  // Draw the left side of a 5x5 rectangle, from top to bottom.
  write_at("+", 0, 0);
  write_at("|", 0, 1);
  write_at("|", 0, 2);
  write_at("|", 0, 3);
  write_at("+", 0, 4);
  
  // Draw the bottom side, from left to right.
  write_at("-", 1, 4); // shortcut: write_at("---", 1, 4)
  write_at("-", 2, 4); // ...
  write_at("-", 3, 4); // ...
  write_at("+", 4, 4);
  
  // Draw the right side, from bottom to top.
  write_at("|", 4, 3);
  write_at("|", 4, 2);
  write_at("|", 4, 1);
  write_at("+", 4, 0);
  
  // Draw the top side, from right to left.
  write_at("-", 3, 0); // shortcut: write_at("---", 1, 0)
  write_at("-", 2, 0); // ...
  write_at("-", 1, 0); // ...
  //
  write_at("All done!", 0, 6);
  console::write_line();
}

// This code produces the following output:
//
// +---+
// |   |
// |   |
// |   |
// +---+
//
// All done!

Examples:

console_cursor.cpp, and console_info.cpp.

cursor_top() [2/2]

static void xtd::console::cursor_top ( int32  top )

static

Sets the row position of the cursor within the buffer area.

Parameters

top	The current position, in rows, of the cursor.

Returns

true if cursor top changed; otherwise false.

Exceptions

xtd::argument_out_of_range_exception

The value in a set operation is less than zero -or- The value in a set operation is greater than or equal to xtd::console::buffer_height.

Examples

This example demonstrates the cursor_left and cursor_top properties, and the set_cursor_position and clear methods. The example positions the cursor, which determines where the next write will occur, to draw a 5 character by 5 character rectangle using a combination of "+", "|", and "-" strings. Note that the rectangle could be drawn with fewer steps using a combination of other strings.

#include <xtd/console>

using namespace xtd;

auto orig_row = 0;
auto orig_col = 0;

void write_at(const ustring& s, int x, int y) {
  console::set_cursor_position(orig_col + x, orig_row + y);
  console::write(s);
}

auto main()->int {
  // Clear the screen, then save the top and left coordinates.
  console::clear();
  orig_row = console::cursor_top();
  orig_col = console::cursor_left();
  
  // Draw the left side of a 5x5 rectangle, from top to bottom.
  write_at("+", 0, 0);
  write_at("|", 0, 1);
  write_at("|", 0, 2);
  write_at("|", 0, 3);
  write_at("+", 0, 4);
  
  // Draw the bottom side, from left to right.
  write_at("-", 1, 4); // shortcut: write_at("---", 1, 4)
  write_at("-", 2, 4); // ...
  write_at("-", 3, 4); // ...
  write_at("+", 4, 4);
  
  // Draw the right side, from bottom to top.
  write_at("|", 4, 3);
  write_at("|", 4, 2);
  write_at("|", 4, 1);
  write_at("+", 4, 0);
  
  // Draw the top side, from right to left.
  write_at("-", 3, 0); // shortcut: write_at("---", 1, 0)
  write_at("-", 2, 0); // ...
  write_at("-", 1, 0); // ...
  //
  write_at("All done!", 0, 6);
  console::write_line();
}

// This code produces the following output:
//
// +---+
// |   |
// |   |
// |   |
// +---+
//
// All done!

cursor_visible() [1/2]

static bool xtd::console::cursor_visible ( )

static

Gets a value indicating whether the cursor is visible.

Returns

true if the cursor is visible; otherwise, false.

Examples

This example demonstrates the cursor_visible property. The example makes the cursor visible if the first column of input is a '+' character or invisible if the input is a '-' character.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  auto m1 = "\nThe cursor is {0}.\nType any text then press Enter. "
  "Type '+' in the first column to show \n"
  "the cursor, '-' to hide the cursor, "
  "or lowercase 'x' to quit:"_s;
  auto s = ustring::empty_string;

  auto save_cursor_visibile = console::cursor_visible();
  auto save_cursor_size = console::cursor_size();
  console::cursor_visible(true); // Initialize the cursor to visible.
  console::cursor_size(100);     // Emphasize the cursor.
  
  while (true) {
    console::write_line(m1, ((console::cursor_visible() == true) ? "VISIBLE" : "HIDDEN"));
    s = console::read_line();
    if (ustring::is_empty(s) == false) {
      if (s[0] == '+')
        console::cursor_visible(true);
      else if (s[0] == '-')
        console::cursor_visible(false);
      else if (s[0] == 'x')
        break;
    }
  }
  console::cursor_visible(save_cursor_visibile);
  console::cursor_size(save_cursor_size);
}

// This code produces the following output. Note that these results
// cannot depict cursor visibility. You must run the example to see the
// cursor behavior:
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// The quick brown fox
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// -
//
// The cursor is HIDDEN.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// jumps over
//
// The cursor is HIDDEN.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// +
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// the lazy dog.
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// x

Examples:

console_cursor_visible.cpp, and console_info.cpp.

cursor_visible() [2/2]

static void xtd::console::cursor_visible ( bool  visible )

static

Sets a value indicating whether the cursor is visible.

Parameters

visible

true if the cursor is visible; otherwise, false.

Examples

This example demonstrates the cursor_visible property. The example makes the cursor visible if the first column of input is a '+' character or invisible if the input is a '-' character.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  auto m1 = "\nThe cursor is {0}.\nType any text then press Enter. "
  "Type '+' in the first column to show \n"
  "the cursor, '-' to hide the cursor, "
  "or lowercase 'x' to quit:"_s;
  auto s = ustring::empty_string;

  auto save_cursor_visibile = console::cursor_visible();
  auto save_cursor_size = console::cursor_size();
  console::cursor_visible(true); // Initialize the cursor to visible.
  console::cursor_size(100);     // Emphasize the cursor.
  
  while (true) {
    console::write_line(m1, ((console::cursor_visible() == true) ? "VISIBLE" : "HIDDEN"));
    s = console::read_line();
    if (ustring::is_empty(s) == false) {
      if (s[0] == '+')
        console::cursor_visible(true);
      else if (s[0] == '-')
        console::cursor_visible(false);
      else if (s[0] == 'x')
        break;
    }
  }
  console::cursor_visible(save_cursor_visibile);
  console::cursor_size(save_cursor_size);
}

// This code produces the following output. Note that these results
// cannot depict cursor visibility. You must run the example to see the
// cursor behavior:
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// The quick brown fox
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// -
//
// The cursor is HIDDEN.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// jumps over
//
// The cursor is HIDDEN.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// +
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// the lazy dog.
//
// The cursor is VISIBLE.
// Type any text then press Enter. Type '+' in the first column to show
// the cursor, '-' to hide the cursor, or lowercase 'x' to quit:
// x

foreground_color() [1/2]

static console_color xtd::console::foreground_color ( )

static

Gets the foreground color of the console.

Returns

A console_color that specifies the foreground color of the console; that is, the color of each character that is displayed.

Examples

The following example saves the values of the console_color enumeration to an array and stores the current values of the background_color and foreground_color properties to variables. It then changes the foreground color to each color in the ConsoleColor enumeration except to the color that matches the current background, and it changes the background color to each color in the console_color enumeration except to the color that matches the current foreground. (If the foreground color is the same as the background color, the text isn't visible.) Finally, it calls the reset_color method to restore the original console colors.

#include <xtd/background_color>
#include <xtd/foreground_color>
#include <xtd/reset_color>

using namespace std;
using namespace xtd;

auto main()->int {
  const auto logo = vector {
    u8"████████████████████████████████████████████████████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████",
    u8"███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████",
    u8"██████████████████████████      ▀████       ▀█████████████████████████",
    u8"███████████             ▐         ▀▀         ▐              ██████████",
    u8"█████████               ▐   ███   ▌▐   ███   ▐               █████████",
    u8"█████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████",
    u8"█████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████",
    u8"█████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████",
    u8"█████████                                                    █████████",
    u8"█████████                 █▄                ▌                █████████",
    u8"█████████                  ▌▀▀▄          ▄██                 █████████",
    u8"█████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████",
    u8"█████████                   ▐            ▄█                  █████████",
    u8"█████████                    █          ▄█                   █████████",
    u8"█████████                     ▀▄       █▀                    █████████",
    u8"█████████                       ▀▄▄▄▄██▀                     █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"██████████████████████████████████████████████████████████████████",
  };
  
  console::output_code_page(65001);
  
  for (auto index = 0ul; index < logo.size(); ++index)
    cout << (index == 0 || index == logo.size() - 1 ? "       " : "     ") << background_color(console_color::white) << foreground_color(console_color::dark_blue) << logo[index] << reset_color() << endl;
    
  cout << foreground_color(console_color::dark_blue) << "                                    Gammasoft                                   " << endl;
  cout << foreground_color(console_color::dark_gray) << " More than thirty years of passion for high technology especially in development" << endl;
  cout << " (c++, c#, objective-c, ...)." << reset_color() << endl;
}

// This code produces the following output with colors:
//
//        ████████████████████████████████████████████████████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████
//      ███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████
//      ██████████████████████████      ▀████       ▀█████████████████████████
//      ███████████             ▐         ▀▀         ▐              ██████████
//      █████████               ▐   ███   ▌▐   ███   ▐               █████████
//      █████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████
//      █████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████
//      █████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████
//      █████████                                                    █████████
//      █████████                 █▄                ▌                █████████
//      █████████                  ▌▀▀▄          ▄██                 █████████
//      █████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████
//      █████████                   ▐            ▄█                  █████████
//      █████████                    █          ▄█                   █████████
//      █████████                     ▀▄       █▀                    █████████
//      █████████                       ▀▄▄▄▄██▀                     █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//        ██████████████████████████████████████████████████████████████████
//                                    Gammasoft
// More than thirty years of passion for high technology especially in development
// (c++, c#, objective-c, ...).

Examples:

console_color.cpp, console_info.cpp, and hello_world_console.cpp.

foreground_color() [2/2]

static bool xtd::console::foreground_color ( console_color  color )

static

Sets the foreground color of the console.

Parameters

color

A console_color that specifies the foreground color of the console; that is, the color of each character that is displayed.

Exceptions

xtd::argument_exception

The color specified in a set operation is not a valid member of xtd::console_color.

Examples

The following example saves the values of the console_color enumeration to an array and stores the current values of the background_color and foreground_color properties to variables. It then changes the foreground color to each color in the ConsoleColor enumeration except to the color that matches the current background, and it changes the background color to each color in the console_color enumeration except to the color that matches the current foreground. (If the foreground color is the same as the background color, the text isn't visible.) Finally, it calls the reset_color method to restore the original console colors.

#include <xtd/background_color>
#include <xtd/foreground_color>
#include <xtd/reset_color>

using namespace std;
using namespace xtd;

auto main()->int {
  const auto logo = vector {
    u8"████████████████████████████████████████████████████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████",
    u8"███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████████████████████████████████████████████████",
    u8"██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████",
    u8"███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████",
    u8"██████████████████████████      ▀████       ▀█████████████████████████",
    u8"███████████             ▐         ▀▀         ▐              ██████████",
    u8"█████████               ▐   ███   ▌▐   ███   ▐               █████████",
    u8"█████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████",
    u8"█████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████",
    u8"█████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████",
    u8"█████████                                                    █████████",
    u8"█████████                 █▄                ▌                █████████",
    u8"█████████                  ▌▀▀▄          ▄██                 █████████",
    u8"█████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████",
    u8"█████████                   ▐            ▄█                  █████████",
    u8"█████████                    █          ▄█                   █████████",
    u8"█████████                     ▀▄       █▀                    █████████",
    u8"█████████                       ▀▄▄▄▄██▀                     █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"█████████                                                    █████████",
    u8"██████████████████████████████████████████████████████████████████",
  };
  
  console::output_code_page(65001);
  
  for (auto index = 0ul; index < logo.size(); ++index)
    cout << (index == 0 || index == logo.size() - 1 ? "       " : "     ") << background_color(console_color::white) << foreground_color(console_color::dark_blue) << logo[index] << reset_color() << endl;
    
  cout << foreground_color(console_color::dark_blue) << "                                    Gammasoft                                   " << endl;
  cout << foreground_color(console_color::dark_gray) << " More than thirty years of passion for high technology especially in development" << endl;
  cout << " (c++, c#, objective-c, ...)." << reset_color() << endl;
}

// This code produces the following output with colors:
//
//        ████████████████████████████████████████████████████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░██████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░██████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ██████████████████████████████░░░░░░░░░░░░░░░░░░░░░░████░░████████████
//      ███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░█████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████████████████████████████████████████████████
//      ██████████████████████████▀▄▄▄▄▀███████▀▄▄▄▄▀█████████████████████████
//      ███████████████████████████▀▀▀▀███████▀▀▀▀▀███████████████████████████
//      ██████████████████████████      ▀████       ▀█████████████████████████
//      ███████████             ▐         ▀▀         ▐              ██████████
//      █████████               ▐   ███   ▌▐   ███   ▐               █████████
//      █████████               ▐   █▄▄▌  ▌▐  ▐▄▄█   ▐               █████████
//      █████████                ▐▄  ▀▀ ▄▀  ▀▄ ▀▀  ▄▀                █████████
//      █████████                  ▀▀▄▄▀      ▀▀▄▄▀                  █████████
//      █████████                                                    █████████
//      █████████                 █▄                ▌                █████████
//      █████████                  ▌▀▀▄          ▄██                 █████████
//      █████████                  ▐   ▀▀▄▄▄▄▄▄█▀ █▌                 █████████
//      █████████                   ▐            ▄█                  █████████
//      █████████                    █          ▄█                   █████████
//      █████████                     ▀▄       █▀                    █████████
//      █████████                       ▀▄▄▄▄██▀                     █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//      █████████                                                    █████████
//        ██████████████████████████████████████████████████████████████████
//                                    Gammasoft
// More than thirty years of passion for high technology especially in development
// (c++, c#, objective-c, ...).

get_cursor_position()

static std::pair<int32, int32> xtd::console::get_cursor_position ( )

static

Gets the position of the cursor.

Returns

The column and row position of the cursor.

Remarks

Columns are numbered from left to right starting at 0. Rows are numbered from top to bottom starting at 0.

input_code_page() [1/2]

static int32 xtd::console::input_code_page ( )

static

Gets the code page the console uses to read input.

Returns

The code page used to read console input.

input_code_page() [2/2]

static bool xtd::console::input_code_page ( int32  code_page )

static

Sets the code page the console uses to read input.

Parameters

code_page

The code page used to read console input.

Returns

true if the code page changed; otherwise false.

is_error_redirected()

static bool xtd::console::is_error_redirected ( )

static

Gets a value that indicates whether the error output stream has been redirected from the standard error stream.

Parameters

true	if error output is redirected; otherwise, false.

Examples:

console_info.cpp.

is_input_redirected()

static bool xtd::console::is_input_redirected ( )

static

Gets a value that indicates whether the input stream has been redirected from the standard input stream.

Parameters

true	if input is redirected; otherwise, false.

Examples:

console_info.cpp.

is_output_redirected()

static bool xtd::console::is_output_redirected ( )

static

Gets a value that indicates whether the output stream has been redirected from the standard output stream.

Parameters

true	if output is redirected; otherwise, false.

Examples:

console_info.cpp.

key_available()

static bool xtd::console::key_available ( )

static

Gets a value indicating whether a key press is available in the input stream.

Returns

true if a key press is available; otherwise, false.

Remarks

The key_available method is returned immediately; that is, the key_available method does not block input until a key press is available.

Use the key_available method in conjunction with only the read_key method, not the read or read_line methods

Examples:

console_info.cpp, console_key_available.cpp, console_read_key.cpp, and environment_cancel_signal.cpp.

largest_window_height()

static int32 xtd::console::largest_window_height ( )

static

Gets the largest possible number of console window rows, based on the current font and screen resolution.

Parameters

The	height of the largest possible console window measured in rows.

Examples:

console_info.cpp.

largest_window_width()

static int32 xtd::console::largest_window_width ( )

static

Gets the largest possible number of console window columns, based on the current font and screen resolution.

Parameters

The	width of the largest possible console window measured in columns.

Examples:

console_info.cpp.

number_lock()

static bool xtd::console::number_lock ( )

static

Gets a value indicating whether the NUM LOCK keyboard toggle is turned on or turned off.

Parameters

true	if NUM LOCK is turned on; false if NUM LOCK is turned off.

open_standard_error()

static std::ostream xtd::console::open_standard_error ( )

static

Acquires the standard error stream.

Returns

The standard error stream.

Remarks

This method can be used to reacquire the standard error stream after it has been changed by the set_error method.

open_standard_input()

static std::istream xtd::console::open_standard_input ( )

static

Acquires the standard input stream.

Returns

The standard input stream.

Remarks

This method can be used to reacquire the standard input stream after it has been changed by the set_int method.

open_standard_output()

static std::ostream xtd::console::open_standard_output ( )

static

Acquires the standard output stream.

Returns

The standard output stream.

Remarks

This method can be used to reacquire the standard output stream after it has been changed by the set_output method.

Examples:

redirect_output.cpp.

output_code_page() [1/2]

static int32 xtd::console::output_code_page ( )

static

Gets the code page the console uses to write output.

Returns

The code page used to write console output.

Examples:

string_unicode.cpp.

output_code_page() [2/2]

static bool xtd::console::output_code_page ( int32  code_page )

static

Sets the code page the console uses to write output.

Parameters

code_page

The code page used to write console output.

Returns

true if the code page changed; otherwise false.

read()

static int32 xtd::console::read ( )

static

Reads the next character from the standard input stream.

Returns

int32 The next character from the input stream, or negative one (-1) if there are currently no more characters to be read

Remarks

The Read method blocks its return while you type input characters; it terminates when you press the Enter key.

Pressing Enter appends a platform-dependent line termination sequence to your input (for example, Windows appends a carriage return-linefeed sequence).

Subsequent calls to the Read method retrieve your input one character at a time. After the final character is retrieved, Read blocks its return again and the cycle repeats.

Note that you will not get a property value of -1 unless you perform one of the following actions: simultaneously press the Control modifier key and Z console key (CTRL+Z),

which signals the end-of-file condition; press an equivalent key that signals the end-of-file condition, such as the F6 function key in Windows; or redirect the input stream to a source,

such as a text file, that has an actual end-of-file character.

Example

The following example demonstrates the Read method.

#include <xtd/char_object>
#include <xtd/console>
#include <xtd/convert>

using namespace xtd;

auto main()->int {
  auto m1 = "\nType a string of text then press Enter. "
  "Type '+' anywhere in the text to quit:\n";
  auto m2 = "Character '{0}' is hexadecimal 0x{1:x4}.";
  auto m3 = "Character     is hexadecimal 0x{0:x4}.";
  auto ch = U'0';
  //
  console::write_line(m1);
  do {
    auto x = console::read();
    try {
      ch = convert::to_char32(x);
      if (char_object::is_white_space(ch)) {
        console::write_line(m3, x);
        if (ch == 0x0a)
          console::write_line(m1);
      } else
        console::write_line(m2, ch, x);
    } catch (const overflow_exception& e) {
      console::write_line("{0} Value read = {1}.", e.message(), x);
      ch = char_object::min_value;
      console::write_line(m1);
    }
  } while (ch != '+');
}

// This code produces the following output:
//
// Type a string of text then press Enter. Type '+' anywhere in the text to quit:
//
// The quick brown fox.
// Character 'T' is hexadecimal 0x0054.
// Character 'h' is hexadecimal 0x0068.
// Character 'e' is hexadecimal 0x0065.
// Character     is hexadecimal 0x0020.
// Character 'q' is hexadecimal 0x0071.
// Character 'u' is hexadecimal 0x0075.
// Character 'i' is hexadecimal 0x0069.
// Character 'c' is hexadecimal 0x0063.
// Character 'k' is hexadecimal 0x006b.
// Character     is hexadecimal 0x0020.
// Character 'b' is hexadecimal 0x0062.
// Character 'r' is hexadecimal 0x0072.
// Character 'o' is hexadecimal 0x006f.
// Character 'w' is hexadecimal 0x0077.
// Character 'n' is hexadecimal 0x006e.
// Character     is hexadecimal 0x0020.
// Character 'f' is hexadecimal 0x0066.
// Character 'o' is hexadecimal 0x006f.
// Character 'x' is hexadecimal 0x0078.
// Character '.' is hexadecimal 0x002e.
// Character     is hexadecimal 0x000d.
// Character     is hexadecimal 0x000a.
//
// Type a string of text then press Enter. Type '+' anywhere in the text to quit:
//
// ^Z
// Value was either too large or too small for a character. Value read = -1.
//
// Type a string of text then press Enter. Type '+' anywhere in the text to quit:
//
// +
// Character '+' is hexadecimal 0x002b.

Examples:

console_read.cpp.

read_key() [1/2]

static console_key_info xtd::console::read_key ( )

static

Obtains the next character or function key pressed by the user. The pressed key is displayed in the console window.

Returns

xtd::console_key_info A xtd::console_key_info object that describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The xtd::console_key_info object also describes, in a bitwise combination of ConsoleModifiers values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key.

Examples:

console_cursor_size.cpp, console_key_available.cpp, console_read_key.cpp, console_title.cpp, console_window_size.cpp, environment_cancel_signal.cpp, file_info_replace.cpp, network_stream.cpp, socket_tcp_ip_v4.cpp, socket_tcp_ip_v4_without_thread.cpp, socket_tcp_ip_v6.cpp, socket_udp_ip_v4.cpp, socket_udp_ip_v6.cpp, stack_frame.cpp, system_sounds.cpp, tcp_client_ip_v4.cpp, tcp_client_ip_v6.cpp, udp_client_ip_v4.cpp, and udp_client_ip_v6.cpp.

read_key() [2/2]

static console_key_info xtd::console::read_key ( bool  intercept )

static

Obtains the next character or function key pressed by the user. The pressed key is optionally displayed in the console window.

Parameters

intercept

Determines whether to display the pressed key in the console window. true to not display the pressed key; otherwise, false

Returns

xtd::console_key_info A xtd::console_key_info object that describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The xtd::console_key_info object also describes, in a bitwise combination of ConsoleModifiers values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key.

read_line() [1/2]

static xtd::ustring xtd::console::read_line ( )

static

Reads the next line of characters from the standard input stream.

Returns

The next line of characters from the input stream, or "" if no more lines are available.

Examples:

auto_reset_event.cpp, console_cursor_visible.cpp, console_read_line.cpp, event_wait_handle.cpp, manual_reset_event.cpp, thread.cpp, and wconsole.cpp.

read_line() [2/2]

static xtd::ustring xtd::console::read_line ( bool  intercept )

static

Reads the next line of characters from the standard input stream.

Parameters

intercept

Determines whether to display the pressed key in the console window. true to not display the pressed key; otherwise, false

Returns

The next line of characters from the input stream, or "" if no more lines are available.

reset_color()

static bool xtd::console::reset_color ( )

static

Sets the foreground and background console colors to their defaults.

Remarks

The foreground and background colors are restored to the colors that existed when the current process began. For more information, see the foreground_color and background_color properties.

Examples:

console_background_color.cpp, and console_color.cpp.

set_cursor_position()

static void xtd::console::set_cursor_position ( int32  left, int32  top  )

static

Sets the position of the cursor.

Parameters

left	The column position of the cursor. Columns are numbered from left to right starting at 0.
top	The row position of the cursor. Rows are numbered from top to bottom starting at 0.

Exceptions

xtd::argument_out_of_range_exception

The left in a set operation is less than zero -or- The left in a set operation is greater than or equal to xtd::console::buffer_width -or- the top in a set operation is less than zero -or- The topo in a set operation is greater than or equal to xtd::console::buffer_height.

Remarks

Use the set_cursor_position method to specify where the next write operation in the console window is to begin. If the specified cursor position is outside the area that is currently visible in the console window, the window origin changes automatically to make the cursor visible.

The cursor automatically moves to the next character position each time a character is written to the console window. If the cursor is at the bottom right character position of the console window, the next write operation causes the console window to scroll so the cursor remains visible. If you want to write a character to the bottom right character position without causing the console window to scroll, use the move_buffer_area method to move a character to that position.

Examples:

console_cursor.cpp.

set_error()

static void xtd::console::set_error ( const std::ostream &  os )

static

Sets the error property to the specified std::ostream object.

Parameters

os	A stream that is the new standard error output.

Remarks

By default, the error property is set to the standard error output stream.

A std::ostream that encapsulates a std::ofstream can be used to send error messages to a file.

set_in()

static void xtd::console::set_in ( const std::istream &  is )

static

Sets the int property to the specified std::istream object.

Parameters

os	A stream that is the new standard input.

Remarks

By default, the in property is set to the standard input stream.

A std::istream that encapsulates a std::ifstream can be used to receiver input from a file.

set_out()

static void xtd::console::set_out ( const std::ostream &  os )

static

Sets the out property to the specified std::ostream object.

Parameters

os	A stream that is the new standard output.

Remarks

By default, the out property is set to the standard output stream.

A std::ostream that encapsulates a std::ofstream can be used to send output to a file.

Examples:

redirect_output.cpp.

set_window_position()

static void xtd::console::set_window_position ( int32  left, int32  top  )

static

Sets the position of the console window relative to the screen buffer.

Parameters

left	The column position of the upper left corner of the console window.
top	The row position of the upper left corner of the console window.

Exceptions

xtd::argument_out_of_range_exception

The left in a set operation is less than zero -or- The left in a set operation is greater than or equal to xtd::console::buffer_width -or- the top in a set operation is less than zero -or- The topo in a set operation is greater than or equal to xtd::console::buffer_height.

set_window_size()

static void xtd::console::set_window_size ( int32  width, int32  height  )

static

Sets the height and width of the console window to the specified values.

Parameters

width	The width of the console window measured in columns.
height	The height of the console window measured in rows.

Exceptions

xtd::argument_out_of_range_exception

width or height is less than or equal to zero. -or- width plus WindowLeft or height plus WindowTop is greater than or equal to xtd::int16_object.max_value. -or- width or height is greater than the largest possible window width or height for the current screen resolution and console font.

Examples

This example demonstrates the SetWindowSize method, and the WindowWidth and WindowHeight properties. You must run the example to see the full effect of changing the console window size. The example reports the dimensions of a console window set to 85 columns and 43 rows, then waits for a key press. When any key is pressed, the dimensions of the console window are halved, the new dimensions are reported, and the example waits for another key press. Finally, when any key is pressed the console window is restored to its original dimensions and the example terminates.

#include <xtd/console>

using namespace xtd;

auto main()->int {
  auto orig_width = 0, width = 0;
  auto orig_height = 0, height = 0;
  auto m1 = "The current window width is {0}, and the current window height is {1}.";
  auto m2 = "The new window width is {0}, and the new window height is {1}.";
  auto m4 = "  (Press any key to continue...)";
  //
  // Step 1: Get the current window dimensions.
  //
  orig_width  = console::window_width();
  orig_height = console::window_height();
  console::write_line(m1, console::window_width(), console::window_height());
  console::write_line(m4);
  console::read_key(true);
  //
  // Step 2: Cut the window to 1/4 its original size.
  //
  width  = orig_width / 2;
  height = orig_height / 2;
  console::set_window_size(width, height);
  console::write_line(m2, console::window_width(), console::window_height());
  console::write_line(m4);
  console::read_key(true);
  //
  // Step 3: Restore the window to its original size.
  //
  console::set_window_size(orig_width, orig_height);
  console::write_line(m1, console::window_width(), console::window_height());}

// This code produces the following output:
//
// The current window width is 100, and the current window height is 60.
//   (Press any key to continue...)
// The new window width is 50, and the new window height is 30.
//   (Press any key to continue...)
// The current window width is 100, and the current window height is 60.

Examples:

console_window_size.cpp.

title() [1/2]

static xtd::ustring xtd::console::title ( )

static

Gets the title to display in the console title bar.

Returns

The string to be displayed in the title bar of the console. The maximum length of the title string is 24500 characters.

Examples:

console_info.cpp, and console_title.cpp.

title() [2/2]

static void xtd::console::title ( const xtd::ustring &  title )

static

Sets the title to display in the console title bar.

Parameters

title

The string to be displayed in the title bar of the console. The maximum length of the title string is 24500 characters.

treat_control_c_as_input() [1/2]

static bool xtd::console::treat_control_c_as_input ( )

static

Gets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system.

Returns

true if Ctrl+C is treated as ordinary input; otherwise, false.

Remarks

If the value of the treat_control_c_as_input property is false and Ctrl+C is pressed, the pressed keys are not stored in the input buffer and the operating system terminates the currently executing process. This is the default value.

Warning

Use this property judiciously because setting it to true has such a dramatic effect. Most users expect Ctrl+C to terminate a console application. If you disable the effect of Ctrl+C, the user must remember to use Ctrl+Break to terminate the application, which is a less familiar key combination.

Examples:

console_info.cpp, and environment_cancel_signal.cpp.

treat_control_c_as_input() [2/2]

static void xtd::console::treat_control_c_as_input ( bool  treat_control_c_as_input )

static

Sets a value indicating whether the combination of the Control modifier key and C console key (Ctrl+C) is treated as ordinary input or as an interruption that is handled by the operating system.

Parameters

treat_control_c_as_input

true if Ctrl+C is treated as ordinary input; otherwise, false.

Remarks

If the value of the treat_control_c_as_input property is false and Ctrl+C is pressed, the pressed keys are not stored in the input buffer and the operating system terminates the currently executing process. This is the default value.

Warning

Use this property judiciously because setting it to true has such a dramatic effect. Most users expect Ctrl+C to terminate a console application. If you disable the effect of Ctrl+C, the user must remember to use Ctrl+Break to terminate the application, which is a less familiar key combination.

window_height() [1/2]

static int32 xtd::console::window_height ( )

static

Gets the height of the console window area.

Returns

The height of the console window measured in rows.

Examples:

console_info.cpp, and console_window_size.cpp.

window_height() [2/2]

static void xtd::console::window_height ( int32  height )

static

Sets the height of the console window area.

Parameters

height

The height of the console window measured in rows.

window_left() [1/2]

static int32 xtd::console::window_left ( )

static

Gets the left of the console window area.

Returns

The left of the console window measured in columns.

Examples:

console_info.cpp.

window_left() [2/2]

static void xtd::console::window_left ( int32  left )

static

Sets the left of the console window area.

Parameters

left	The left of the console window measured in columns.

window_top() [1/2]

static int32 xtd::console::window_top ( )

static

Gets the top of the console window area.

Returns

The top of the console window measured in rows.

Examples:

console_info.cpp.

window_top() [2/2]

static void xtd::console::window_top ( int32  top )

static

Sets the top of the console window area.

Parameters

top	The top of the console window measured in rows.

window_width() [1/2]

static int32 xtd::console::window_width ( )

static

Gets the width of the console window area.

Returns

The width of the console window measured in columns.

Examples:

console_info.cpp, and console_window_size.cpp.

window_width() [2/2]

static void xtd::console::window_width ( int32  width )

static

Sets the width of the console window area.

Parameters

width

The width of the console window measured in columns.

write() [1/2]

template<typename arg_t >

static void xtd::console::write ( arg_t &&  value )

inlinestatic

Writes the text representation of the specified value to the standard output stream.

Template Parameters

arg_t

The type of the value to write.

Parameters

value

The value to write,

Examples:

console_cursor.cpp, console_read_line.cpp, date_time_min_value.cpp, environment_program_exit.cpp, process_with_standard_output_redirection.cpp, and wconsole.cpp.

write() [2/2]

template<typename ... args_t>

static void xtd::console::write ( const xtd::ustring &  fmt, args_t &&...  values  )

inlinestatic

Writes the text representation of the specified list of values to the standard output stream using the specified format information.

Template Parameters

...args_t

Types of the values to write.

Parameters

values

Values to write,

write_line() [1/3]

static void xtd::console::write_line ( )

static

Writes the current line terminator to the standard output stream using the specified format information.

Examples:

action1.cpp, action2.cpp, action3.cpp, argument_exception.cpp, assert_.cpp, assert_with_message.cpp, auto_reset_event.cpp, bit_converter.cpp, bit_converter_endianness.cpp, bit_converter_is_big_endian.cpp, bit_converter_is_little_endian.cpp, block_scope.cpp, boxed_info.cpp, boxing.cpp, color.cpp, compare.cpp, compare_ignore_case.cpp, concat.cpp, concat_collection.cpp, console_background_color.cpp, console_beep.cpp, console_buffer.cpp, console_color.cpp, console_cursor.cpp, console_cursor_size.cpp, console_cursor_visible.cpp, console_info.cpp, console_key_available.cpp, console_read.cpp, console_read_key.cpp, console_read_line.cpp, console_title.cpp, console_window_size.cpp, contains.cpp, csf.cpp, css_reader.cpp, current_stack_frame.cpp, date_time.cpp, date_time_add.cpp, date_time_add_days.cpp, date_time_add_months.cpp, date_time_add_seconds.cpp, date_time_add_years.cpp, date_time_date.cpp, date_time_day_of_week.cpp, date_time_day_of_year.cpp, date_time_days_in_month.cpp, date_time_max_value.cpp, date_time_min_value.cpp, date_time_specify_kind.cpp, date_time_sprintf.cpp, date_time_subtract.cpp, date_time_ticks.cpp, date_time_time_of_day.cpp, date_time_to_string_format.cpp, debug_cassert.cpp, delegate.cpp, delegate_member_method.cpp, delegate_multicast.cpp, directory_info.cpp, dns_get_host_addresses.cpp, dns_get_host_entry.cpp, enum.cpp, enum_class.cpp, enum_class_flags.cpp, enum_class_flags_introspection.cpp, enum_class_flags_without_helpers.cpp, enum_class_parse.cpp, enum_class_ut.cpp, enum_class_without_helper.cpp, enum_struct.cpp, enum_struct_ut.cpp, enum_ut.cpp, environment.cpp, environment_cancel_signal.cpp, environment_command_line.cpp, environment_current_directory.cpp, environment_exit.cpp, environment_expand_environment_variables.cpp, environment_program_exit.cpp, environment_stack_trace.cpp, environment_tick_count.cpp, event_wait_handle.cpp, exception_ptr.cpp, file_info.cpp, file_info2.cpp, file_info_append_text.cpp, file_info_open_read.cpp, file_info_open_text.cpp, file_info_open_write.cpp, file_info_replace.cpp, font.cpp, guid.cpp, hello_world_console.cpp, hello_world_environment.cpp, hello_world_io.cpp, image.cpp, interlocked.cpp, interlocked_decrement.cpp, iprogress.cpp, join.cpp, lock.cpp, main1.cpp, main2.cpp, main4.cpp, main5.cpp, manual_reset_event.cpp, math.cpp, mixing_std_and_xtd_threads.cpp, monitor.cpp, mutex.cpp, network_stream.cpp, parse_boolean.cpp, parse_enum.cpp, parse_enum_class.cpp, parse_enum_struct.cpp, point.cpp, redirect_output.cpp, semaphore.cpp, socket_tcp_ip_v4.cpp, socket_tcp_ip_v4_without_thread.cpp, socket_tcp_ip_v6.cpp, socket_udp_ip_v4.cpp, socket_udp_ip_v6.cpp, split.cpp, stack_frame.cpp, stack_trace.cpp, stack_trace_simple.cpp, static.cpp, static_object2.cpp, string_unicode.cpp, system_exception.cpp, system_fonts.cpp, system_sounds.cpp, target_type.cpp, tcp_client_ip_v4.cpp, tcp_client_ip_v6.cpp, test_console.cpp, thread.cpp, thread_pool.cpp, timeout.cpp, timer.cpp, trace_cassert.cpp, udp_client_ip_v4.cpp, udp_client_ip_v6.cpp, uri.cpp, using.cpp, version.cpp, version_os.cpp, wait_handle.cpp, and wconsole.cpp.

write_line() [2/3]

template<typename arg_t >

static void xtd::console::write_line ( arg_t &&  value )

inlinestatic

Writes the text representation of the specified value, followed by the current line terminator, to the standard output stream.

Template Parameters

arg_t

The type of the value to write.

Parameters

value

The value to write,

write_line() [3/3]

template<typename ... args_t>

static void xtd::console::write_line ( const xtd::ustring &  fmt, args_t &&...  values  )

inlinestatic

Writes the text representation of the specified list of values, followed by the current line terminator, to the standard output stream using the specified format information.

Template Parameters

...args_t

Types of the values to write.

Parameters

values

Values to write,

Member Data Documentation

cancel_key_press

event<console, console_cancel_event_handler> xtd::console::cancel_key_press

static

Occurs when the Control modifier key (Ctrl) and either the ConsoleKey.C console key (C) or the Break key are pressed simultaneously (Ctrl+C or Ctrl+Break).

Remarks

This event is used in conjunction with xtd::console_cancel_event_handler and xtd::console_cancel_event_args. The cancel_key_press event enables a console application to intercept the Ctrl+C signal so the event handler can decide whether to continue executing or terminate.

For more information about handling events, see Handling and Raising Events.

When the user presses either Ctrl+C or Ctrl+Break, the cancel_key_press event is fired and the application's console_cancel_event_handler event handler is executed. The event handler is passed a console_cancel_event_args object that has two useful properties:

• special_key, which allows you to determine whether the handler was invoked as a result of the user pressing Ctrl+C (the property value is console_special_key::control_c) or Ctrl+Break (the property value is console_special_key.control_break).
• Cancel, which allows you to determine how to your application should respond to the user pressing Ctrl+C or Ctrl+Break. By default, the cancel property is false, which causes program execution to terminate when the event handler exits. Changing its property to true specifies that the application should continue to execute.

Note

If your application has simple requirements, you can use the treat_control_c_as_input property instead of this event. By setting this property to false, you can ensure that your application always exits if the user presses Ctrl+C. By setting it to true, you can ensure that pressing Ctrl+C will not terminate the application.

Warning

The xtd::signal::interrupt and xtd::console_special_key::control_c use the same signal (SIGINT).

The xtd::signal::interrupt and xtd::console_special_key::control_c can be cancelled with xtd::environment::cancel_signal event or xtd::console::cancel_key_press event. Both of these events are called when SIGINT is raised.

Examples:

console_read_key.cpp.

error

std::ostream xtd::console::error

static

Gets the error output stream. A std::basic_ostream<char_t> that represents the error output stream.

Examples:

delegate_multicast.cpp.

in

std::istream xtd::console::in

static

Gets the standard input stream. A std::basic_istream<char_t> that represents the standard input stream.

Examples

The following sample illustrates the use of the in property.

#include <xtd/console>

using namespace std;
using namespace xtd;

auto main()->int {
  auto& is = console::in;
  auto& os = console::out;
  
  os << "Ola Mundo!" << endl;
  os << "What is your name: ";
  auto name = ustring::empty_string;
  is >> name;
  
  os << "Buenos Dias, " << name << endl;
}

// This code produces the following output:
//
// Ola Mundo!
// What is your name: James
// Buenos Dias, James!

out

std::ostream xtd::console::out

static

Gets the standard output stream. A std::basic_ostream<char_t> that represents the standard output stream.

Examples

The following sample illustrates the use of the out property.

#include <xtd/console>

using namespace std;
using namespace xtd;

auto main()->int {
  auto& is = console::in;
  auto& os = console::out;
  
  os << "Ola Mundo!" << endl;
  os << "What is your name: ";
  auto name = ustring::empty_string;
  is >> name;
  
  os << "Buenos Dias, " << name << endl;
}

// This code produces the following output:
//
// Ola Mundo!
// What is your name: James
// Buenos Dias, James!

Examples:

console_background_color2.cpp, console_beep2.cpp, console_out.cpp, delegate_lambda.cpp, delegate_multicast.cpp, event.cpp, hello_world_environment2.cpp, and hello_world_ustring.cpp.

---

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

• xtd.core/include/xtd/console.h