<?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: markinterface.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.5.5 --> <h1>markinterface.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of the KDE project</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2001 Christoph Cullmann (cullmann@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 as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public License</span> <a name="l00015"></a>00015 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span> <a name="l00016"></a>00016 <span class="comment"> the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,</span> <a name="l00017"></a>00017 <span class="comment"> Boston, MA 02110-1301, USA.</span> <a name="l00018"></a>00018 <span class="comment">*/</span> <a name="l00019"></a>00019 <a name="l00020"></a>00020 <span class="preprocessor">#ifndef __ktexteditor_markinterface_h__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __ktexteditor_markinterface_h__</span> <a name="l00022"></a>00022 <span class="preprocessor"></span> <a name="l00023"></a>00023 <span class="preprocessor">#include <qptrlist.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">class </span><a class="codeRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qcstring.html">QCString</a>; <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="keyword">namespace </span>KTextEditor <a name="l00030"></a>00030 { <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="keyword">class </span>Mark <a name="l00033"></a>00033 { <a name="l00034"></a>00034 <span class="keyword">public</span>: <a name="l00035"></a>00035 uint line; <a name="l00036"></a>00036 uint type; <a name="l00037"></a>00037 }; <a name="l00038"></a>00038 <a name="l00042"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html">00042</a> <span class="keyword">class </span>KTEXTEDITOR_EXPORT <a class="code" href="classKTextEditor_1_1MarkInterface.html" title="This is an interface to enable marks to be made in the iconborder of the Document...">MarkInterface</a> <a name="l00043"></a>00043 { <a name="l00044"></a>00044 <span class="keyword">friend</span> <span class="keyword">class </span>PrivateMarkInterface; <a name="l00045"></a>00045 <a name="l00046"></a>00046 <span class="keyword">public</span>: <a name="l00047"></a>00047 <a class="code" href="classKTextEditor_1_1MarkInterface.html" title="This is an interface to enable marks to be made in the iconborder of the Document...">MarkInterface</a> (); <a name="l00048"></a>00048 <span class="keyword">virtual</span> ~<a class="code" href="classKTextEditor_1_1MarkInterface.html" title="This is an interface to enable marks to be made in the iconborder of the Document...">MarkInterface</a> (); <a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> markInterfaceNumber () <span class="keyword">const</span>; <a name="l00051"></a>00051 <a name="l00052"></a>00052 <span class="keyword">protected</span>: <a name="l00053"></a>00053 <span class="keywordtype">void</span> setMarkInterfaceDCOPSuffix (<span class="keyword">const</span> <a class="codeRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qcstring.html">QCString</a> &suffix); <a name="l00054"></a>00054 <a name="l00055"></a>00055 <span class="comment">//</span> <a name="l00056"></a>00056 <span class="comment">// slots !!!</span> <a name="l00057"></a>00057 <span class="comment">//</span> <a name="l00058"></a>00058 <span class="keyword">public</span>: <a name="l00062"></a>00062 <span class="keyword">virtual</span> uint mark (uint line) = 0; <a name="l00063"></a>00063 <a name="l00068"></a>00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setMark (uint line, uint markType) = 0; <a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearMark (uint line) = 0; <a name="l00073"></a>00073 <a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> addMark (uint line, uint markType) = 0; <a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">void</span> removeMark (uint line, uint markType) = 0; <a name="l00079"></a>00079 <a name="l00083"></a>00083 <span class="keyword">virtual</span> <a class="codeRef" doxygen="qt.tag:/usr/lib/qt3/doc/html/" href="/usr/lib/qt3/doc/html/qptrlist.html">QPtrList<KTextEditor::Mark></a> marks () = 0; <a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">void</span> clearMarks () = 0; <a name="l00088"></a>00088 <a name="l00095"></a>00095 <span class="keyword">static</span> <span class="keywordtype">int</span> reservedMarkersCount(); <a name="l00096"></a>00096 <a name="l00103"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee">00103</a> <span class="keyword">enum</span> <a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee" title="Pre-defined mark types.">MarkTypes</a> <a name="l00104"></a>00104 { <a name="l00106"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8eef2471aab55a7910fb4450d51cce8dc59">00106</a> markType01= 0x1, <a name="l00108"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee23c07e24da915076047cd921c4621a8b">00108</a> markType02= 0x2, <a name="l00110"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee8971a6d13db24fe3fe95bc2f9c6c3805">00110</a> markType03= 0x4, <a name="l00112"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee21889afbe7e38f38b4e901db153ea4ab">00112</a> markType04= 0x8, <a name="l00114"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee4ef62f766de25a6f7e950d921995b498">00114</a> markType05= 0x10, <a name="l00116"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee068ec7d831882c520248faecf0becf5d">00116</a> markType06= 0x20, <a name="l00118"></a><a class="code" href="classKTextEditor_1_1MarkInterface.html#273ff5baa46445732d5661390bc1b8ee13b4ecc91bdb3a791b5726cf9de5f81b">00118</a> markType07= 0x40, <a name="l00119"></a>00119 <a name="l00120"></a>00120 markType08= 0x80, <a name="l00121"></a>00121 markType09= 0x100, <a name="l00122"></a>00122 markType10= 0x200, <a name="l00123"></a>00123 markType11= 0x400, <a name="l00124"></a>00124 markType12= 0x800, <a name="l00125"></a>00125 markType13= 0x1000, <a name="l00126"></a>00126 markType14= 0x2000, <a name="l00127"></a>00127 markType15= 0x4000, <a name="l00128"></a>00128 markType16= 0x8000, <a name="l00129"></a>00129 markType17= 0x10000, <a name="l00130"></a>00130 markType18= 0x20000, <a name="l00131"></a>00131 markType19= 0x40000, <a name="l00132"></a>00132 markType20= 0x80000, <a name="l00133"></a>00133 markType21= 0x100000, <a name="l00134"></a>00134 markType22= 0x200000, <a name="l00135"></a>00135 markType23= 0x400000, <a name="l00136"></a>00136 markType24= 0x800000, <a name="l00137"></a>00137 markType25= 0x1000000, <a name="l00138"></a>00138 markType26= 0x2000000, <a name="l00139"></a>00139 markType27= 0x4000000, <a name="l00140"></a>00140 markType28= 0x8000000, <a name="l00141"></a>00141 markType29= 0x10000000, <a name="l00142"></a>00142 markType30= 0x20000000, <a name="l00143"></a>00143 markType31= 0x40000000, <a name="l00144"></a>00144 markType32= 0x80000000, <a name="l00145"></a>00145 <span class="comment">/* reserved marks */</span> <a name="l00146"></a>00146 Bookmark = markType01, <a name="l00147"></a>00147 BreakpointActive = markType02, <a name="l00148"></a>00148 BreakpointReached = markType03, <a name="l00149"></a>00149 BreakpointDisabled = markType04, <a name="l00150"></a>00150 Execution = markType05, <a name="l00151"></a>00151 Warning = markType06, <a name="l00152"></a>00152 Error = markType07 <a name="l00153"></a>00153 }; <a name="l00154"></a>00154 <a name="l00155"></a>00155 <span class="comment">//</span> <a name="l00156"></a>00156 <span class="comment">// signals !!!</span> <a name="l00157"></a>00157 <span class="comment">//</span> <a name="l00158"></a>00158 <span class="keyword">public</span>: <a name="l00159"></a>00159 <span class="keyword">virtual</span> <span class="keywordtype">void</span> marksChanged () = 0; <a name="l00160"></a>00160 <a name="l00161"></a>00161 <span class="keyword">private</span>: <a name="l00162"></a>00162 <span class="keyword">class </span>PrivateMarkInterface *d; <a name="l00163"></a>00163 <span class="keyword">static</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> globalMarkInterfaceNumber; <a name="l00164"></a>00164 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> myMarkInterfaceNumber; <a name="l00165"></a>00165 }; <a name="l00166"></a>00166 <a name="l00167"></a>00167 KTEXTEDITOR_EXPORT MarkInterface *markInterface (<span class="keyword">class</span> Document *doc); <a name="l00168"></a>00168 <a name="l00169"></a>00169 } <a name="l00170"></a>00170 <a name="l00171"></a>00171 <span class="preprocessor">#endif</span> </pre></div></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="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="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_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_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_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>