Sista v3.0.0-alpha.1
Sista is a C++ lightweight OS-agnostic library for terminal animations and videogames
Loading...
Searching...
No Matches
Classes | Namespaces | Macros | Enumerations | Functions
cursor.hpp File Reference

Cursor manipulation header file. More...

#include "ansi.hpp"
#include "coordinates.hpp"
Include dependency graph for cursor.hpp:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  sista::Cursor
 Manages terminal cursor operations. More...
 

Namespaces

namespace  sista
 Sista library namespace.
 

Macros

#define CHA   'H'
 Cursor Horizontal Absolute ANSI command character.
 
#define VPA   'd'
 Vertical Position Absolute ANSI command character.
 

Enumerations

enum class  sista::EraseScreen : int { sista::FROM_CURSOR_TO_END = 0 , sista::FROM_CURSOR_TO_BEGINNING = 1 , sista::ENTIRE_SCREEN = 2 , sista::ERASE_SAVED_LINES = 3 }
 Enumeration for screen erasure options in ANSI escape codes. More...
 
enum class  sista::EraseLine : int { sista::LINE_FROM_CURSOR_TO_END = 0 , sista::LINE_FROM_CURSOR_TO_BEGINNING = 1 , sista::ENTIRE_LINE = 2 }
 Enumeration for line erasure options in ANSI escape codes. More...
 
enum class  sista::MoveCursor : char {
  sista::UP = 'A' , sista::DOWN = 'B' , sista::RIGHT = 'C' , sista::LEFT = 'D' ,
  sista::BEGINNING_OF_NEXT_LINE = 'E' , sista::BEGINNING_OF_PREVIOUS_LINE = 'F' , sista::HORIZONTAL_ABSOLUTE = 'G'
}
 Enumeration for cursor movement directions in ANSI escape codes. More...
 
enum class  sista::MoveCursorDEC : int { sista::SAVE_CURSOR_POSITION = 7 , sista::RESTORE_CURSOR_POSITION = 8 }
 Enumeration for DEC-specific cursor movement commands in ANSI escape codes. More...
 
enum class  sista::MoveCursorSCO : char { sista::SCO_SAVE_CURSOR_POSITION = 's' , sista::SCO_RESTORE_CURSOR_POSITION = 'u' }
 Enumeration for SCO-specific cursor movement commands in ANSI escape codes. More...
 

Functions

void sista::clearScreen (bool spaces=true)
 Clears the terminal screen and optionally the scrollback buffer.
 

Detailed Description

Cursor manipulation header file.

This file contains the declaration of the Cursor class and related enums for terminal cursor manipulation.

Author
FLAK-ZOSO
Date
2022-2025
Version
3.0.0
See also
Cursor

Macro Definition Documentation

◆ CHA

#define CHA   'H'

Cursor Horizontal Absolute ANSI command character.

This macro defines the command character used in ANSI escape codes to move the cursor horizontally to an absolute position. It is represented as a character literal 'H'.

See also
VPA

◆ VPA

#define VPA   'd'

Vertical Position Absolute ANSI command character.

This macro defines the command character used in ANSI escape codes to move the cursor vertically to an absolute position. It is represented as a character literal 'd'.

See also
CHA