.TH "KTextEditor::EditDCOPInterface" 3 "28 Jan 2004" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor::EditDCOPInterface \- This is the main interface to the \fBEditInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBEditInterface\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <editdcopinterface.h>\fP
.PP
Inherits \fBDCOPObject\fP.
.PP
.SS "DCOP Member Functions"

.in +1c
.ti -1c
.RI "virtual \fBQString\fP \fBtext\fP ()"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBtextLine\fP (uint line)"
.br
.ti -1c
.RI "virtual int \fBnumLines\fP ()"
.br
.ti -1c
.RI "virtual int \fBlength\fP ()"
.br
.ti -1c
.RI "virtual void \fBsetText\fP (const  \fBQString\fP &text)"
.br
.RI "\fISet the given text into the view. \fP"
.ti -1c
.RI "virtual bool \fBinsertText\fP (uint line, uint col, const  \fBQString\fP &text)"
.br
.RI "\fIInserts text at line 'line', column 'col' returns true if success. \fP"
.ti -1c
.RI "virtual bool \fBremoveText\fP (uint startLine, uint startCol, uint endLine, uint endCol)"
.br
.RI "\fIremove text at line 'line', column 'col' returns true if success \fP"
.ti -1c
.RI "virtual bool \fBinsertLine\fP (uint line, const  \fBQString\fP &text)"
.br
.RI "\fIInsert line(s) at the given line number. \fP"
.ti -1c
.RI "virtual bool \fBremoveLine\fP (uint line)"
.br
.RI "\fIInsert line(s) at the given line number. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBEditDCOPInterface\fP (\fBEditInterface\fP *Parent, const  char *name)"
.br
.RI "\fIConstruct a new interface object for the text editor. \fP"
.ti -1c
.RI "virtual \fB~EditDCOPInterface\fP ()"
.br
.RI "\fIDestructor Cleans up the object. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This is the main interface to the \fBEditInterface\fP of \fBKTextEdit\fP. DCOP interface to \fBEditInterface\fP. 

This will provide a consistant dcop interface to all \fBKDE\fP applications that use it. 
.PP
\fBAuthor:\fP
.RS 4
Ian Reinhart Geiser <geiseri@kde.org> 
.RE
.PP

.PP
Definition at line 18 of file editdcopinterface.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "EditDCOPInterface::EditDCOPInterface (\fBEditInterface\fP * Parent, const char * name)"
.PP
Construct a new interface object for the text editor. \fBParameters:\fP
.RS 4
\fIParentEditInterface\fP - The parent \fBEditInterface\fP object that will provide us with the functions for the interface. 
.RE
.PP
Definition at line 7 of file editdcopinterface.cpp.
.PP
References KStdAccel::name().
.SS "EditDCOPInterface::~\fBEditDCOPInterface\fP ()\fC [virtual]\fP"
.PP
Destructor Cleans up the object. Definition at line 13 of file editdcopinterface.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP EditDCOPInterface::text ()\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the complete document as a single \fBQString\fP 
.RE
.PP
Definition at line 18 of file editdcopinterface.cpp.
.SS "\fBQString\fP EditDCOPInterface::textLine (uint line)\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
All the text from the requested line. 
.RE
.PP
Definition at line 23 of file editdcopinterface.cpp.
.SS "int EditDCOPInterface::numLines ()\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
The current number of lines in the document 
.RE
.PP
Definition at line 28 of file editdcopinterface.cpp.
.SS "int EditDCOPInterface::length ()\fC [virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the number of characters in the document 
.RE
.PP
Definition at line 33 of file editdcopinterface.cpp.
.SS "void EditDCOPInterface::setText (const \fBQString\fP & text)\fC [virtual]\fP"
.PP
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.
.SS "bool EditDCOPInterface::insertText (uint line, uint col, const \fBQString\fP & text)\fC [virtual]\fP"
.PP
Inserts text at line 'line', column 'col' returns true if success. Definition at line 43 of file editdcopinterface.cpp.
.SS "bool EditDCOPInterface::removeText (uint startLine, uint startCol, uint endLine, uint endCol)\fC [virtual]\fP"
.PP
remove text at line 'line', column 'col' returns true if success Definition at line 48 of file editdcopinterface.cpp.
.SS "bool EditDCOPInterface::insertLine (uint line, const \fBQString\fP & text)\fC [virtual]\fP"
.PP
Insert line(s) at the given line number. Definition at line 53 of file editdcopinterface.cpp.
.SS "bool EditDCOPInterface::removeLine (uint line)\fC [virtual]\fP"
.PP
Insert line(s) at the given line number. If only one line is in the current document, removeLine will fail (return false) Definition at line 58 of file editdcopinterface.cpp.

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