<?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.HighlightInterface</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>HighlightInterface Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<dl class="abstract" compact><dt><b>Abstract class:</b></dt>
<dd>This class can be used as a base class for new classes, but can not be instantiated directly.</dd></dl>
<p>Highlighting information interface for the Document.
</p>
<p>
<b>Introduction </b>
</p>
<p>
The HighlightInterface provides methods to access the Attributes
used for highlighting the Document.
</p>
<p>
<b>Accessing the HighlightInterface </b>
</p>
<p>
The HighlightInterface is supposed to be 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">
// doc is of type KTextEditor.Document*
KTextEditor.HighlightInterface *iface =
qobject_cast<KTextEditor.HighlightInterface*>( doc );
if( iface ) {
// the implementation supports the interface
// do stuff
}
</pre>
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.Document
</dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Milian Wolff <mail@milianw.de> </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#DefaultStyle">DefaultStyle</a> </td><td class="memItemRight" valign="bottom">{ dsNormal, dsKeyword, dsDataType, dsDecVal, dsBaseN, dsFloat, dsChar, dsString, dsComment, dsOthers, dsAlert, dsFunction, dsRegionMarker, dsError }</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="#HighlightInterface">__init__</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KSharedPtr<KTextEditor::Attribute> </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultStyle">defaultStyle</a> (self, <a href="../ktexteditor/KTextEditor.HighlightInterface.html#DefaultStyle">KTextEditor.HighlightInterface.DefaultStyle</a> ds)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#embeddedHighlightingModes">embeddedHighlightingModes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlightingModeAt">highlightingModeAt</a> (self, <a href="../ktexteditor/KTextEditor.Cursor.html">KTextEditor.Cursor</a> position)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="HighlightInterface"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</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>Constructor.
</p></div></div><a class="anchor" name="defaultStyle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">KSharedPtr<KTextEditor::Attribute> defaultStyle</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.HighlightInterface.html#DefaultStyle">KTextEditor.HighlightInterface.DefaultStyle</a> </td>
<td class="paramname"><em>ds</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 attribute used for the style <b>ds.</b>
</p></div></div><a class="anchor" name="embeddedHighlightingModes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList embeddedHighlightingModes</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 all available highlighting modes for the current document.
</p>
<p>
Each document can be highlighted using an arbitrary number of highlighting
contexts. This method will return the names for each of the used modes.
</p>
<p>
Example: The "PHP (HTML)" mode includes the highlighting for PHP, HTML, CSS and JavaScript.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> Returns a list of embedded highlighting modes for the current Document.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.Document.highlightingMode()
</dd></dl>
</p></div></div><a class="anchor" name="highlightingModeAt"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString highlightingModeAt</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 highlight mode used at a given position in the document.
</p>
<p>
Retrieve the name of the applied highlight mode at a given <b>position</b>
in the current document.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> highlightingModes()
</dd></dl> </p>
<p>
TODO: I intended to make this const but Kate's implementation needs to
call kateTextline which is non-const. Solution?
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="DefaultStyle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">DefaultStyle</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>dsNormal</em> </td><td><tr><td valign="top"><em>dsKeyword</em> </td><td><tr><td valign="top"><em>dsDataType</em> </td><td><tr><td valign="top"><em>dsDecVal</em> </td><td><tr><td valign="top"><em>dsBaseN</em> </td><td><tr><td valign="top"><em>dsFloat</em> </td><td><tr><td valign="top"><em>dsChar</em> </td><td><tr><td valign="top"><em>dsString</em> </td><td><tr><td valign="top"><em>dsComment</em> </td><td><tr><td valign="top"><em>dsOthers</em> </td><td><tr><td valign="top"><em>dsAlert</em> </td><td><tr><td valign="top"><em>dsFunction</em> </td><td><tr><td valign="top"><em>dsRegionMarker</em> </td><td><tr><td valign="top"><em>dsError</em> </td><td></table>
</dl>
</div></div><p>
</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>
