\section{KText\-Editor::Edit\-Interface Class Reference}
\label{classKTextEditor_1_1EditInterface}\index{KTextEditor::EditInterface@{KTextEditor::EditInterface}}
This is the main interface for accessing and modifying text of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class.  


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

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
uint {\bf edit\-Interface\-Number} () const \label{classKTextEditor_1_1EditInterface_a2}

\item 
virtual {\bf QString} {\bf text} () const =0
\item 
virtual {\bf QString} {\bf text} (uint start\-Line, uint start\-Col, uint end\-Line, uint end\-Col) const =0
\item 
virtual {\bf QString} {\bf text\-Line} (uint line) const =0
\item 
virtual uint {\bf num\-Lines} () const =0
\item 
virtual uint {\bf length} () const =0
\item 
virtual int {\bf line\-Length} (uint line) const =0
\item 
virtual bool {\bf set\-Text} (const {\bf QString} \&text)=0
\item 
virtual bool {\bf clear} ()=0
\item 
virtual bool {\bf insert\-Text} (uint line, uint col, const {\bf QString} \&text)=0
\item 
virtual bool {\bf remove\-Text} (uint start\-Line, uint start\-Col, uint end\-Line, uint end\-Col)=0
\item 
virtual bool {\bf insert\-Line} (uint line, const {\bf QString} \&text)=0
\item 
virtual bool {\bf remove\-Line} (uint line)=0
\item 
virtual void {\bf text\-Changed} ()=0
\item 
virtual void {\bf characters\-Interactively\-Inserted} (int, int, const {\bf QString} \&)=0\label{classKTextEditor_1_1EditInterface_a16}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
void {\bf set\-Edit\-Interface\-DCOPSuffix} (const {\bf QCString} \&suffix)\label{classKTextEditor_1_1EditInterface_b0}

\end{CompactItemize}
\subsection*{Friends}
\begin{CompactItemize}
\item 
class {\bf Private\-Edit\-Interface}\label{classKTextEditor_1_1EditInterface_n0}

\end{CompactItemize}


\subsection{Detailed Description}
This is the main interface for accessing and modifying text of the {\bf Document}{\rm (p.\,\pageref{classKTextEditor_1_1Document})} class. 



Definition at line 33 of file editinterface.h.

\subsection{Member Function Documentation}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!text@{text}}
\index{text@{text}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KText\-Editor::Edit\-Interface::text () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a3}


\begin{Desc}
\item[Returns:]the complete document as a single {\bf QString} \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!text@{text}}
\index{text@{text}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KText\-Editor::Edit\-Interface::text (uint {\em start\-Line}, uint {\em start\-Col}, uint {\em end\-Line}, uint {\em end\-Col}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a4}


\begin{Desc}
\item[Returns:]a {\bf QString} \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!textLine@{textLine}}
\index{textLine@{textLine}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf QString} KText\-Editor::Edit\-Interface::text\-Line (uint {\em line}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a5}


\begin{Desc}
\item[Returns:]All the text from the requested line. \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!numLines@{numLines}}
\index{numLines@{numLines}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual uint KText\-Editor::Edit\-Interface::num\-Lines () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a6}


\begin{Desc}
\item[Returns:]The current number of lines in the document \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!length@{length}}
\index{length@{length}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual uint KText\-Editor::Edit\-Interface::length () const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a7}


\begin{Desc}
\item[Returns:]the number of characters in the document \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!lineLength@{lineLength}}
\index{lineLength@{lineLength}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual int KText\-Editor::Edit\-Interface::line\-Length (uint {\em line}) const\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a8}


\begin{Desc}
\item[Returns:]the number of characters in the line (-1 if no line \char`\"{}line\char`\"{}) \end{Desc}
\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!setText@{setText}}
\index{setText@{setText}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::set\-Text (const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a9}


Set the given text into the view. 

Warning: This will overwrite any data currently held in this view. \index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!clear@{clear}}
\index{clear@{clear}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::clear ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a10}


clears the document Warning: This will overwrite any data currently held in this view. 

\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!insertText@{insertText}}
\index{insertText@{insertText}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::insert\-Text (uint {\em line}, uint {\em col}, const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a11}


Inserts text at line \char`\"{}line\char`\"{}, column \char`\"{}col\char`\"{} returns true if success Use insert\-Text({\bf num\-Lines()}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface_a6})}, ...) to append text at end of document. 

\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!removeText@{removeText}}
\index{removeText@{removeText}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::remove\-Text (uint {\em start\-Line}, uint {\em start\-Col}, uint {\em end\-Line}, uint {\em end\-Col})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a12}


remove text at line \char`\"{}line\char`\"{}, column \char`\"{}col\char`\"{} returns true if success 

\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!insertLine@{insertLine}}
\index{insertLine@{insertLine}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::insert\-Line (uint {\em line}, const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a13}


Insert line(s) at the given line number. 

Use insert\-Line({\bf num\-Lines()}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface_a6})}, text) to append line at end of document \index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!removeLine@{removeLine}}
\index{removeLine@{removeLine}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual bool KText\-Editor::Edit\-Interface::remove\-Line (uint {\em line})\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a14}


Remove line(s) at the given line number. 

\index{KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}!textChanged@{textChanged}}
\index{textChanged@{textChanged}!KTextEditor::EditInterface@{KText\-Editor::Edit\-Interface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void KText\-Editor::Edit\-Interface::text\-Changed ()\hspace{0.3cm}{\tt  [pure virtual]}}\label{classKTextEditor_1_1EditInterface_a15}


signals !!! 



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