TextCursor Class Reference

Cursor position within a text run More...

#include <cc/TextCursor>

Inheritance diagram for TextCursor:

Public Member Functions
	TextCursor ()=default
	Create a null text cursor.
Point	posA () const
	Above baseline position.
Point	posB () const
	Below baseline position.
int	offset () const
	Byte offset within the text
TextCursor	copy () const
	Get a deep copy of this cursor.
int	step (int steps)
	Step forward (steps > 0) or backward (steps < 0)
int	lineStep (int steps)
	Step lines forward (steps > 0) or backward (steps < 0)
void	assign (const TextCursor &other)
	Assign a deep-copy of other.
bool	operator== (const TextCursor &b) const
	Equal to operator.
bool	operator!= (const TextCursor &b) const
	Not equal to operator.
Public Member Functions inherited from Object
	Object ()=default
	Create a null object.
	operator bool () const
	Check if this is a non-null object.
bool	isNull () const
	Check if this is a null object.
template<class T >
bool	is () const
	Check if this object is of type T.
template<class T >
T	as () const
	Cast this object to type T.
bool	isWeak () const
	Check if the underlying object reference is weak.
bool	operator== (const Object &other) const
	Equality operator.
std::strong_ordering	operator<=> (const Object &other) const
	Ordering operator.
long	useCount () const
	Reference count.

Protected Member Functions
	TextCursor (State *newState)
State &	me ()
const State &	me () const
Protected Member Functions inherited from Object
template<class T >
T	weak () const
template<class T >
void	initOnce ()
	Create the object state when called the first time.
template<class T >
void	initOncePerThread ()
	Create a distinct object state for each thread when called the first time in that thread.
	Object (State *newState)
	Initialize object with newState.
	Object (State *state, Alias)
	Object (State *state, Weak)
Object &	operator= (std::nullptr_t)

Additional Inherited Members
Static Protected Member Functions inherited from Object
template<class T >
static T	alias (const State *state)
	Create an alias object for the given state.
template<class T >
static T	weak (const State *state)
Protected Attributes inherited from Object
Handle< State >	me
	Internal object state

Detailed Description

Cursor position within a text run

Constructor & Destructor Documentation

TextCursor()

TextCursor ( )

default

Create a null text cursor.

Member Function Documentation

posA()

Point posA

(

)

const

Above baseline position.

posB()

Point posB

(

)

const

Below baseline position.

offset()

int offset

(

)

const

Byte offset within the text

copy()

TextCursor copy

(

)

const

Get a deep copy of this cursor.

step()

int step

(

int

steps

)

Step forward (steps > 0) or backward (steps < 0)

lineStep()

int lineStep

(

int

steps

)

Step lines forward (steps > 0) or backward (steps < 0)

assign()

void assign

(

const TextCursor &

other

)

Assign a deep-copy of other.

operator==()

bool operator==

(

const TextCursor &

b

)

const

Equal to operator.

operator!=()

bool operator!=

(

const TextCursor &

b

)

const

Not equal to operator.