<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KTextEditor.Document</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>Document Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Inherits: <a href="../kparts/KParts.ReadWritePart.html">KParts.ReadWritePart</a> → <a href="../kparts/KParts.ReadOnlyPart.html">KParts.ReadOnlyPart</a> → <a href="../kparts/KParts.Part.html">KParts.Part</a> → QObject<br />
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>A KParts derived class representing a text document.
</p>
<p>
Topics:
- doc_intro
- doc_manipulation
- doc_views
- doc_extensions
</p>
<p>
<b>Introduction </b>
</p>
<p>
The Document class represents a pure text document providing methods to
modify the content and create views. A document can have any number
of views, each view representing the same content, i.e. all views are
synchronized. Support for text selection is handled by a View and text
format attributes by the Attribute class.
</p>
<p>
To load a document call KParts.ReadOnlyPart.openUrl().
To reload a document from a file call documentReload(), to save the
document call documentSave() or documentSaveAs(). Whenever the modified
state of the document changes the signal modifiedChanged() is emitted.
Check the modified state with KParts.ReadWritePart.isModified().
Further signals are documentUrlChanged(). The encoding can be specified
with setEncoding(), however this will only take effect on file reload and
file save.
</p>
<p>
<b>Text Manipulation </b>
</p>
<p>
Get the whole content with text() and set new content with setText().
Call insertText() or insertLine() to insert new text or removeText()
and removeLine() to remove content. Whenever the document's content
changed the signal textChanged() is emitted. Additional signals are
textInserted() and textRemoved(). Note, that the first line in the
document is line 0.
</p>
<p>
If the editor part supports it, a document provides full undo/redo history.
Text manipulation actions can be grouped together using startEditing()
and endEditing(). All actions in between are grouped together to only one
undo/redo action. Due to internal reference counting you can call
startEditing() and endEditing() as often as you wish, but make sure you
call endEditing() exactly as often as you call startEditing(), otherwise
the reference counter gets confused.
</p>
<p>
<b>Document Views </b>
</p>
<p>
A View displays the document's content. As already mentioned, a document
can have any number of views, all synchronized. Get a list of all views
with views(). Only one of the views can be active (i.e. has focus), get
it by using activeView(). Create a new view with createView(). Every time
a new view is created the signal viewCreated() is emitted.
</p>
<p>
<b>Document Extension Interfaces </b>
</p>
<p>
A simple document represents text and provides text manipulation methods.
However, a real text editor should support advanced concepts like session
support, textsearch support, bookmark/general mark support etc. That is why
the KTextEditor library provides several additional interfaces to extend
a document's capabilities via multiple inheritance.
</p>
<p>
More information about interfaces for the document can be found in
kte_group_doc_extensions.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KParts.ReadWritePart, KTextEditor.Editor, KTextEditor.View,
KTextEditor.MarkInterface,
KTextEditor.ModificationInterface, KTextEditor.SearchInterface,
KTextEditor.SessionConfigInterface, KTextEditor.SmartInterface,
KTextEditor.VariableInterface
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Christoph Cullmann <cullmann@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutToClose">aboutToClose</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aboutToReload">aboutToReload</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentNameChanged">documentNameChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentSavedOrUploaded">documentSavedOrUploaded</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, bool saveAs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentUrlChanged">documentUrlChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#exclusiveEditEnd">exclusiveEditEnd</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#exclusiveEditStart">exclusiveEditStart</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlightingModeChanged">highlightingModeChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#modeChanged">modeChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#modifiedChanged">modifiedChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reloaded">reloaded</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textChanged">textChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textChanged">textChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> oldRange, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> newRange)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textChanged">textChanged</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> oldRange, QString oldText, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> newRange)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textInserted">textInserted</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textRemoved">textRemoved</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#textRemoved">textRemoved</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, QString oldText)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#viewCreated">viewCreated</a> (<a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> document, <a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> view)</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#Document">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activeView">activeView</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QChar </td><td class="memItemRight" valign="bottom"><a class="el" href="#character">character</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#clear">clear</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createView">createView</a> (self, QWidget parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#cursorInText">cursorInText</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> cursor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentEnd">documentEnd</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentName">documentName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentRange">documentRange</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentReload">documentReload</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentSave">documentSave</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#documentSaveAs">documentSaveAs</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Editor.html">KTextEditor.Editor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#editor">editor</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#encoding">encoding</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#endEditing">endEditing</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#endOfLine">endOfLine</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlightingMode">highlightingMode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlightingModeSection">highlightingModeSection</a> (self, int index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlightingModes">highlightingModes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertLine">insertLine</a> (self, int line, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertLines">insertLines</a> (self, int line, QStringList text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertText">insertText</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position, QString text, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#insertText">insertText</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position, QStringList text, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isEmpty">isEmpty</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#line">line</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#lineLength">lineLength</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#lines">lines</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mode">mode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#modeSection">modeSection</a> (self, int index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#modes">modes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#openingError">openingError</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#openingErrorMessage">openingErrorMessage</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeLine">removeLine</a> (self, int line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeText">removeText</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#replaceText">replaceText</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, QString text, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#replaceText">replaceText</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, QStringList text, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEncoding">setEncoding</a> (self, QString encoding)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setHighlightingMode">setHighlightingMode</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMode">setMode</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOpeningError">setOpeningError</a> (self, bool errors)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOpeningErrorMessage">setOpeningErrorMessage</a> (self, QString message)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSuppressOpeningErrorDialogs">setSuppressOpeningErrorDialogs</a> (self, bool suppress)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setText">setText</a> (self, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#setText">setText</a> (self, QStringList text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#startEditing">startEditing</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#suppressOpeningErrorDialogs">suppressOpeningErrorDialogs</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#text">text</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#text">text</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#textLines">textLines</a> (self, <a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> range, bool block=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalCharacters">totalCharacters</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#views">views</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="aboutToClose"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutToClose</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Warn anyone listening that the current document is about to close.
At this point all of the information is still accessible, such as the text,
cursors and ranges.
</p>
<p>
Any modifications made to the document at this point will be lost.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document being closed
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("aboutToClose(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="aboutToReload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> aboutToReload</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Warn anyone listening that the current document is about to reload.
At this point all of the information is still accessible, such as the text,
cursors and ranges.
</p>
<p>
Any modifications made to the document at this point will be lost.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document being reloaded
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("aboutToReload(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="documentNameChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> documentNameChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted whenever the <b>document</b> name changes.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which changed its name
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> documentName()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("documentNameChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="documentSavedOrUploaded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> documentSavedOrUploaded</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>saveAs</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal should be emitted after a document has been saved to disk or for remote files uploaded.
saveAs should be set to true, if the operation is a save as operation
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("documentSavedOrUploaded(KTextEditor::Document*, bool)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="documentUrlChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> documentUrlChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted whenever the <b>document</b> URL changes.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which changed its URL
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KParts.ReadOnlyPart.url()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("documentUrlChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="exclusiveEditEnd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> exclusiveEditEnd</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>In conjunction with exclusiveEditStart(), signals that the document's content
may be changed again without restriction.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("exclusiveEditEnd(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="exclusiveEditStart"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> exclusiveEditStart</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Upon emission, the document's content may only be changed by the initiator
of this signal until exclusiveEditEnd() is signalled. It is, however,
possible to listen to changes of the content.
</p>
<p>
Signalled e.g. on undo or redo.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("exclusiveEditStart(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="highlightingModeChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> highlightingModeChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Warn anyone listening that the current document's highlighting mode has
changed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document which's mode has changed
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setHighlightingMode()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("highlightingModeChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="modeChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> modeChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Warn anyone listening that the current document's mode has
changed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document whose mode has changed
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> setMode()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("modeChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="modifiedChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> modifiedChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted whenever the <b>document's</b> buffer changed from
either state unmodified to modified or vice versa.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which changed its modified state
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KParts.ReadWritePart.isModified().
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KParts.ReadWritePart.setModified()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("modifiedChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="reloaded"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reloaded</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted after the current document was reloaded.
At this point, some information might have been invalidated, like
for example the editing history.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document that was reloaded.
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("reloaded(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever the text in range
<b>oldRange</b> was removed and replaced with the text now in newRange,
e.g. the user selects text and pastes new text to replace the selection.
<dl class="note" compact><dt><b>Note:</b></dt><dd> <b>oldRange.start()</b> is guaranteed to equal <b>newRange.start().</b>
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldRange</em> </td><td> range that the text previously occupied
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldText</em> </td><td> old text that has been replaced
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>newRange</em> </td><td> range that the changed text now occupies
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText(), insertLine(), removeText(), removeLine(), clear()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textChanged(KTextEditor::Document*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>oldRange</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>newRange</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever the text in range
<b>oldRange</b> was removed and replaced with the text now in newRange,
e.g. the user selects text and pastes new text to replace the selection.
<dl class="note" compact><dt><b>Note:</b></dt><dd> <b>oldRange.start()</b> is guaranteed to equal <b>newRange.start().</b>
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldRange</em> </td><td> range that the text previously occupied
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldText</em> </td><td> old text that has been replaced
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>newRange</em> </td><td> range that the changed text now occupies
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText(), insertLine(), removeText(), removeLine(), clear()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textChanged(KTextEditor::Document*, const KTextEditor::Range&, const KTextEditor::Range&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textChanged</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>oldRange</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>oldText</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>newRange</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever the text in range
<b>oldRange</b> was removed and replaced with the text now in newRange,
e.g. the user selects text and pastes new text to replace the selection.
<dl class="note" compact><dt><b>Note:</b></dt><dd> <b>oldRange.start()</b> is guaranteed to equal <b>newRange.start().</b>
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldRange</em> </td><td> range that the text previously occupied
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldText</em> </td><td> old text that has been replaced
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>newRange</em> </td><td> range that the changed text now occupies
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText(), insertLine(), removeText(), removeLine(), clear()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textChanged(KTextEditor::Document*, const KTextEditor::Range&, const QString&, const KTextEditor::Range&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textInserted"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textInserted</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever text was inserted. The
insertion occurred at range.start(), and new text now occupies up to
range.end().
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range that the newly inserted text occupies
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText(), insertLine()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textInserted(KTextEditor::Document*, const KTextEditor::Range&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textRemoved"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textRemoved</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever <b>range</b> was removed, i.e.
text was removed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range that the removed text previously occupied
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldText</em> </td><td> the text that has been removed
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> removeText(), removeLine(), clear()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textRemoved(KTextEditor::Document*, const KTextEditor::Range&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="textRemoved"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> textRemoved</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>oldText</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The <b>document</b> emits this signal whenever <b>range</b> was removed, i.e.
text was removed.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> document which emitted this signal
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range that the removed text previously occupied
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>oldText</em> </td><td> the text that has been removed
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> removeText(), removeLine(), clear()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("textRemoved(KTextEditor::Document*, const KTextEditor::Range&, const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="viewCreated"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> viewCreated</td>
<td>(</td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Document.html">KTextEditor.Document</a> </td>
<td class="paramname"><em>document</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> </td>
<td class="paramname"><em>view</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted whenever the <b>document</b> creates a new <b>view.</b>
It should be called for every view to help applications / plugins to
attach to the <b>view.</b>
\attention This signal should be emitted after the view constructor is
completed, e.g. in the createView() method.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>document</em> </td><td> the document for which a new view is created
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>view</em> </td><td> the new view
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> createView()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("viewCreated(KTextEditor::Document*, KTextEditor::View*)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="Document"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor.
</p>
<p>
Create a new document with <b>parent.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> parent object
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Editor.createDocument()
</dd></dl>
</p></div></div><a class="anchor" name="activeView"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> activeView</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Return the view which currently has user focus, if any.
</p></div></div><a class="anchor" name="character"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QChar character</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>
<td class="paramname"><em>position</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the character at <b>cursor.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>position</em> </td><td> the location of the character to retrieve
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the requested character, or QChar() for invalid cursors.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText()
</dd></dl>
</p></div></div><a class="anchor" name="clear"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool clear</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Remove the whole content of the document.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> removeText(), removeLine()
</dd></dl>
</p></div></div><a class="anchor" name="createView"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a> createView</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Create a new view attached to <b>parent.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> parent widget
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the new view
</dd></dl>
</p></div></div><a class="anchor" name="cursorInText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool cursorInText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>
<td class="paramname"><em>cursor</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Checks whether the <b>cursor</b> specifies a valid position in a document.
It can optionally be overridden by an implementation.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>cursor</em> </td><td> which should be checked
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true, if the cursor is valid, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> SmartCursor.isValid()
</dd></dl>
</p></div></div><a class="anchor" name="documentEnd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> documentEnd</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>End position of the document.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> The last column on the last line of the document
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> all()
</dd></dl>
</p></div></div><a class="anchor" name="documentName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString documentName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get this document's name.
The editor part should provide some meaningful name, like some unique
"Untitled XYZ" for the document - without URL or basename for
documents with url.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> readable document name
</dd></dl>
</p></div></div><a class="anchor" name="documentRange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> documentRange</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>A Range which encompasses the whole document.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> A range from the start to the end of the document
</dd></dl>
</p></div></div><a class="anchor" name="documentReload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool documentReload</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Reload the current file.
The user will be prompted by the part on changes and more and can
cancel this action if it can harm.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the reload has been done, otherwise false. If
the document has no url set, it will just return false.
</dd></dl>
</p></div></div><a class="anchor" name="documentSave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool documentSave</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Save the current file.
The user will be asked for a filename if needed and more.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, i.e. the save has been done, otherwise
</dd></dl> false
</p></div></div><a class="anchor" name="documentSaveAs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool documentSaveAs</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Save the current file to another location.
The user will be asked for a filename and more.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, i.e. the save has been done, otherwise
</dd></dl> false
</p></div></div><a class="anchor" name="editor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Editor.html">KTextEditor.Editor</a> editor</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the global editor object. The editor part implementation must
ensure that this object exists as long as any factory or document
object exists.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> global KTextEditor.Editor object
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.Editor
</dd></dl>
</p></div></div><a class="anchor" name="encoding"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString encoding</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the current chosen encoding. The return value is an empty string,
if the document uses the default encoding of the editor and no own
special encoding.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> current encoding of the document
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setEncoding()
</dd></dl>
</p></div></div><a class="anchor" name="endEditing"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool endEditing</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>End an editing sequence.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false. Parts not supporting
it should return false.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> startEditing() for more details
</dd></dl>
</p></div></div><a class="anchor" name="endOfLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> endOfLine</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Get the end cursor position of line <b>line.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> lineLength(), line()
</dd></dl>
</p></div></div><a class="anchor" name="highlightingMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString highlightingMode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Return the name of the currently used mode
<dl class="return" compact><dt><b>Returns:</b></dt><dd> name of the used mode
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> highlightingModes(), setHighlightingMode()
</dd></dl>
</p></div></div><a class="anchor" name="highlightingModeSection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString highlightingModeSection</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns the name of the section for a highlight given its index in the highlight
list (as returned by highlightModes()).
</p>
<p>
You can use this function to build a tree of the highlight names, organized in sections.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>index</em> </td><td> the index of the highlight in the list returned by modes()
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="highlightingModes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList highlightingModes</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Return a list of the names of all possible modes
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of mode names
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> highlightingMode(), setHighlightingMode()
</dd></dl>
</p></div></div><a class="anchor" name="insertLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool insertLine</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Insert line(s) at the given line number. The newline character '\\n'
is treated as line delimiter, so it is possible to insert multiple
lines. To append lines at the end of the document, use
<pre class="fragment">
insertLine( lines(), text )
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line where to insert the text
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text which should be inserted
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText()
</dd></dl>
</p></div></div><a class="anchor" name="insertLines"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool insertLines</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Insert line(s) at the given line number. The newline character '\\n'
is treated as line delimiter, so it is possible to insert multiple
lines. To append lines at the end of the document, use
<pre class="fragment">
insertLine( lines(), text )
</pre>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line where to insert the text
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text which should be inserted
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> insertText()
</dd></dl>
</p></div></div><a class="anchor" name="insertText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool insertText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Insert <b>text</b> at <b>position.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>position</em> </td><td> position to insert the text
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text to insert
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> insert this text as a visual block of text rather than a linear sequence
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText(), removeText()
</dd></dl>
</p></div></div><a class="anchor" name="insertText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool insertText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Insert <b>text</b> at <b>position.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>position</em> </td><td> position to insert the text
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text to insert
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> insert this text as a visual block of text rather than a linear sequence
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText(), removeText()
</dd></dl>
</p></div></div><a class="anchor" name="isEmpty"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isEmpty</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns if the document is empty.
</p></div></div><a class="anchor" name="line"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString line</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get a single text line.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> the wanted line
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the requested line, or "" for invalid line numbers
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> text(), lineLength()
</dd></dl>
</p></div></div><a class="anchor" name="lineLength"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int lineLength</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the length of a given line in characters.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to get length from
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the number of characters in the line or -1 if the line was
invalid
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> line()
</dd></dl>
</p></div></div><a class="anchor" name="lines"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int lines</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the count of lines of the document.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current number of lines in the document
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> length()
</dd></dl>
</p></div></div><a class="anchor" name="mimeType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString mimeType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get this document's mimetype.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> mimetype
</dd></dl>
</p></div></div><a class="anchor" name="mode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString mode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Return the name of the currently used mode
<dl class="return" compact><dt><b>Returns:</b></dt><dd> name of the used mode
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> modes(), setMode()
</dd></dl>
</p></div></div><a class="anchor" name="modeSection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString modeSection</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns the name of the section for a mode given its index in the highlight
list (as returned by modes()).
</p>
<p>
You can use this function to build a tree of the mode names, organized in sections.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>index</em> </td><td> the index of the highlight in the list returned by modes()
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="modes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList modes</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Return a list of the names of all possible modes
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of mode names
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> mode(), setMode()
</dd></dl>
</p></div></div><a class="anchor" name="openingError"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool openingError</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>True, eg if the file for opening could not be read
This doesn't have to handle the KPart job cancled cases
</p></div></div><a class="anchor" name="openingErrorMessage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString openingErrorMessage</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="removeLine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool removeLine</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>line</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Remove <b>line</b> from the document.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>line</em> </td><td> line to remove
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> removeText(), clear()
</dd></dl>
</p></div></div><a class="anchor" name="removeText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool removeText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Remove the text specified in <b>range.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range of text to remove
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> set this to true to remove a text block on the basis of columns, rather than everything inside <b>range</b>
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText(), insertText()
</dd></dl>
</p></div></div><a class="anchor" name="replaceText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool replaceText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Replace text from <b>range</b> with specified <b>text.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range of text to replace
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text to replace with
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> replace text as a visual block of text rather than a linear sequence
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText(), removeText(), insertText()
</dd></dl>
</p></div></div><a class="anchor" name="replaceText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool replaceText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Replace text from <b>range</b> with specified <b>text.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> range of text to replace
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> text to replace with
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> replace text as a visual block of text rather than a linear sequence
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText(), removeText(), insertText()
</dd></dl>
</p></div></div><a class="anchor" name="setEncoding"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setEncoding</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>encoding</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the encoding for this document. This encoding will be used
while loading and saving files, it will not affect the already
existing content of the document, e.g. if the file has already been
opened without the correct encoding, this will not fix it, you
would for example need to trigger a reload for this.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>encoding</em> </td><td> new encoding for the document, the name must be
accepted by QTextCodec, if an empty encoding name is given, the
part should fallback to its own default encoding, e.g. the
system encoding or the global user settings
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, or false, if the encoding could not be set.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> encoding()
</dd></dl>
</p></div></div><a class="anchor" name="setHighlightingMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setHighlightingMode</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the current mode of the document by giving its name
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> name of the mode to use for this document
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> highlightingMode(), highlightingModes(), highlightingModeChanged()
</dd></dl>
</p></div></div><a class="anchor" name="setMode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setMode</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the current mode of the document by giving its name
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> name of the mode to use for this document
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> mode(), modes(), modeChanged()
</dd></dl>
</p></div></div><a class="anchor" name="setOpeningError"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setOpeningError</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>errors</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setOpeningErrorMessage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setOpeningErrorMessage</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>message</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setSuppressOpeningErrorDialogs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSuppressOpeningErrorDialogs</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>suppress</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>by default dialogs should be displayed.
In any case (dialog shown or suppressed)
openingErrors and openingErrorMessage should have meaningfull values
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>suppress</em> </td><td> true/false value if dialogs should be displayed
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the given text as new document content.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> new content for the document
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> text()
</dd></dl>
</p></div></div><a class="anchor" name="setText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool setText</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Set the given text as new document content.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> new content for the document
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> text()
</dd></dl>
</p></div></div><a class="anchor" name="startEditing"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool startEditing</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Begin an editing sequence.
Edit commands during this sequence will be bunched together so that
they represent a single undo command in the editor, and so that
repaint events do not occur inbetween.
</p>
<p>
Your application should not return control to the event loop while
it has an unterminated (i.e. no matching endEditing() call) editing
sequence (result undefined) - so do all of your work in one go!
</p>
<p>
This call stacks, like the endEditing() calls, this means you can
safely call it three times in a row for example if you call
endEditing() three times, too, it internaly just does counting the
running editing sessions.
</p>
<p>
If the texteditor part does not support these transactions,
both calls just do nothing.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, otherwise false. Parts not supporting
it should return false
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> endEditing()
</dd></dl>
</p></div></div><a class="anchor" name="suppressOpeningErrorDialogs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool suppressOpeningErrorDialogs</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="text"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString text</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the document content within the given <b>range.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> the range of text to retrieve
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> Set this to true to receive text in a visual block,
rather than everything inside <b>range.</b>
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the requested text part, or QString() for invalid ranges.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText()
</dd></dl>
</p></div></div><a class="anchor" name="text"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString text</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the document content within the given <b>range.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> the range of text to retrieve
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> Set this to true to receive text in a visual block,
rather than everything inside <b>range.</b>
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the requested text part, or QString() for invalid ranges.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText()
</dd></dl>
</p></div></div><a class="anchor" name="textLines"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList textLines</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../ktexteditor/KTextEditor.Range.html">KTextEditor.Range</a> </td>
<td class="paramname"><em>range</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>block=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the document content within the given <b>range.</b>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>range</em> </td><td> the range of text to retrieve
</td></tr> </table></dl>
<p> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>block</em> </td><td> Set this to true to receive text in a visual block,
rather than everything inside <b>range.</b>
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the requested text lines, or QStringList() for invalid ranges.
no end of line termination is included.
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText()
</dd></dl>
</p></div></div><a class="anchor" name="totalCharacters"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int totalCharacters</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Get the count of characters in the document. A TAB character counts as
only one character.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the number of characters in the document
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> lines()
</dd></dl>
</p></div></div><a class="anchor" name="views"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../ktexteditor/KTextEditor.View.html">KTextEditor.View</a>] views</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Returns the views pre-casted to KTextEditor.View%s
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
