cursor.hpp

Go to the documentation of this file.

/*
* cpp-terminal
* C++ library for writing multi-platform terminal applications.
*
* SPDX-FileCopyrightText: 2019-2025 cpp-terminal
*
* SPDX-License-Identifier: MIT
*/
 
#pragma once
 
#include "cpp-terminal/position.hpp"
 
#include <string>
 
namespace Term
{
 
class Cursor
{
public:
  Cursor() = default;
  explicit Cursor(const Position& position);
  std::size_t row() const;
  std::size_t column() const;
  bool        empty() const;
  bool        operator==(const Term::Cursor& cursor) const;
  bool        operator!=(const Term::Cursor& cursor) const;
 
private:
  Position m_position;
};
 
// returns the current cursor position (row, column) (Y, X)
Term::Cursor cursor_position();
 
// move the cursor to the given (row, column) / (Y, X)
std::string cursor_move(const std::size_t& row, const std::size_t& column);
// move the cursor the given rows up
std::string cursor_up(const std::size_t& rows);
// move the cursor the given rows down
std::string cursor_down(const std::size_t& rows);
// move the cursor the given columns left
std::string cursor_left(const std::size_t& columns);
// move the cursor the given columns right
std::string cursor_right(const std::size_t& columns);
// the ANSI code to generate a cursor position report
std::string cursor_position_report();
// turn off the cursor
std::string cursor_off();
// turn on the cursor
std::string cursor_on();
 
// clears the screen from the current cursor position to the end of the screen
std::string clear_eol();
 
}  // namespace Term