<?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.AnnotationInterface</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>AnnotationInterface Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>A Document extension interface for handling Annotation%s
</p>
<p>
<b>Introduction </b>
</p>
<p>
The AnnotationInterface is designed to provide line annotation information
for a document. This interface provides means to associate a document with a
annotation model, which provides some annotation information for each line
in the document.
</p>
<p>
Setting a model for a Document makes the model data available for all views.
If you only want to provide annotations in exactly one view, you can use
the AnnotationViewInterface directly. See the AnnotationViewInterface for
further details. To summarize, the two use cases are
- (1) show annotations in all views. This means you set an AnnotationModel
with this interface, and then call setAnnotationBorderVisible() for
each view.
- (2) show annotations only in one view. This means to not use this
interface. Instead, use the AnnotationViewInterface, which inherits
this interface. This means you set a model for the specific View.
</p>
<p>
If you set a model to the Document and the View, the View's model has
higher priority.
</p>
<p>
<b>Accessing the AnnotationInterface </b>
</p>
<p>
The AnnotationInterface is an extension interface for a Document, i.e. the
Document inherits the interface provided that the
used KTextEditor library implements the interface. Use qobject_cast to
access the interface:
<pre class="fragment">
// document is of type KTextEditor.Document*
KTextEditor.AnnotationInterface *iface =
qobject_cast<KTextEditor.AnnotationInterface*>( document );
if( iface ) {
// the implementation supports the interface
// do stuff
}
</pre>
</p>
<p>
<b>Using the AnnotationInterface </b>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.AnnotationModel, KTextEditor.AnnotationViewInterface
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.AnnotationModel.html">KTextEditor.AnnotationModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#annotationModel">annotationModel</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAnnotationModel">setAnnotationModel</a> (self, <a href="../ktexteditor/KTextEditor.AnnotationModel.html">KTextEditor.AnnotationModel</a> model)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="annotationModel"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.AnnotationModel.html">KTextEditor.AnnotationModel</a> annotationModel</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 currently set AnnotationModel or 0 if there's none
set
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the current AnnotationModel
</dd></dl>
</p></div></div><a class="anchor" name="setAnnotationModel"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAnnotationModel</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.AnnotationModel.html">KTextEditor.AnnotationModel</a> </td>
<td class="paramname"><em>model</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>Sets a new AnnotationModel for this document to provide
annotation information for each line.
</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>model</em> </td><td> the new AnnotationModel
</td></tr>
</table></dl>
<p>
</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>
