<?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::Command 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_1Command.html">Command</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::Command Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="Kate::Command" --> <p><a class="el" href="namespaceKate.html" title="Kate namespace All classes in this namespace must stay BC during one major release series (e...">Kate</a> Commands. <a href="classKate_1_1Command.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::Command:</div> <div class="dyncontent"> <div class="center"> <img src="classKate_1_1Command.png" usemap="#Kate::Command_map" alt=""/> <map id="Kate::Command_map" name="Kate::Command_map"> <area href="classKateCommands_1_1Character.html" title="insert a unicode or ascii character base 9+1: 1234 hex: 0x1234 or x1234 octal: 01231" alt="KateCommands::Character" shape="rect" coords="0,56,193,80"/> <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="203,56,396,80"/> <area href="classKateCommands_1_1Date.html" title="insert the current date/time in the given format" alt="KateCommands::Date" shape="rect" coords="406,56,599,80"/> <area href="classKateCommands_1_1SedReplace.html" alt="KateCommands::SedReplace" shape="rect" coords="609,56,802,80"/> </map> </div></div> <p><a href="classKate_1_1Command-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 <a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Command.html#a5dde1a0ceb5ca6c686a0a214d83bbcba">cmds</a> ()=0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Command.html#a13a4d74abc9ac01c641cb82ca835b522">exec</a> (<a class="el" href="classKate_1_1View.html">View</a> *view, const <a class="elRef" href="qstring.html">QString</a> &cmd, <a class="elRef" href="qstring.html">QString</a> &msg)=0</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKate_1_1Command.html#ae115a0ee27273170536c23d9995f3b60">help</a> (<a class="el" href="classKate_1_1View.html">View</a> *view, const <a class="elRef" href="qstring.html">QString</a> &cmd, <a class="elRef" href="qstring.html">QString</a> &msg)=0</td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p><a class="el" href="namespaceKate.html" title="Kate namespace All classes in this namespace must stay BC during one major release series (e...">Kate</a> Commands. </p> <p>Definition at line <a class="el" href="document_8h_source.html#l00096">96</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="a5dde1a0ceb5ca6c686a0a214d83bbcba"></a><!-- doxytag: member="Kate::Command::cmds" ref="a5dde1a0ceb5ca6c686a0a214d83bbcba" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="elRef" href="qstringlist.html">QStringList</a> Kate::Command::cmds </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Pure text start part of the commands which can be handled by this object which means i.e. </p> <p>for s/sdl/sdf/g => s or for char:1212 => char </p> <p>Implemented in <a class="el" href="classKateCommands_1_1CoreCommands.html#a6c0193deed26a8a8e8a21047b5ad85ce">KateCommands::CoreCommands</a>, <a class="el" href="classKateCommands_1_1SedReplace.html#a882c751ce26b0a1a00f8708e83ed217d">KateCommands::SedReplace</a>, <a class="el" href="classKateCommands_1_1Character.html#af45c2d499162769d6a3c801541a6dc39">KateCommands::Character</a>, and <a class="el" href="classKateCommands_1_1Date.html#a3918747606f5950d4500b2f225d777a0">KateCommands::Date</a>.</p> </div> </div> <a class="anchor" id="a13a4d74abc9ac01c641cb82ca835b522"></a><!-- doxytag: member="Kate::Command::exec" ref="a13a4d74abc9ac01c641cb82ca835b522" args="(View *view, const QString &cmd, QString &msg)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Kate::Command::exec </td> <td>(</td> <td class="paramtype"><a class="el" href="classKate_1_1View.html">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>cmd</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>msg</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Execute this command for the given view and cmd string, return a bool about success, msg for status. </p> <p>Implemented in <a class="el" href="classKateCommands_1_1CoreCommands.html#aea9100b4d7e4008654ca8f55b37e2f58">KateCommands::CoreCommands</a>, <a class="el" href="classKateCommands_1_1SedReplace.html#a78634b0715166d9b64c40bd10ca95bc1">KateCommands::SedReplace</a>, <a class="el" href="classKateCommands_1_1Character.html#adabb5d07c19abfbbe7e36bf8c94a890d">KateCommands::Character</a>, and <a class="el" href="classKateCommands_1_1Date.html#a347d1ea1911b972de6441e3ce123a403">KateCommands::Date</a>.</p> </div> </div> <a class="anchor" id="ae115a0ee27273170536c23d9995f3b60"></a><!-- doxytag: member="Kate::Command::help" ref="ae115a0ee27273170536c23d9995f3b60" args="(View *view, const QString &cmd, QString &msg)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual bool Kate::Command::help </td> <td>(</td> <td class="paramtype"><a class="el" href="classKate_1_1View.html">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>cmd</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="elRef" href="qstring.html">QString</a> & </td> <td class="paramname"><em>msg</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Shows help for the given view and cmd string, return a bool about success, msg for status. </p> <p>Implemented in <a class="el" href="classKateCommands_1_1CoreCommands.html#a632d95dc4d91711a35c7f1b02c5e475c">KateCommands::CoreCommands</a>, <a class="el" href="classKateCommands_1_1SedReplace.html#a2deb9339f82b69d22abcc3d377dbcead">KateCommands::SedReplace</a>, <a class="el" href="classKateCommands_1_1Character.html#a3f21917d7347934e9a6c8264a56637c4">KateCommands::Character</a>, and <a class="el" href="classKateCommands_1_1Date.html#a36263260d025ef9060a624fc64e57332">KateCommands::Date</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>