\section{KText\-Editor::Edit\-DCOPInterface Class Reference}
\label{classKTextEditor_1_1EditDCOPInterface}\index{KTextEditor::EditDCOPInterface@{KTextEditor::EditDCOPInterface}}
This is the main interface to the {\bf Edit\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface})} of {\bf KText\-Edit}. DCOP interface to {\bf Edit\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface})}.  


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

Inheritance diagram for KText\-Editor::Edit\-DCOPInterface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=104pt]{classKTextEditor_1_1EditDCOPInterface__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KText\-Editor::Edit\-DCOPInterface:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=134pt]{classKTextEditor_1_1EditDCOPInterface__coll__graph}
\end{center}
\end{figure}
\subsection*{DCOP Member Functions}
\begin{CompactItemize}
\item 
virtual {\bf QString} {\bf text} ()
\item 
virtual {\bf QString} {\bf text\-Line} (uint line)
\item 
virtual int {\bf num\-Lines} ()
\item 
virtual int {\bf length} ()
\item 
virtual void {\bf set\-Text} (const  {\bf QString} \&text)
\begin{CompactList}\small\item\em Set the given text into the view. \item\end{CompactList}\item 
virtual bool {\bf insert\-Text} (uint line, uint col, const  {\bf QString} \&text)
\begin{CompactList}\small\item\em Inserts text at line \char`\"{}line\char`\"{}, column \char`\"{}col\char`\"{} returns true if success. \item\end{CompactList}\item 
virtual bool {\bf remove\-Text} (uint start\-Line, uint start\-Col, uint end\-Line, uint end\-Col)
\begin{CompactList}\small\item\em remove text at line \char`\"{}line\char`\"{}, column \char`\"{}col\char`\"{} returns true if success \item\end{CompactList}\item 
virtual bool {\bf insert\-Line} (uint line, const  {\bf QString} \&text)
\begin{CompactList}\small\item\em Insert line(s) at the given line number. \item\end{CompactList}\item 
virtual bool {\bf remove\-Line} (uint line)
\begin{CompactList}\small\item\em Insert line(s) at the given line number. \item\end{CompactList}\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf Edit\-DCOPInterface} ({\bf Edit\-Interface} $\ast$Parent, const  char $\ast$name)
\begin{CompactList}\small\item\em Construct a new interface object for the text editor. \item\end{CompactList}\item 
virtual {\bf $\sim$Edit\-DCOPInterface} ()
\begin{CompactList}\small\item\em Destructor Cleans up the object. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
This is the main interface to the {\bf Edit\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface})} of {\bf KText\-Edit}. DCOP interface to {\bf Edit\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface})}. 

This will provide a consistant dcop interface to all {\bf KDE} applications that use it. 

\begin{Desc}
\item[Author:]Ian Reinhart Geiser $<${\tt geiseri@kde.org}$>$ \end{Desc}




Definition at line 18 of file editdcopinterface.h.

\subsection{Constructor \& Destructor Documentation}
\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!EditDCOPInterface@{EditDCOPInterface}}
\index{EditDCOPInterface@{EditDCOPInterface}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Edit\-DCOPInterface::Edit\-DCOPInterface ({\bf Edit\-Interface} $\ast$ {\em Parent}, const char $\ast$ {\em name})}\label{classKTextEditor_1_1EditDCOPInterface_a0}


Construct a new interface object for the text editor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em Parent\-Edit\-Interface}]- The parent {\bf Edit\-Interface}{\rm (p.\,\pageref{classKTextEditor_1_1EditInterface})} object that will provide us with the functions for the interface. \end{description}
\end{Desc}


Definition at line 7 of file editdcopinterface.cpp.

References KStd\-Accel::name().\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!~EditDCOPInterface@{$\sim$EditDCOPInterface}}
\index{~EditDCOPInterface@{$\sim$EditDCOPInterface}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}Edit\-DCOPInterface::$\sim${\bf Edit\-DCOPInterface} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_a1}


Destructor Cleans up the object. 



Definition at line 13 of file editdcopinterface.cpp.

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


\begin{Desc}
\item[Returns:]the complete document as a single {\bf QString} \end{Desc}


Definition at line 18 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!textLine@{textLine}}
\index{textLine@{textLine}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} Edit\-DCOPInterface::text\-Line (uint {\em line})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z1}


\begin{Desc}
\item[Returns:]All the text from the requested line. \end{Desc}


Definition at line 23 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!numLines@{numLines}}
\index{numLines@{numLines}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Edit\-DCOPInterface::num\-Lines ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z2}


\begin{Desc}
\item[Returns:]The current number of lines in the document \end{Desc}


Definition at line 28 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!length@{length}}
\index{length@{length}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int Edit\-DCOPInterface::length ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z3}


\begin{Desc}
\item[Returns:]the number of characters in the document \end{Desc}


Definition at line 33 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!setText@{setText}}
\index{setText@{setText}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Edit\-DCOPInterface::set\-Text (const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z4}


Set the given text into the view. 

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

Definition at line 38 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!insertText@{insertText}}
\index{insertText@{insertText}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Edit\-DCOPInterface::insert\-Text (uint {\em line}, uint {\em col}, const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z5}


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



Definition at line 43 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!removeText@{removeText}}
\index{removeText@{removeText}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Edit\-DCOPInterface::remove\-Text (uint {\em start\-Line}, uint {\em start\-Col}, uint {\em end\-Line}, uint {\em end\-Col})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z6}


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



Definition at line 48 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!insertLine@{insertLine}}
\index{insertLine@{insertLine}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Edit\-DCOPInterface::insert\-Line (uint {\em line}, const {\bf QString} \& {\em text})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z7}


Insert line(s) at the given line number. 



Definition at line 53 of file editdcopinterface.cpp.\index{KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}!removeLine@{removeLine}}
\index{removeLine@{removeLine}!KTextEditor::EditDCOPInterface@{KText\-Editor::Edit\-DCOPInterface}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool Edit\-DCOPInterface::remove\-Line (uint {\em line})\hspace{0.3cm}{\tt  [virtual]}}\label{classKTextEditor_1_1EditDCOPInterface_z8}


Insert line(s) at the given line number. 

If only one line is in the current document, remove\-Line will fail (return false) 

Definition at line 58 of file editdcopinterface.cpp.

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