.TH "KateSuperCursor" kde3 "11 Jun 2005" "Version Version 3.4.1" "kate Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KateSuperCursor \- A cursor which updates and gives off various interesting signals.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <katesupercursor.h>\fP
.PP
Inherits \fBQObject\fP, \fBKateDocCursor\fP, and Kate::Cursor.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBpositionDirectlyChanged\fP ()"
.br
.ti -1c
.RI "void \fBpositionChanged\fP ()"
.br
.ti -1c
.RI "void \fBpositionUnChanged\fP ()"
.br
.ti -1c
.RI "void \fBpositionDeleted\fP ()"
.br
.ti -1c
.RI "void \fBcharInsertedAt\fP ()"
.br
.ti -1c
.RI "void \fBcharDeletedBefore\fP ()"
.br
.ti -1c
.RI "void \fBcharDeletedAfter\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKateSuperCursor\fP (KateDocument *doc, bool privateC, const \fBKateTextCursor\fP &cursor, \fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "\fBKateSuperCursor\fP (KateDocument *doc, bool privateC, int lineNum=0, int col=0, \fBQObject\fP *\fBparent\fP=0L, const char *\fBname\fP=0L)"
.br
.ti -1c
.RI "void \fBposition\fP (uint *line, uint *col) const "
.br
.ti -1c
.RI "bool \fBsetPosition\fP (uint line, uint col)"
.br
.ti -1c
.RI "bool \fBinsertText\fP (const \fBQString\fP &text)"
.br
.ti -1c
.RI "bool \fBremoveText\fP (uint numberOfCharacters)"
.br
.ti -1c
.RI "\fBQChar\fP \fBcurrentChar\fP () const "
.br
.ti -1c
.RI "bool \fBatStartOfLine\fP () const "
.br
.ti -1c
.RI "bool \fBatEndOfLine\fP () const "
.br
.ti -1c
.RI "bool \fBmoveOnInsert\fP () const "
.br
.ti -1c
.RI "void \fBsetMoveOnInsert\fP (bool moveOnInsert)"
.br
.ti -1c
.RI "\fBoperator QString\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetLine\fP (int lineNum)"
.br
.ti -1c
.RI "virtual void \fBsetCol\fP (int colNum)"
.br
.ti -1c
.RI "virtual void \fBsetPos\fP (const \fBKateTextCursor\fP &pos)"
.br
.ti -1c
.RI "virtual void \fBsetPos\fP (int lineNum, int colNum)"
.br
.ti -1c
.RI "void \fBeditTextInserted\fP (uint line, uint col, uint len)"
.br
.ti -1c
.RI "void \fBeditTextRemoved\fP (uint line, uint col, uint len)"
.br
.ti -1c
.RI "void \fBeditLineWrapped\fP (uint line, uint col, bool newLine=true)"
.br
.ti -1c
.RI "void \fBeditLineUnWrapped\fP (uint line, uint col, bool removeLine=true, uint length=0)"
.br
.ti -1c
.RI "void \fBeditLineInserted\fP (uint line)"
.br
.ti -1c
.RI "void \fBeditLineRemoved\fP (uint line)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A cursor which updates and gives off various interesting signals. 

This aims to be a working version of what KateCursor was originally intended to be.
.PP
\fBAuthor:\fP
.RS 4
Hamish Rodda 
.RE
.PP

.PP
Definition at line 45 of file katesupercursor.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KateSuperCursor::KateSuperCursor (KateDocument * doc, bool privateC, const \fBKateTextCursor\fP & cursor, \fBQObject\fP * parent = \fC0L\fP, const char * name = \fC0L\fP)"
.PP
bool privateC says: if private, than don't show to apps using the cursorinterface in the list, all internally only used SuperCursors should be private or people could modify them from the outside breaking kate's internals 
.PP
Definition at line 28 of file katesupercursor.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KateSuperCursor::atStartOfLine () const"
.PP
\fBReturns:\fP
.RS 4
true if the cursor is situated at the start of the line, false if it isn't. 
.RE
.PP

.PP
Definition at line 85 of file katesupercursor.cpp.
.PP
Referenced by KateSuperRange::includesWholeLine().
.SS "bool KateSuperCursor::atEndOfLine () const"
.PP
\fBReturns:\fP
.RS 4
true if the cursor is situated at the end of the line, false if it isn't. 
.RE
.PP

.PP
Definition at line 90 of file katesupercursor.cpp.
.PP
Referenced by KateSuperRange::includesWholeLine().
.SS "bool KateSuperCursor::moveOnInsert () const"
.PP
Returns how this cursor behaves when text is inserted at the cursor. 
.PP
Defaults to not moving on insert. 
.PP
Definition at line 95 of file katesupercursor.cpp.
.PP
Referenced by KateSuperRange::behaviour().
.SS "void KateSuperCursor::setMoveOnInsert (bool moveOnInsert)"
.PP
Change the behavior of the cursor when text is inserted at the cursor. 
.PP
If \fCmoveOnInsert\fP is true, the cursor will end up at the end of the insert. 
.PP
Definition at line 100 of file katesupercursor.cpp.
.PP
Referenced by KateSuperRange::setBehaviour().
.SS "KateSuperCursor::operator \fBQString\fP ()"
.PP
Debug: output the position. 
.PP
Definition at line 270 of file katesupercursor.cpp.
.SS "void KateSuperCursor::positionDirectlyChanged ()\fC [signal]\fP"
.PP
The cursor's position was directly changed by the program. 
.PP
.SS "void KateSuperCursor::positionChanged ()\fC [signal]\fP"
.PP
The cursor's position was changed. 
.PP
.SS "void KateSuperCursor::positionUnChanged ()\fC [signal]\fP"
.PP
Athough an edit took place, the cursor's position was unchanged. 
.PP
.SS "void KateSuperCursor::positionDeleted ()\fC [signal]\fP"
.PP
The cursor's surrounding characters were both deleted simultaneously. 
.PP
The cursor is automatically placed at the start of the deleted region. 
.SS "void KateSuperCursor::charInsertedAt ()\fC [signal]\fP"
.PP
A character was inserted immediately before the cursor. 
.PP
Whether the char was inserted before or after this cursor depends on \fBmoveOnInsert()\fP: 
.PD 0

.IP "\(bu" 2
true -> the char was inserted before 
.IP "\(bu" 2
false -> the char was inserted after 
.PP

.SS "void KateSuperCursor::charDeletedBefore ()\fC [signal]\fP"
.PP
The character immediately before the cursor was deleted. 
.PP
.SS "void KateSuperCursor::charDeletedAfter ()\fC [signal]\fP"
.PP
The character immediately after the cursor was deleted. 
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kate Library from the source code.
