<?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: katecmds.h Source File (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 class="header">
<div class="headertitle">
<div class="title">katecmds.h</div> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of the KDE libraries</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 Anders Lund <anders@alweb.dk></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2001-2004 Christoph Cullmann <cullmann@kde.org></span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2001 Charles Samuels <charles@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> License version 2 as published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00017"></a>00017 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00018"></a>00018 <span class="comment"> Boston, MA 02110-1301, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __KATE_CMDS_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __KATE_CMDS_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "../interfaces/document.h"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "../interfaces/view.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">class </span>KateDocument;
<a name="l00028"></a>00028 <span class="keyword">class </span><a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a>;
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>KateCommands
<a name="l00031"></a>00031 {
<a name="l00032"></a>00032
<a name="l00039"></a><a class="code" href="classKateCommands_1_1CoreCommands.html">00039</a> <span class="keyword">class </span><a class="code" 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.">CoreCommands</a> : <span class="keyword">public</span> Kate::Command, <span class="keyword">public</span> Kate::CommandExtension
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1CoreCommands.html#aea9100b4d7e4008654ca8f55b37e2f58" title="execute command">exec</a>( <span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *view, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd, <a class="codeRef" href="qstring.html">QString</a> &errorMsg );
<a name="l00050"></a>00050
<a name="l00051"></a><a class="code" href="classKateCommands_1_1CoreCommands.html#a632d95dc4d91711a35c7f1b02c5e475c">00051</a> <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1CoreCommands.html#a632d95dc4d91711a35c7f1b02c5e475c" title="Shows help for the given view and cmd string, return a bool about success, msg for status...">help</a>( <span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &, <a class="codeRef" href="qstring.html">QString</a> & ) {<span class="keywordflow">return</span> <span class="keyword">false</span>;};
<a name="l00052"></a>00052
<a name="l00057"></a>00057 <a class="codeRef" href="qstringlist.html">QStringList</a> <a class="code" href="classKateCommands_1_1CoreCommands.html#a6c0193deed26a8a8e8a21047b5ad85ce" title="supported commands as prefixes">cmds</a>();
<a name="l00058"></a>00058
<a name="l00062"></a>00062 <a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a> *<a class="code" href="classKateCommands_1_1CoreCommands.html#ab6188b0d30240137bb060d8f7206c7a8" title="override completionObject from interfaces/document.h .">completionObject</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd, <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *view );
<a name="l00063"></a>00063 };
<a name="l00064"></a>00064
<a name="l00075"></a><a class="code" href="classKateCommands_1_1SedReplace.html">00075</a> <span class="keyword">class </span><a class="code" href="classKateCommands_1_1SedReplace.html">SedReplace</a> : <span class="keyword">public</span> Kate::Command
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <span class="keyword">public</span>:
<a name="l00085"></a>00085 <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1SedReplace.html#a78634b0715166d9b64c40bd10ca95bc1" title="execute command">exec</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *view, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd, <a class="codeRef" href="qstring.html">QString</a> &errorMsg);
<a name="l00086"></a>00086
<a name="l00087"></a><a class="code" href="classKateCommands_1_1SedReplace.html#a2deb9339f82b69d22abcc3d377dbcead">00087</a> <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1SedReplace.html#a2deb9339f82b69d22abcc3d377dbcead" title="Shows help for the given view and cmd string, return a bool about success, msg for status...">help</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &, <a class="codeRef" href="qstring.html">QString</a> &) { <span class="keywordflow">return</span> <span class="keyword">false</span>; };
<a name="l00088"></a>00088
<a name="l00093"></a><a class="code" href="classKateCommands_1_1SedReplace.html#a882c751ce26b0a1a00f8708e83ed217d">00093</a> <a class="codeRef" href="qstringlist.html">QStringList</a> <a class="code" href="classKateCommands_1_1SedReplace.html#a882c751ce26b0a1a00f8708e83ed217d" title="supported commands as prefixes">cmds</a> () { <a class="codeRef" href="qstringlist.html">QStringList</a> l(<span class="stringliteral">"s"</span>); l << <span class="stringliteral">"%s"</span> << <span class="stringliteral">"$s"</span>; <span class="keywordflow">return</span> l; };
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keyword">private</span>:
<a name="l00115"></a>00115 <span class="keyword">static</span> <span class="keywordtype">int</span> sedMagic(KateDocument *doc, <span class="keywordtype">int</span> &line,
<a name="l00116"></a>00116 <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &find, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &replace, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &delim,
<a name="l00117"></a>00117 <span class="keywordtype">bool</span> noCase, <span class="keywordtype">bool</span> repeat,
<a name="l00118"></a>00118 uint startcol=0, <span class="keywordtype">int</span> endcol=-1);
<a name="l00119"></a>00119 };
<a name="l00120"></a>00120
<a name="l00129"></a><a class="code" href="classKateCommands_1_1Character.html">00129</a> <span class="keyword">class </span><a class="code" href="classKateCommands_1_1Character.html" title="insert a unicode or ascii character base 9+1: 1234 hex: 0x1234 or x1234 octal: 01231">Character</a> : <span class="keyword">public</span> Kate::Command
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131 <span class="keyword">public</span>:
<a name="l00139"></a>00139 <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1Character.html#adabb5d07c19abfbbe7e36bf8c94a890d" title="execute command">exec</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *view, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd, <a class="codeRef" href="qstring.html">QString</a> &errorMsg);
<a name="l00140"></a>00140
<a name="l00141"></a><a class="code" href="classKateCommands_1_1Character.html#a3f21917d7347934e9a6c8264a56637c4">00141</a> <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1Character.html#a3f21917d7347934e9a6c8264a56637c4" title="Shows help for the given view and cmd string, return a bool about success, msg for status...">help</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &, <a class="codeRef" href="qstring.html">QString</a> &) { <span class="keywordflow">return</span> <span class="keyword">false</span>; };
<a name="l00142"></a>00142
<a name="l00147"></a><a class="code" href="classKateCommands_1_1Character.html#af45c2d499162769d6a3c801541a6dc39">00147</a> <a class="codeRef" href="qstringlist.html">QStringList</a> <a class="code" href="classKateCommands_1_1Character.html#af45c2d499162769d6a3c801541a6dc39" title="supported commands as prefixes">cmds</a> () { <span class="keywordflow">return</span> <a class="codeRef" href="qstringlist.html">QStringList</a>(<span class="stringliteral">"char"</span>); };
<a name="l00148"></a>00148 };
<a name="l00149"></a>00149
<a name="l00153"></a><a class="code" href="classKateCommands_1_1Date.html">00153</a> <span class="keyword">class </span><a class="code" href="classKateCommands_1_1Date.html" title="insert the current date/time in the given format">Date</a> : <span class="keyword">public</span> Kate::Command
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 <span class="keyword">public</span>:
<a name="l00163"></a>00163 <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1Date.html#a347d1ea1911b972de6441e3ce123a403" title="execute command">exec</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *view, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd, <a class="codeRef" href="qstring.html">QString</a> &errorMsg);
<a name="l00164"></a>00164
<a name="l00165"></a><a class="code" href="classKateCommands_1_1Date.html#a36263260d025ef9060a624fc64e57332">00165</a> <span class="keywordtype">bool</span> <a class="code" href="classKateCommands_1_1Date.html#a36263260d025ef9060a624fc64e57332" title="Shows help for the given view and cmd string, return a bool about success, msg for status...">help</a> (<span class="keyword">class</span> <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> *, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &, <a class="codeRef" href="qstring.html">QString</a> &) { <span class="keywordflow">return</span> <span class="keyword">false</span>; };
<a name="l00166"></a>00166
<a name="l00171"></a><a class="code" href="classKateCommands_1_1Date.html#a3918747606f5950d4500b2f225d777a0">00171</a> <a class="codeRef" href="qstringlist.html">QStringList</a> <a class="code" href="classKateCommands_1_1Date.html#a3918747606f5950d4500b2f225d777a0" title="supported commands as prefixes">cmds</a> () { <span class="keywordflow">return</span> <a class="codeRef" href="qstringlist.html">QStringList</a>(<span class="stringliteral">"date"</span>); };
<a name="l00172"></a>00172 };
<a name="l00173"></a>00173
<a name="l00174"></a>00174
<a name="l00175"></a>00175 } <span class="comment">// namespace KateCommands</span>
<a name="l00176"></a>00176 <span class="preprocessor">#endif</span>
<a name="l00177"></a>00177 <span class="preprocessor"></span>
<a name="l00178"></a>00178 <span class="comment">// kate: space-indent on; indent-width 2; replace-tabs on;</span>
</pre></div></div>
</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>
