<?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_US" xml:lang="en_US">
<head>
<title>kate: Kate::CommandExtension Class Reference (kate)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kate</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKate.html">Kate</a> </li>
<li class="navelem"><a class="el" href="classKate_1_1CommandExtension.html">CommandExtension</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Kate::CommandExtension Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Kate::CommandExtension" -->
<p>Extension to the <a class="el" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> interface, allowing to interact with commands during typing.
<a href="classKate_1_1CommandExtension.html#details">More...</a></p>
<p><code>#include <<a class="el" href="document_8h_source.html">document.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for Kate::CommandExtension:</div>
<div class="dyncontent">
<div class="center">
<img src="classKate_1_1CommandExtension.png" usemap="#Kate::CommandExtension_map" alt=""/>
<map id="Kate::CommandExtension_map" name="Kate::CommandExtension_map">
<area href="classKateCommands_1_1CoreCommands.html" title="This Kate::Command provides access to a lot of the core functionality of kate part, settings, utilities, navigation etc." alt="KateCommands::CoreCommands" shape="rect" coords="0,56,193,80"/>
</map>
</div></div>
<p><a href="classKate_1_1CommandExtension-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1CommandExtension.html#afb01bd9e4664ceda26cf08725e0d4107">flagCompletions</a> (<a class="elRef" href="qstringlist.html">QStringList</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1CommandExtension.html#aed60e496bd7c3a5f29bbe3ba8d8cda85">completionObject</a> (const <a class="elRef" href="qstring.html">QString</a> &cmdname, <a class="el" href="classKate_1_1View.html">Kate::View</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1CommandExtension.html#a4ebff8321ad1dc0d545d8d2935c6fcdb">wantsToProcessText</a> (const <a class="elRef" href="qstring.html">QString</a> &cmdname)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1CommandExtension.html#a244c8d4538276eab42340aadae3c5dbf">processText</a> (<a class="el" href="classKate_1_1View.html">Kate::View</a> *view, const <a class="elRef" href="qstring.html">QString</a> &text)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Extension to the <a class="el" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> interface, allowing to interact with commands during typing. </p>
<p>This allows for completion and for example the isearch plugin. If you develop a command that wants to complete or process text as thu user types the arguments, or that has flags, you can have your command inherit this class. </p>
<p>Definition at line <a class="el" href="document_8h_source.html#l00129">129</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aed60e496bd7c3a5f29bbe3ba8d8cda85"></a><!-- doxytag: member="Kate::CommandExtension::completionObject" ref="aed60e496bd7c3a5f29bbe3ba8d8cda85" args="(const QString &cmdname, Kate::View *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a>* Kate::CommandExtension::completionObject </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>cmdname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKate_1_1View.html">Kate::View</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a> object that will substitute the command line default one while typing the first argument to the command. The text will be added to the command seperated by one space character.</dd></dl>
<p>Implement this method if your command can provide a completion object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdname</td><td>The command name associated with this request. </td></tr>
</table>
</dd>
</dl>
<p>Reimplemented in <a class="el" href="classKateCommands_1_1CoreCommands.html#ab6188b0d30240137bb060d8f7206c7a8">KateCommands::CoreCommands</a>.</p>
<p>Definition at line <a class="el" href="document_8h_source.html#l00157">157</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div>
</div>
<a class="anchor" id="afb01bd9e4664ceda26cf08725e0d4107"></a><!-- doxytag: member="Kate::CommandExtension::flagCompletions" ref="afb01bd9e4664ceda26cf08725e0d4107" args="(QStringList &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Kate::CommandExtension::flagCompletions </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qstringlist.html">QStringList</a> & </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fill in a list of flags to complete from. </p>
<p>Each flag is a single letter, any following text in the string is taken to be a description of the flag's meaning, and showed to the user as a hint. Implement this method if your command has flags.</p>
<p>This method is called each time the flag string in the typed command is changed, so that the available flags can be adjusted. When completions are displayed, existing flags are left out. </p>
<p>Definition at line <a class="el" href="document_8h_source.html#l00146">146</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div>
</div>
<a class="anchor" id="a244c8d4538276eab42340aadae3c5dbf"></a><!-- doxytag: member="Kate::CommandExtension::processText" ref="a244c8d4538276eab42340aadae3c5dbf" args="(Kate::View *view, const QString &text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Kate::CommandExtension::processText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKate_1_1View.html">Kate::View</a> * </td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This is called by the commandline each time the argument text for the command changes, if <a class="el" href="classKate_1_1CommandExtension.html#a4ebff8321ad1dc0d545d8d2935c6fcdb">wantsToProcessText()</a> returns true. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">view</td><td>The current view </td></tr>
<tr><td class="paramname">text</td><td>The current command text typed by the user. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="document_8h_source.html#l00177">177</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4ebff8321ad1dc0d545d8d2935c6fcdb"></a><!-- doxytag: member="Kate::CommandExtension::wantsToProcessText" ref="a4ebff8321ad1dc0d545d8d2935c6fcdb" args="(const QString &cmdname)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool Kate::CommandExtension::wantsToProcessText </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>cmdname</em></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>whether this command wants to process text interactively given the <code>cmdname</code>. If true, the command's <a class="el" href="classKate_1_1CommandExtension.html#a244c8d4538276eab42340aadae3c5dbf" title="This is called by the commandline each time the argument text for the command changes, if wantsToProcessText() returns true.">processText()</a> method is called when the text in the command line is changed.</dd></dl>
<p>Reimplement this to return true, if your commands wants to process the text as typed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdname</td><td>the command name associated with this query. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="document_8h_source.html#l00169">169</a> of file <a class="el" href="document_8h_source.html">document.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="document_8h_source.html">document.h</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kate</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classIndenterConfigPage.html">indenterconfigpage</option>, <option value="classKate_1_1Command.html">kate::command</option>, <option value="classKate_1_1CommandExtension.html">kate::commandextension</option>, <option value="classKate_1_1Document.html">kate::document</option>, <option value="classKate_1_1DocumentExt.html">kate::documentext</option>, <option value="classKate_1_1View.html">kate::view</option>, <option value="classKateArbitraryHighlight.html">katearbitraryhighlight</option>, <option value="classKateAttribute.html">kateattribute</option>, <option value="classKateAutoIndent.html">kateautoindent</option>, <option value="classKateBrowserExtension.html">katebrowserextension</option>, <option value="classKateBufBlock.html">katebufblock</option>, <option value="classKateBufBlockList.html">katebufblocklist</option>, <option value="classKateBuffer.html">katebuffer</option>, <option value="classKateCmdShellCompletion.html">katecmdshellcompletion</option>, <option value="classKateCommands_1_1Character.html">katecommands::character</option>, <option value="classKateCommands_1_1CoreCommands.html">katecommands::corecommands</option>, <option value="classKateCommands_1_1Date.html">katecommands::date</option>, <option value="classKateCommands_1_1SedReplace.html">katecommands::sedreplace</option>, <option value="classKateConfig.html">kateconfig</option>, <option value="classKateDocCursor.html">katedoccursor</option>, <option value="classKateJScript.html">katejscript</option>, <option value="classKateModOnHdPrompt.html">katemodonhdprompt</option>, <option value="classKateNormalIndent.html">katenormalindent</option>, <option value="classKateRenderer.html">katerenderer</option>, <option value="classKateReplacePrompt.html">katereplaceprompt</option>, <option value="classKateScrollBar.html">katescrollbar</option>, <option value="classKateSuperCursor.html">katesupercursor</option>, <option value="classKateSuperRange.html">katesuperrange</option>, <option value="classKateSyntaxContextData.html">katesyntaxcontextdata</option>, <option value="classKateSyntaxDocument.html">katesyntaxdocument</option>, <option value="classKateSyntaxModeListItem.html">katesyntaxmodelistitem</option>, <option value="classKateTextCursor.html">katetextcursor</option>, <option value="classKateTextLine.html">katetextline</option>, <option value="classKateUndoGroup.html">kateundogroup</option>, <option value="classKateVarIndent.html">katevarindent</option>, <option value="classKateViewIndentationAction.html">kateviewindentationaction</option>, <option value="classOutputFunction.html">outputfunction</option>, <option value="classOutputObject.html">outputobject</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" 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 id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
