<?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.CommandInterface</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>CommandInterface Class Reference</h1>
<code>from PyKDE4.ktexteditor import *</code>
<p>
Namespace: <a href="../ktexteditor/KTextEditor.html">KTextEditor</a><br />
<h2>Detailed Description</h2>
<p>Command extension interface for the Editor.
</p>
<p>
<b>Introduction </b>
</p>
<p>
The CommandInterface extends the Editor to support command line commands.
An application or a Plugin can register new commands by using
registerCommand(). To unregister a command call unregisterCommand(). To
check, whether a command with a given name exists use queryCommand().
</p>
<p>
<b>Accessing the CommandInterface </b>
</p>
<p>
The CommandInterface is supposed to be an extension interface for the
Editor, i.e. the Editor inherits the interface provided that the
used KTextEditor library implements the interface. Use qobject_cast to
access the interface:
<pre class="fragment">
// editor is of type KTextEditor.Editor*
KTextEditor.CommandInterface *iface =
qobject_cast<KTextEditor.CommandInterface*>( editor );
if( iface ) {
// the implementation supports the interface
// do stuff
}
</pre>
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KTextEditor.Editor, KTextEditor.Command,
KTextEditor.CommandExtension
</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>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#commandList">commandList</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#commands">commands</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryCommand">queryCommand</a> (self, QString cmd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#registerCommand">registerCommand</a> (self, <a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a> cmd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#unregisterCommand">unregisterCommand</a> (self, <a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a> cmd)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="commandList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList commandList</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 a list of available command line strings.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> command line strings
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> commands()
</dd></dl>
</p></div></div><a class="anchor" name="commands"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a>] commands</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 a list of all registered commands.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> list of all commands
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> queryCommand(), commandList()
</dd></dl>
</p></div></div><a class="anchor" name="queryCommand"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../ktexteditor/KTextEditor.Command.html">KTextEditor.Command</a> queryCommand</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>cmd</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>Query for the command <b>cmd.</b>
If the command <b>cmd</b> does not exist the return value is NULL.
</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>cmd</em> </td><td> name of command to query for
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the found command or NULL if no such command exists
</dd></dl>
</p></div></div><a class="anchor" name="registerCommand"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool registerCommand</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.Command.html">KTextEditor.Command</a> </td>
<td class="paramname"><em>cmd</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>Register a the new command <b>cmd.</b> The command will be registered for
all documents, i.e. every command is global.
</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>cmd</em> </td><td> command to register
</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> unregisterCommand()
</dd></dl>
</p></div></div><a class="anchor" name="unregisterCommand"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool unregisterCommand</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.Command.html">KTextEditor.Command</a> </td>
<td class="paramname"><em>cmd</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>Unregister the command <b>cmd.</b> The command will be unregistered for
all documents.
</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>cmd</em> </td><td> command to unregister
</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> registerCommand()
</dd></dl>
</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>
