- Your Widget Set For OpenGL
Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Related Pages

ufo::UCaret Class Reference

A Caret represents a text cursor within a document. More...

#include <ucaret.hpp>

Inheritance diagram for ufo::UCaret:

ufo::UObject ufo::UCollectable ufo::UBasicCaret List of all members.

Public Types

typedef USignal3< UCaret *,
unsigned int, unsigned int > 
CaretSignal

Public Member Functions

virtual void setPosition (unsigned int posA)=0
virtual unsigned int getPosition () const =0
virtual void setMark (unsigned int mark)=0
virtual unsigned int getMark () const =0
virtual void movePosition (unsigned int newPosition)=0
virtual UDocumentgetDocument () const =0
CaretSignal & sigPositionChanged ()

Detailed Description

A Caret represents a text cursor within a document.

Further it supports basic selection features via a position and a mark handle.

Author:
Johannes Schmidt


Member Function Documentation

virtual unsigned int ufo::UCaret::getMark  )  const [pure virtual]
 

The mark is a second text mark which is used to select regions. A region is selected between the caret position and the caret mark.

Implemented in ufo::UBasicCaret.

virtual void ufo::UCaret::movePosition unsigned int  newPosition  )  [pure virtual]
 

Moves the cursor position from its current pos to the new pos, leaving a mark behind it (i.e. selecting the text).

Implemented in ufo::UBasicCaret.

virtual void ufo::UCaret::setMark unsigned int  mark  )  [pure virtual]
 

Explicitely sets the mark. Generally, you should use movePosition.

See also:
movePosition

Implemented in ufo::UBasicCaret.

virtual void ufo::UCaret::setPosition unsigned int  posA  )  [pure virtual]
 

Sets the position. The position is the actual place of the caret and the insertion point for charaters in the text widget.

Implemented in ufo::UBasicCaret.

UCaret::CaretSignal & ufo::UCaret::sigPositionChanged  )  [inline]
 

caret is the caret, first int the position, 2nd the mark


The documentation for this class was generated from the following file:
The libUFO Project - written by Johannes Schmidt