<?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>interfaces/ktexteditor: codecompletioninterface.h Source File (interfaces/ktexteditor)</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="../../html/index.html">interfaces</a> / <a href=".">ktexteditor</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.4.4 -->
<div class="nav">
<a class="el" href="dir_000000.html">interfaces</a> » <a class="el" href="dir_000001.html">ktexteditor</a></div>
<h1>codecompletioninterface.h</h1><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) 2001 Joseph Wenninger <jowenn@kde.org></span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License version 2 as published by the Free Software Foundation.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00009"></a>00009 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00010"></a>00010 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00011"></a>00011 <span class="comment"> Library General Public License for more details.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00014"></a>00014 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00015"></a>00015 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span>
<a name="l00016"></a>00016 <span class="comment"> Boston, MA 02110-1301, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __ktexteditor_codecompletioninterface_h__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __ktexteditor_codecompletioninterface_h__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <qstring.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <qstringlist.h></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include <kdelibs_export.h></span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">namespace </span>KTextEditor
<a name="l00028"></a>00028 {
<a name="l00029"></a>00029
<a name="l00042"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html">00042</a> <span class="keyword">class </span>KTEXTEDITOR_EXPORT CompletionEntry
<a name="l00043"></a>00043 {
<a name="l00044"></a>00044 <span class="keyword">public</span>:
<a name="l00045"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o0">00045</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> type;
<a name="l00046"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o1">00046</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> text;
<a name="l00047"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o2">00047</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> prefix;
<a name="l00048"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o3">00048</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> postfix;
<a name="l00049"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o4">00049</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> comment;
<a name="l00050"></a>00050
<a name="l00051"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#o5">00051</a> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> userdata;
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="classKTextEditor_1_1CompletionEntry.html#a0">00053</a> <span class="keywordtype">bool</span> operator==( <span class="keyword">const</span> CompletionEntry &c )<span class="keyword"> const </span>{
<a name="l00054"></a>00054 <span class="keywordflow">return</span> ( c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o0">type</a> == type &&
<a name="l00055"></a>00055 c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o1">text</a> == text &&
<a name="l00056"></a>00056 c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o3">postfix</a> == postfix &&
<a name="l00057"></a>00057 c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o2">prefix</a> == prefix &&
<a name="l00058"></a>00058 c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o4">comment</a> == comment &&
<a name="l00059"></a>00059 c.<a class="code" href="classKTextEditor_1_1CompletionEntry.html#o5">userdata</a> == userdata);
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061 };
<a name="l00062"></a>00062
<a name="l00086"></a><a class="code" href="classKTextEditor_1_1CodeCompletionInterface.html">00086</a> <span class="keyword">class </span>KTEXTEDITOR_EXPORT CodeCompletionInterface
<a name="l00087"></a>00087 {
<a name="l00088"></a><a class="code" href="classKTextEditor_1_1CodeCompletionInterface.html#n0">00088</a> <span class="keyword">friend</span> <span class="keyword">class </span>PrivateCodeCompletionInterface;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keyword">public</span>:
<a name="l00091"></a>00091 CodeCompletionInterface();
<a name="l00092"></a>00092 <span class="keyword">virtual</span> ~CodeCompletionInterface();
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> codeCompletionInterfaceNumber () <span class="keyword">const</span>;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keyword">protected</span>:
<a name="l00097"></a>00097 <span class="keywordtype">void</span> setCodeCompletionInterfaceDCOPSuffix (<span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qcstring.html">QCString</a> &suffix);
<a name="l00098"></a>00098
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keyword">public</span>:
<a name="l00101"></a>00101 <span class="comment">//</span>
<a name="l00102"></a>00102 <span class="comment">// slots !!!</span>
<a name="l00103"></a>00103 <span class="comment">//</span>
<a name="l00107"></a>00107 <span class="comment"></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> showArgHint (<a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> functionList, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a>& strWrapping, <span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a>& strDelimiter) = 0;
<a name="l00108"></a>00108
<a name="l00115"></a>00115 <span class="keyword">virtual</span> <span class="keywordtype">void</span> showCompletionBox (<a class="codeRef" doxygen="qt.tag:" href="qvaluelist.html">QValueList<CompletionEntry></a> complList,<span class="keywordtype">int</span> offset=0, <span class="keywordtype">bool</span> casesensitive=<span class="keyword">true</span>)=0;
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">//</span>
<a name="l00118"></a>00118 <span class="comment">// signals !!!</span>
<a name="l00119"></a>00119 <span class="comment">//</span>
<a name="l00120"></a>00120 <span class="keyword">public</span>:
<a name="l00121"></a>00121
<a name="l00122"></a>00122
<a name="l00133"></a>00133 <span class="keyword">virtual</span> <span class="keywordtype">void</span> completionAborted()=0;
<a name="l00134"></a>00134
<a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">void</span> completionDone()=0;
<a name="l00147"></a>00147
<a name="l00162"></a>00162 <span class="keyword">virtual</span> <span class="keywordtype">void</span> completionDone(CompletionEntry)=0;
<a name="l00163"></a>00163
<a name="l00174"></a>00174 <span class="keyword">virtual</span> <span class="keywordtype">void</span> argHintHidden()=0;
<a name="l00175"></a>00175
<a name="l00189"></a>00189 <span class="keyword">virtual</span> <span class="keywordtype">void</span> filterInsertString(CompletionEntry*,<a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a>*)=0;
<a name="l00190"></a>00190
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="keyword">private</span>:
<a name="l00193"></a>00193 <span class="keyword">class </span>PrivateCodeCompletionInterface *d;
<a name="l00194"></a>00194 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> globalCodeCompletionInterfaceNumber;
<a name="l00195"></a>00195 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myCodeCompletionInterfaceNumber;
<a name="l00196"></a>00196 };
<a name="l00197"></a>00197
<a name="l00198"></a>00198 KTEXTEDITOR_EXPORT CodeCompletionInterface *<a class="code" href="namespaceKTextEditor.html#a30">codeCompletionInterface</a> (<span class="keyword">class</span> <a class="code" href="classKTextEditor_1_1View.html">View</a> *view);
<a name="l00199"></a>00199
<a name="l00200"></a>00200 }
<a name="l00201"></a>00201
<a name="l00202"></a>00202 <span class="preprocessor">#endif</span>
</pre></div> </div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>interfaces/ktexteditor</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="dirs.html">Directories</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</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="classEditorChooser__UI.html">editorchooser__ui</option>, <option value="classKTextEditor_1_1BlockSelectionDCOPInterface.html">ktexteditor::blockselectiondcopinterface</option>, <option value="classKTextEditor_1_1BlockSelectionInterface.html">ktexteditor::blockselectioninterface</option>, <option value="classKTextEditor_1_1ClipboardDCOPInterface.html">ktexteditor::clipboarddcopinterface</option>, <option value="classKTextEditor_1_1ClipboardInterface.html">ktexteditor::clipboardinterface</option>, <option value="classKTextEditor_1_1CodeCompletionInterface.html">ktexteditor::codecompletioninterface</option>, <option value="classKTextEditor_1_1CompletionEntry.html">ktexteditor::completionentry</option>, <option value="classKTextEditor_1_1ConfigInterface.html">ktexteditor::configinterface</option>, <option value="classKTextEditor_1_1ConfigInterfaceExtension.html">ktexteditor::configinterfaceextension</option>, <option value="classKTextEditor_1_1ConfigPage.html">ktexteditor::configpage</option>, <option value="classKTextEditor_1_1Cursor.html">ktexteditor::cursor</option>, <option value="classKTextEditor_1_1CursorInterface.html">ktexteditor::cursorinterface</option>, <option value="classKTextEditor_1_1Document.html">ktexteditor::document</option>, <option value="classKTextEditor_1_1DocumentInfoDCOPInterface.html">ktexteditor::documentinfodcopinterface</option>, <option value="classKTextEditor_1_1DocumentInfoInterface.html">ktexteditor::documentinfointerface</option>, <option value="classKTextEditor_1_1DynWordWrapInterface.html">ktexteditor::dynwordwrapinterface</option>, <option value="classKTextEditor_1_1EditDCOPInterface.html">ktexteditor::editdcopinterface</option>, <option value="classKTextEditor_1_1EditInterface.html">ktexteditor::editinterface</option>, <option value="classKTextEditor_1_1EditInterfaceExt.html">ktexteditor::editinterfaceext</option>, <option value="classKTextEditor_1_1Editor.html">ktexteditor::editor</option>, <option value="classKTextEditor_1_1EditorChooser.html">ktexteditor::editorchooser</option>, <option value="classKTextEditor_1_1EncodingDCOPInterface.html">ktexteditor::encodingdcopinterface</option>, <option value="classKTextEditor_1_1EncodingInterface.html">ktexteditor::encodinginterface</option>, <option value="classKTextEditor_1_1HighlightingInterface.html">ktexteditor::highlightinginterface</option>, <option value="classKTextEditor_1_1Mark.html">ktexteditor::mark</option>, <option value="classKTextEditor_1_1MarkInterface.html">ktexteditor::markinterface</option>, <option value="classKTextEditor_1_1MarkInterfaceExtension.html">ktexteditor::markinterfaceextension</option>, <option value="classKTextEditor_1_1Plugin.html">ktexteditor::plugin</option>, <option value="classKTextEditor_1_1PluginViewInterface.html">ktexteditor::pluginviewinterface</option>, <option value="classKTextEditor_1_1PopupMenuInterface.html">ktexteditor::popupmenuinterface</option>, <option value="classKTextEditor_1_1PrintDCOPInterface.html">ktexteditor::printdcopinterface</option>, <option value="classKTextEditor_1_1PrintInterface.html">ktexteditor::printinterface</option>, <option value="classKTextEditor_1_1SearchDCOPInterface.html">ktexteditor::searchdcopinterface</option>, <option value="classKTextEditor_1_1SearchInterface.html">ktexteditor::searchinterface</option>, <option value="classKTextEditor_1_1SelectionDCOPInterface.html">ktexteditor::selectiondcopinterface</option>, <option value="classKTextEditor_1_1SelectionExtDCOPInterface.html">ktexteditor::selectionextdcopinterface</option>, <option value="classKTextEditor_1_1SelectionInterface.html">ktexteditor::selectioninterface</option>, <option value="classKTextEditor_1_1SelectionInterfaceExt.html">ktexteditor::selectioninterfaceext</option>, <option value="classKTextEditor_1_1SessionConfigInterface.html">ktexteditor::sessionconfiginterface</option>, <option value="classKTextEditor_1_1TemplateInterface.html">ktexteditor::templateinterface</option>, <option value="classKTextEditor_1_1TextHintInterface.html">ktexteditor::texthintinterface</option>, <option value="classKTextEditor_1_1UndoDCOPInterface.html">ktexteditor::undodcopinterface</option>, <option value="classKTextEditor_1_1UndoInterface.html">ktexteditor::undointerface</option>, <option value="classKTextEditor_1_1VariableInterface.html">ktexteditor::variableinterface</option>, <option value="classKTextEditor_1_1View.html">ktexteditor::view</option>, <option value="classKTextEditor_1_1ViewCursorDCOPInterface.html">ktexteditor::viewcursordcopinterface</option>, <option value="classKTextEditor_1_1ViewCursorInterface.html">ktexteditor::viewcursorinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgDCOPInterface.html">ktexteditor::viewstatusmsgdcopinterface</option>, <option value="classKTextEditor_1_1ViewStatusMsgInterface.html">ktexteditor::viewstatusmsginterface</option>, <option value="classKTextEditor_1_1WordWrapInterface.html">ktexteditor::wordwrapinterface</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>
distrib
>
PLD
>
ac
>
amd64
>
media
>
dist
>
by-pkgid
>
90467ea6a387df728f7218a11e972208
>
files
>
994
