interfaces Library API Documentation

KTextEditor::EditInterface Class Reference

This is an interface for the KTextEditor::Document class !!! More...

#include <editinterface.h>

List of all members.

Public Methods

virtual QString text () const=0
virtual QString text (uint startLine, uint startCol, uint endLine, uint endCol) const=0
virtual QString textLine (uint line) const=0
virtual uint numLines () const=0
virtual uint length () const=0
virtual int lineLength (uint line) const=0
virtual bool setText (const QString &text)=0
 Set the given text into the view.

virtual bool clear ()=0
 clears the document Warning: This will overwrite any data currently held in this view.

virtual bool insertText (uint line, uint col, const QString &text)=0
 Inserts text at line "line", column "col" returns true if success Use insertText(numLines(), ...) to append text at end of document.

virtual bool removeText (uint startLine, uint startCol, uint endLine, uint endCol)=0
 remove text at line "line", column "col" returns true if success

virtual bool insertLine (uint line, const QString &text)=0
 Insert line(s) at the given line number.

virtual bool removeLine (uint line)=0
 Remove line(s) at the given line number.

virtual void textChanged ()=0
 signals !!!


Detailed Description

This is an interface for the KTextEditor::Document class !!!

Definition at line 30 of file editinterface.h.


Member Function Documentation

virtual QString KTextEditor::EditInterface::text   [pure virtual]
 

Returns:
the complete document as a single QString

virtual QString KTextEditor::EditInterface::text uint    startLine,
uint    startCol,
uint    endLine,
uint    endCol
const [pure virtual]
 

Returns:
a QString

virtual QString KTextEditor::EditInterface::textLine uint    line const [pure virtual]
 

Returns:
All the text from the requested line.

virtual uint KTextEditor::EditInterface::numLines   [pure virtual]
 

Returns:
The current number of lines in the document

virtual uint KTextEditor::EditInterface::length   [pure virtual]
 

Returns:
the number of characters in the document

virtual int KTextEditor::EditInterface::lineLength uint    line const [pure virtual]
 

Returns:
the number of characters in the line (-1 if no line "line")

virtual bool KTextEditor::EditInterface::setText const QString   text [pure virtual]
 

Set the given text into the view.

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

virtual bool KTextEditor::EditInterface::clear   [pure virtual]
 

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

virtual bool KTextEditor::EditInterface::insertText uint    line,
uint    col,
const QString   text
[pure virtual]
 

Inserts text at line "line", column "col" returns true if success Use insertText(numLines(), ...) to append text at end of document.

virtual bool KTextEditor::EditInterface::removeText uint    startLine,
uint    startCol,
uint    endLine,
uint    endCol
[pure virtual]
 

remove text at line "line", column "col" returns true if success

virtual bool KTextEditor::EditInterface::insertLine uint    line,
const QString   text
[pure virtual]
 

Insert line(s) at the given line number.

Use insertLine(numLines(), text) to append line at end of document

virtual bool KTextEditor::EditInterface::removeLine uint    line [pure virtual]
 

Remove line(s) at the given line number.

virtual void KTextEditor::EditInterface::textChanged   [pure virtual]
 

signals !!!


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:22:16 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001