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 string& 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!