.TH "KTextEditor::EditInterface" 3 "28 Jan 2004" "interfaces Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTextEditor::EditInterface \- This is an interface for the KTextEditor::Document class !!!  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <editinterface.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "uint \fBeditInterfaceNumber\fP () const "
.br
.ti -1c
.RI "virtual \fBQString\fP \fBtext\fP () const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBtext\fP (uint startLine, uint startCol, uint endLine, uint endCol) const =0"
.br
.ti -1c
.RI "virtual \fBQString\fP \fBtextLine\fP (uint line) const =0"
.br
.ti -1c
.RI "virtual uint \fBnumLines\fP () const =0"
.br
.ti -1c
.RI "virtual uint \fBlength\fP () const =0"
.br
.ti -1c
.RI "virtual int \fBlineLength\fP (uint line) const =0"
.br
.ti -1c
.RI "virtual bool \fBsetText\fP (const  \fBQString\fP &text)=0"
.br
.RI "\fISet the given text into the view. \fP"
.ti -1c
.RI "virtual bool \fBclear\fP ()=0"
.br
.RI "\fIclears the document Warning: This will overwrite any data currently held in this view. \fP"
.ti -1c
.RI "virtual bool \fBinsertText\fP (uint line, uint col, const  \fBQString\fP &text)=0"
.br
.RI "\fIInserts text at line 'line', column 'col' returns true if success Use insertText(\fBnumLines()\fP, ...) to append text at end of document. \fP"
.ti -1c
.RI "virtual bool \fBremoveText\fP (uint startLine, uint startCol, uint endLine, uint endCol)=0"
.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)=0"
.br
.RI "\fIInsert line(s) at the given line number. \fP"
.ti -1c
.RI "virtual bool \fBremoveLine\fP (uint line)=0"
.br
.RI "\fIRemove line(s) at the given line number. \fP"
.ti -1c
.RI "virtual void \fBtextChanged\fP ()=0"
.br
.RI "\fIsignals !!! \fP"
.ti -1c
.RI "virtual void \fBcharactersInteractivelyInserted\fP (int,int,const  \fBQString\fP &)=0"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "void \fBsetEditInterfaceDCOPSuffix\fP (const  \fBQCString\fP &suffix)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBPrivateEditInterface\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This is an interface for the KTextEditor::Document class !!! Definition at line 30 of file editinterface.h.
.SH "Member Function Documentation"
.PP 
.SS "virtual \fBQString\fP KTextEditor::EditInterface::text () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the complete document as a single \fBQString\fP 
.RE
.PP

.SS "virtual \fBQString\fP KTextEditor::EditInterface::text (uint startLine, uint startCol, uint endLine, uint endCol) const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
a \fBQString\fP 
.RE
.PP

.SS "virtual \fBQString\fP KTextEditor::EditInterface::textLine (uint line) const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
All the text from the requested line. 
.RE
.PP

.SS "virtual uint KTextEditor::EditInterface::numLines () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
The current number of lines in the document 
.RE
.PP

.SS "virtual uint KTextEditor::EditInterface::length () const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the number of characters in the document 
.RE
.PP

.SS "virtual int KTextEditor::EditInterface::lineLength (uint line) const\fC [pure virtual]\fP"
.PP
\fBReturns:\fP
.RS 4
the number of characters in the line (-1 if no line 'line') 
.RE
.PP

.SS "virtual bool KTextEditor::EditInterface::setText (const \fBQString\fP & text)\fC [pure virtual]\fP"
.PP
Set the given text into the view. Warning: This will overwrite any data currently held in this view. 
.SS "virtual bool KTextEditor::EditInterface::clear ()\fC [pure virtual]\fP"
.PP
clears the document Warning: This will overwrite any data currently held in this view. 
.SS "virtual bool KTextEditor::EditInterface::insertText (uint line, uint col, const \fBQString\fP & text)\fC [pure virtual]\fP"
.PP
Inserts text at line 'line', column 'col' returns true if success Use insertText(\fBnumLines()\fP, ...) to append text at end of document. 
.SS "virtual bool KTextEditor::EditInterface::removeText (uint startLine, uint startCol, uint endLine, uint endCol)\fC [pure virtual]\fP"
.PP
remove text at line 'line', column 'col' returns true if success 
.SS "virtual bool KTextEditor::EditInterface::insertLine (uint line, const \fBQString\fP & text)\fC [pure virtual]\fP"
.PP
Insert line(s) at the given line number. Use insertLine(\fBnumLines()\fP, text) to append line at end of document 
.SS "virtual bool KTextEditor::EditInterface::removeLine (uint line)\fC [pure virtual]\fP"
.PP
Remove line(s) at the given line number. 
.SS "virtual void KTextEditor::EditInterface::textChanged ()\fC [pure virtual]\fP"
.PP
signals !!! 

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