ttx::terminal::CursorPositionReport Struct Reference

Cursor position report. More...

#include <ttx/terminal/escapes/device_status.h>

Public Member Functions
auto	serialize () const -> di::String
auto	operator== (CursorPositionReport const &other) const -> bool=default

Static Public Member Functions
static auto	from_csi (CSI const &csi) -> di::Optional< CursorPositionReport >

Public Attributes
u32	row { 0 }
u32	col { 0 }

Friends
constexpr friend auto	tag_invoke (di::Tag< di::reflect >, di::InPlaceType< CursorPositionReport >)

Detailed Description

Cursor position report.

This is requested by DSR 6, returning the current position of the cursor. This can be used by application to determine how the terminal handles certain unicode strings, as well as escape sequences like OSC 66. The serialized row and column values are 1-indexed, but stored as 0-indexed values.

This is specified here.

Member Function Documentation

from_csi()

auto ttx::terminal::CursorPositionReport::from_csi ( CSI const & csi ) -> di::Optional<CursorPositionReport>

static

operator==()

auto ttx::terminal::CursorPositionReport::operator== ( CursorPositionReport const & other ) const -> bool=default

default

serialize()

auto ttx::terminal::CursorPositionReport::serialize

(

)

const -> di::String

Friends And Related Symbol Documentation

tag_invoke

friend auto tag_invoke ( di::Tag< di::reflect > , di::InPlaceType< CursorPositionReport >  )

friend

Member Data Documentation

col

u32 ttx::terminal::CursorPositionReport::col { 0 }

row

u32 ttx::terminal::CursorPositionReport::row { 0 }

---

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

• ttx/terminal/escapes/device_status.h
• lib/src/terminal/escapes/device_status.cpp