cursor_symbols::Cursor Class Reference

Simple library for doing things involving moving the curser when producing terminal output. More...

#include <cursor.hpp>

Collaboration diagram for cursor_symbols::Cursor:

Static Public Member Functions
static string	up (uint8_t n)
static string	down (uint8_t n)
static string	right (uint8_t n)
static string	left (uint8_t n)
static string	down_n_lines (uint8_t n)
static string	up_n_lines (uint8_t n)
static string	to_column (uint8_t n)
static string	to (uint8_t n, uint8_t m)
static string	erase_display (uint8_t n)
static string	erase_line (uint8_t n)

Static Private Attributes
static string	ESC = "\033["

Detailed Description

Simple library for doing things involving moving the curser when producing terminal output.

This is achieved using ANSI escape codes, see:

https://en.wikipedia.org/wiki/ANSI_escape_code#CSIsection

That page is hard to decipher. Suffice to say that the left-hand-side of the table for "CSI introducers" is interpreted as follows:

\033[ n A - move curser n places up. \033[ n B - move curser n places down.

... and so on. Colours are then the "Set Graphic Rendition" part that appears as "CSI n m" and translates to ""\033[ n m".

Definition at line 54 of file cursor.hpp.

Constructor & Destructor Documentation

Cursor()

cursor_symbols::Cursor::Cursor ( )

inline

Definition at line 58 of file cursor.hpp.

{};

Member Function Documentation

down()

static string cursor_symbols::Cursor::down ( uint8_t n )

inlinestatic

Definition at line 69 of file cursor.hpp.

                                  {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "B";
      }
      return s;
    }

down_n_lines()

static string cursor_symbols::Cursor::down_n_lines ( uint8_t n )

inlinestatic

Definition at line 96 of file cursor.hpp.

                                          {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "E";
      }
      return s;
    }

erase_display()

static string cursor_symbols::Cursor::erase_display ( uint8_t n )

inlinestatic

0 - to screen end. 1 - to screen beginning. 2 - whole screen. 3 - 2 + erase scrolling back buffer.

Definition at line 143 of file cursor.hpp.

                                           {
      string s;
      if (n >= 0) {
        s += ESC;
        s += to_string(n);
        s += "J";
      }
      return s;
    }

erase_line()

static string cursor_symbols::Cursor::erase_line ( uint8_t n )

inlinestatic

0 - to end. 1 - to beginning. 2 - whole line.

Definition at line 157 of file cursor.hpp.

                                        {
      string s;
      if (n >= 0) {
        s += ESC;
        s += to_string(n);
        s += "K";
      }
      return s;
    }

left()

static string cursor_symbols::Cursor::left ( uint8_t n )

inlinestatic

Definition at line 87 of file cursor.hpp.

                                  {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "D";
      }
      return s;
    }

right()

static string cursor_symbols::Cursor::right ( uint8_t n )

inlinestatic

Definition at line 78 of file cursor.hpp.

                                   {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "C";
      }
      return s;
    }

to()

static string cursor_symbols::Cursor::to ( uint8_t n, uint8_t m )

inlinestatic

Origin is top left corner. n is row and m is column.

Definition at line 126 of file cursor.hpp.

                                           {
      string s;
      if (n >= 1 && m >= 1) {
        s += ESC;
        s += to_string(n);
        s += ";";
        s += to_string(m);
        s += "H";
      }
      return s;
    }

to_column()

static string cursor_symbols::Cursor::to_column ( uint8_t n )

inlinestatic

Definition at line 114 of file cursor.hpp.

                                       {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "G";
      }
      return s;
    }

up()

static string cursor_symbols::Cursor::up ( uint8_t n )

inlinestatic

Definition at line 60 of file cursor.hpp.

                                {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "A";
      }
      return s;
    }

up_n_lines()

static string cursor_symbols::Cursor::up_n_lines ( uint8_t n )

inlinestatic

Definition at line 105 of file cursor.hpp.

                                        {
      string s;
      if (n >= 1) {
        s += ESC;
        s += to_string(n);
        s += "F";
      }
      return s;
    }

Member Data Documentation

ESC

string cursor_symbols::Cursor::ESC = "\033["

staticprivate

Definition at line 56 of file cursor.hpp.

---

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

• /Users/sbh11/Desktop/connection-prover/c++/connect++/v0.5.0/source/utilities/cursor.hpp
• /Users/sbh11/Desktop/connection-prover/c++/connect++/v0.5.0/source/utilities/cursor.cpp