\section{Kate\-Super\-Cursor Class Reference}
\label{classKateSuperCursor}\index{KateSuperCursor@{KateSuperCursor}}
A cursor which updates and gives off various interesting signals.  


{\tt \#include $<$katesupercursor.h$>$}

Inheritance diagram for Kate\-Super\-Cursor:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=96pt]{classKateSuperCursor__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for Kate\-Super\-Cursor:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=96pt]{classKateSuperCursor__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf position\-Directly\-Changed} ()
\item 
void {\bf position\-Changed} ()
\item 
void {\bf position\-Un\-Changed} ()
\item 
void {\bf position\-Deleted} ()
\item 
void {\bf char\-Inserted\-At} ()
\item 
void {\bf char\-Deleted\-Before} ()
\item 
void {\bf char\-Deleted\-After} ()
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Kate\-Super\-Cursor} (Kate\-Document $\ast$doc, bool private\-C, const {\bf Kate\-Text\-Cursor} \&cursor, {\bf QObject} $\ast${\bf parent}=0L, const char $\ast${\bf name}=0L)
\item 
{\bf Kate\-Super\-Cursor} (Kate\-Document $\ast$doc, bool private\-C, int line\-Num=0, int col=0, {\bf QObject} $\ast${\bf parent}=0L, const char $\ast${\bf name}=0L)\label{classKateSuperCursor_a1}

\item 
void {\bf position} (uint $\ast$line, uint $\ast$col) const \label{classKateSuperCursor_a3}

\item 
bool {\bf set\-Position} (uint line, uint col)\label{classKateSuperCursor_a4}

\item 
bool {\bf insert\-Text} (const {\bf QString} \&text)\label{classKateSuperCursor_a5}

\item 
bool {\bf remove\-Text} (uint number\-Of\-Characters)\label{classKateSuperCursor_a6}

\item 
{\bf QChar} {\bf current\-Char} () const \label{classKateSuperCursor_a7}

\item 
bool {\bf at\-Start\-Of\-Line} () const 
\item 
bool {\bf at\-End\-Of\-Line} () const 
\item 
bool {\bf move\-On\-Insert} () const 
\item 
void {\bf set\-Move\-On\-Insert} (bool move\-On\-Insert)
\item 
{\bf operator QString} ()
\item 
virtual void {\bf set\-Line} (int line\-Num)\label{classKateSuperCursor_a13}

\item 
virtual void {\bf set\-Col} (int col\-Num)\label{classKateSuperCursor_a14}

\item 
virtual void {\bf set\-Pos} (const {\bf Kate\-Text\-Cursor} \&pos)\label{classKateSuperCursor_a15}

\item 
virtual void {\bf set\-Pos} (int line\-Num, int col\-Num)\label{classKateSuperCursor_a16}

\item 
void {\bf edit\-Text\-Inserted} (uint line, uint col, uint len)\label{classKateSuperCursor_a17}

\item 
void {\bf edit\-Text\-Removed} (uint line, uint col, uint len)\label{classKateSuperCursor_a18}

\item 
void {\bf edit\-Line\-Wrapped} (uint line, uint col, bool new\-Line=true)\label{classKateSuperCursor_a19}

\item 
void {\bf edit\-Line\-Un\-Wrapped} (uint line, uint col, bool remove\-Line=true, uint length=0)\label{classKateSuperCursor_a20}

\item 
void {\bf edit\-Line\-Inserted} (uint line)\label{classKateSuperCursor_a21}

\item 
void {\bf edit\-Line\-Removed} (uint line)\label{classKateSuperCursor_a22}

\end{CompactItemize}


\subsection{Detailed Description}
A cursor which updates and gives off various interesting signals. 

This aims to be a working version of what Kate\-Cursor was originally intended to be.

\begin{Desc}
\item[Author:]Hamish Rodda \end{Desc}




Definition at line 45 of file katesupercursor.h.

\subsection{Constructor \& Destructor Documentation}
\index{KateSuperCursor@{Kate\-Super\-Cursor}!KateSuperCursor@{KateSuperCursor}}
\index{KateSuperCursor@{KateSuperCursor}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Super\-Cursor::Kate\-Super\-Cursor (Kate\-Document $\ast$ {\em doc}, bool {\em private\-C}, const {\bf Kate\-Text\-Cursor} \& {\em cursor}, {\bf QObject} $\ast$ {\em parent} = {\tt 0L}, const char $\ast$ {\em name} = {\tt 0L})}\label{classKateSuperCursor_a0}


bool private\-C says: if private, than don't show to apps using the cursorinterface in the list, all internally only used Super\-Cursors should be private or people could modify them from the outside breaking kate's internals 



Definition at line 28 of file katesupercursor.cpp.

\subsection{Member Function Documentation}
\index{KateSuperCursor@{Kate\-Super\-Cursor}!atStartOfLine@{atStartOfLine}}
\index{atStartOfLine@{atStartOfLine}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Super\-Cursor::at\-Start\-Of\-Line () const}\label{classKateSuperCursor_a8}


\begin{Desc}
\item[Returns:]true if the cursor is situated at the start of the line, false if it isn't. \end{Desc}


Definition at line 85 of file katesupercursor.cpp.

Referenced by Kate\-Super\-Range::includes\-Whole\-Line().\index{KateSuperCursor@{Kate\-Super\-Cursor}!atEndOfLine@{atEndOfLine}}
\index{atEndOfLine@{atEndOfLine}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Super\-Cursor::at\-End\-Of\-Line () const}\label{classKateSuperCursor_a9}


\begin{Desc}
\item[Returns:]true if the cursor is situated at the end of the line, false if it isn't. \end{Desc}


Definition at line 90 of file katesupercursor.cpp.

Referenced by Kate\-Super\-Range::includes\-Whole\-Line().\index{KateSuperCursor@{Kate\-Super\-Cursor}!moveOnInsert@{moveOnInsert}}
\index{moveOnInsert@{moveOnInsert}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Kate\-Super\-Cursor::move\-On\-Insert () const}\label{classKateSuperCursor_a10}


Returns how this cursor behaves when text is inserted at the cursor. 

Defaults to not moving on insert. 

Definition at line 95 of file katesupercursor.cpp.

Referenced by Kate\-Super\-Range::behaviour().\index{KateSuperCursor@{Kate\-Super\-Cursor}!setMoveOnInsert@{setMoveOnInsert}}
\index{setMoveOnInsert@{setMoveOnInsert}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::set\-Move\-On\-Insert (bool {\em move\-On\-Insert})}\label{classKateSuperCursor_a11}


Change the behavior of the cursor when text is inserted at the cursor. 

If {\tt move\-On\-Insert} is true, the cursor will end up at the end of the insert. 

Definition at line 100 of file katesupercursor.cpp.

Referenced by Kate\-Super\-Range::set\-Behaviour().\index{KateSuperCursor@{Kate\-Super\-Cursor}!operator QString@{operator QString}}
\index{operator QString@{operator QString}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Kate\-Super\-Cursor::operator {\bf QString} ()}\label{classKateSuperCursor_a12}


Debug: output the position. 



Definition at line 270 of file katesupercursor.cpp.\index{KateSuperCursor@{Kate\-Super\-Cursor}!positionDirectlyChanged@{positionDirectlyChanged}}
\index{positionDirectlyChanged@{positionDirectlyChanged}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::position\-Directly\-Changed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l0}


The cursor's position was directly changed by the program. 

\index{KateSuperCursor@{Kate\-Super\-Cursor}!positionChanged@{positionChanged}}
\index{positionChanged@{positionChanged}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::position\-Changed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l1}


The cursor's position was changed. 

\index{KateSuperCursor@{Kate\-Super\-Cursor}!positionUnChanged@{positionUnChanged}}
\index{positionUnChanged@{positionUnChanged}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::position\-Un\-Changed ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l2}


Athough an edit took place, the cursor's position was unchanged. 

\index{KateSuperCursor@{Kate\-Super\-Cursor}!positionDeleted@{positionDeleted}}
\index{positionDeleted@{positionDeleted}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::position\-Deleted ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l3}


The cursor's surrounding characters were both deleted simultaneously. 

The cursor is automatically placed at the start of the deleted region. \index{KateSuperCursor@{Kate\-Super\-Cursor}!charInsertedAt@{charInsertedAt}}
\index{charInsertedAt@{charInsertedAt}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::char\-Inserted\-At ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l4}


A character was inserted immediately before the cursor. 

Whether the char was inserted before or after this cursor depends on {\bf move\-On\-Insert()}{\rm (p.\,\pageref{classKateSuperCursor_a10})}: \begin{itemize}
\item true -$>$ the char was inserted before \item false -$>$ the char was inserted after \end{itemize}
\index{KateSuperCursor@{Kate\-Super\-Cursor}!charDeletedBefore@{charDeletedBefore}}
\index{charDeletedBefore@{charDeletedBefore}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::char\-Deleted\-Before ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l5}


The character immediately before the cursor was deleted. 

\index{KateSuperCursor@{Kate\-Super\-Cursor}!charDeletedAfter@{charDeletedAfter}}
\index{charDeletedAfter@{charDeletedAfter}!KateSuperCursor@{Kate\-Super\-Cursor}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Kate\-Super\-Cursor::char\-Deleted\-After ()\hspace{0.3cm}{\tt  [signal]}}\label{classKateSuperCursor_l6}


The character immediately after the cursor was deleted. 



The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
katesupercursor.h\item 
katesupercursor.cpp\end{CompactItemize}
