<?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: document.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">document.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) 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 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 _KATE_DOCUMENT_INCLUDE_</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define _KATE_DOCUMENT_INCLUDE_</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <ktexteditor/document.h></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <ktexteditor/view.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <ktexteditor/editinterface.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <ktexteditor/undointerface.h></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <ktexteditor/cursorinterface.h></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <ktexteditor/documentinfo.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <ktexteditor/selectioninterface.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <ktexteditor/selectioninterfaceext.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <ktexteditor/blockselectioninterface.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <ktexteditor/searchinterface.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <ktexteditor/highlightinginterface.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <ktexteditor/configinterface.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <ktexteditor/configinterfaceextension.h></span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <ktexteditor/markinterface.h></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <ktexteditor/markinterfaceextension.h></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <ktexteditor/wordwrapinterface.h></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <ktexteditor/printinterface.h></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include <ktexteditor/variableinterface.h></span>
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="preprocessor">#include <kaction.h></span>
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keyword">class </span><a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a>;
<a name="l00044"></a>00044
<a name="l00050"></a><a class="code" href="namespaceKate.html">00050</a> <span class="keyword">namespace </span>Kate
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keyword">class </span><a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">View</a>;
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT Cursor : <span class="keyword">public</span> KTextEditor::Cursor
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 <span class="keyword">public</span>:
<a name="l00058"></a>00058 Cursor () { ; };
<a name="l00059"></a>00059 <span class="keyword">virtual</span> ~Cursor () { ; };
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT ConfigPage : <span class="keyword">public</span> KTextEditor::ConfigPage
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064 Q_OBJECT
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">public</span>:
<a name="l00067"></a>00067 ConfigPage ( <a class="codeRef" href="qwidget.html">QWidget</a> *parent=0, <span class="keyword">const</span> <span class="keywordtype">char</span> *name=0 ) : KTextEditor::ConfigPage (parent, name) { ; };
<a name="l00068"></a>00068 <span class="keyword">virtual</span> ~ConfigPage () { ; };
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keyword">public</span> slots:
<a name="l00071"></a>00071 <span class="keyword">virtual</span> <span class="keywordtype">void</span> apply () { ; };
<a name="l00072"></a>00072 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reload () { ; };
<a name="l00073"></a>00073 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset () {};
<a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> defaults () {};
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">protected</span> slots:
<a name="l00077"></a>00077 <span class="keywordtype">void</span> slotChanged();
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT ActionMenu : <span class="keyword">public</span> <a class="codeRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKActionMenu.html">KActionMenu</a>
<a name="l00081"></a>00081 {
<a name="l00082"></a>00082 Q_OBJECT
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">public</span>:
<a name="l00085"></a>00085 ActionMenu ( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& text, <a class="codeRef" href="qobject.html">QObject</a>* parent = 0, <span class="keyword">const</span> <span class="keywordtype">char</span>* name = 0 )
<a name="l00086"></a>00086 : <a class="codeRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKActionMenu.html">KActionMenu</a>(text, parent, name) { ; };
<a name="l00087"></a>00087 <span class="keyword">virtual</span> ~ActionMenu () { ; };
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">public</span>:
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <span class="keywordtype">void</span> updateMenu (<span class="keyword">class</span> <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> *) = 0;
<a name="l00091"></a>00091 };
<a name="l00092"></a>00092
<a name="l00096"></a><a class="code" href="classKate_1_1Command.html">00096</a> <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT <a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a>
<a name="l00097"></a>00097 {
<a name="l00098"></a>00098 <span class="keyword">public</span>:
<a name="l00099"></a>00099 <a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> () {};
<a name="l00100"></a>00100 <span class="keyword">virtual</span> ~<a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> () {};
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">public</span>:
<a name="l00107"></a>00107 <span class="keyword">virtual</span> <a class="codeRef" href="qstringlist.html">QStringList</a> cmds () = 0;
<a name="l00108"></a>00108
<a name="l00113"></a>00113 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> exec (<a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">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> &msg) = 0;
<a name="l00114"></a>00114
<a name="l00119"></a>00119 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> help (<a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">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> &msg) = 0;
<a name="l00120"></a>00120 };
<a name="l00121"></a>00121
<a name="l00129"></a><a class="code" href="classKate_1_1CommandExtension.html">00129</a> <span class="keyword">class </span><a class="code" href="classKate_1_1CommandExtension.html" title="Extension to the Command interface, allowing to interact with commands during typing.">CommandExtension</a>
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131 <span class="keyword">public</span>:
<a name="l00132"></a>00132 <a class="code" href="classKate_1_1CommandExtension.html" title="Extension to the Command interface, allowing to interact with commands during typing.">CommandExtension</a>() {;}
<a name="l00133"></a>00133 <span class="keyword">virtual</span> ~<a class="code" href="classKate_1_1CommandExtension.html" title="Extension to the Command interface, allowing to interact with commands during typing.">CommandExtension</a>() {;}
<a name="l00134"></a>00134 <span class="comment">//### this is yet to be tried</span>
<a name="l00146"></a><a class="code" href="classKate_1_1CommandExtension.html#afb01bd9e4664ceda26cf08725e0d4107">00146</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKate_1_1CommandExtension.html#afb01bd9e4664ceda26cf08725e0d4107" title="Fill in a list of flags to complete from.">flagCompletions</a>( <a class="codeRef" href="qstringlist.html">QStringList</a>& <span class="comment">/*list*/</span> ) {;}
<a name="l00147"></a>00147
<a name="l00157"></a><a class="code" href="classKate_1_1CommandExtension.html#aed60e496bd7c3a5f29bbe3ba8d8cda85">00157</a> <span class="keyword">virtual</span> <a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKCompletion.html">KCompletion</a> *<a class="code" href="classKate_1_1CommandExtension.html#aed60e496bd7c3a5f29bbe3ba8d8cda85">completionObject</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> & cmdname, <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">Kate::View</a> * <span class="comment">/*view*/</span> ) { Q_UNUSED(cmdname); <span class="keywordflow">return</span> 0L; }
<a name="l00158"></a>00158
<a name="l00169"></a><a class="code" href="classKate_1_1CommandExtension.html#a4ebff8321ad1dc0d545d8d2935c6fcdb">00169</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classKate_1_1CommandExtension.html#a4ebff8321ad1dc0d545d8d2935c6fcdb">wantsToProcessText</a>( <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmdname ) { Q_UNUSED(cmdname); <span class="keywordflow">return</span> <span class="keyword">false</span>; }
<a name="l00170"></a>00170 <span class="comment">// ### yet to be tested. The obvious candidate is isearch.</span>
<a name="l00177"></a><a class="code" href="classKate_1_1CommandExtension.html#a244c8d4538276eab42340aadae3c5dbf">00177</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" 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>( <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> &text ) { Q_UNUSED(view); Q_UNUSED(text); }
<a name="l00178"></a>00178 };
<a name="l00179"></a>00179
<a name="l00182"></a><a class="code" href="classKate_1_1Document.html">00182</a> <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> : <span class="keyword">public</span> KTextEditor::<a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a>, <span class="keyword">public</span> KTextEditor::EditInterface,
<a name="l00183"></a>00183 <span class="keyword">public</span> KTextEditor::UndoInterface, <span class="keyword">public</span> KTextEditor::CursorInterface,
<a name="l00184"></a>00184 <span class="keyword">public</span> KTextEditor::SelectionInterface, <span class="keyword">public</span> KTextEditor::SearchInterface,
<a name="l00185"></a>00185 <span class="keyword">public</span> KTextEditor::HighlightingInterface, <span class="keyword">public</span> KTextEditor::BlockSelectionInterface,
<a name="l00186"></a>00186 <span class="keyword">public</span> KTextEditor::ConfigInterface, <span class="keyword">public</span> KTextEditor::MarkInterface,
<a name="l00187"></a>00187 <span class="keyword">public</span> KTextEditor::PrintInterface, <span class="keyword">public</span> KTextEditor::WordWrapInterface,
<a name="l00188"></a>00188 <span class="keyword">public</span> KTextEditor::MarkInterfaceExtension,
<a name="l00189"></a>00189 <span class="keyword">public</span> KTextEditor::SelectionInterfaceExt
<a name="l00190"></a>00190 {
<a name="l00191"></a>00191 Q_OBJECT
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">public</span>:
<a name="l00194"></a>00194 <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> ();
<a name="l00195"></a>00195 <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> ( <a class="codeRef" href="qobject.html">QObject</a>* parent, <span class="keyword">const</span> <span class="keywordtype">char</span>* name );
<a name="l00196"></a>00196 <span class="keyword">virtual</span> ~<a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> ();
<a name="l00197"></a>00197
<a name="l00201"></a>00201 <span class="keyword">public</span>:
<a name="l00202"></a>00202 <span class="keyword">static</span> <span class="keywordtype">bool</span> registerCommand (<a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> *cmd);
<a name="l00203"></a>00203 <span class="keyword">static</span> <span class="keywordtype">bool</span> unregisterCommand (<a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> *cmd);
<a name="l00204"></a>00204 <span class="keyword">static</span> <a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> *queryCommand (<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &cmd);
<a name="l00205"></a>00205
<a name="l00206"></a>00206 <span class="keyword">public</span>:
<a name="l00212"></a><a class="code" href="classKate_1_1Document.html#a47625665ba93e87a7afb17348cf0946c">00212</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKate_1_1Document.html#a47625665ba93e87a7afb17348cf0946c" title="deprecated for KDE 4.0, just does reloadFile, which will ask the normal "do you want it really" quest...">isModOnHD</a>(<span class="keywordtype">bool</span> =<span class="keyword">false</span>) { ; };
<a name="l00213"></a>00213
<a name="l00217"></a><a class="code" href="classKate_1_1Document.html#afaf167a2b2cf8179d9abae3630fde03c">00217</a> <span class="keyword">virtual</span> <a class="codeRef" href="qstring.html">QString</a> <a class="code" href="classKate_1_1Document.html#afaf167a2b2cf8179d9abae3630fde03c" title="Returns the document name.">docName</a> () { <span class="keywordflow">return</span> 0L; };
<a name="l00218"></a>00218
<a name="l00225"></a><a class="code" href="classKate_1_1Document.html#a4cff7d933d894cefdfd7d19e0b87ca96">00225</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKate_1_1Document.html#a4cff7d933d894cefdfd7d19e0b87ca96" title="Sets the document name.">setDocName</a> (<a class="codeRef" href="qstring.html">QString</a> ) { ; };
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="keyword">virtual</span> ActionMenu *hlActionMenu (<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& , <a class="codeRef" href="qobject.html">QObject</a>* =0, <span class="keyword">const</span> <span class="keywordtype">char</span>* = 0) = 0;
<a name="l00228"></a>00228 <span class="keyword">virtual</span> ActionMenu *exportActionMenu (<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& , <a class="codeRef" href="qobject.html">QObject</a>* =0, <span class="keyword">const</span> <span class="keywordtype">char</span>* = 0) = 0;
<a name="l00229"></a>00229
<a name="l00230"></a>00230 <span class="keyword">public</span> slots:
<a name="l00231"></a>00231 <span class="comment">// clear buffer/filename - update the views</span>
<a name="l00232"></a>00232 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/group__kdebug.html#gaf53d1ae81fafe4440579b2f073358c78">flush</a> () { ; };
<a name="l00233"></a>00233
<a name="l00237"></a>00237 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reloadFile() = 0;
<a name="l00238"></a>00238
<a name="l00242"></a><a class="code" href="classKate_1_1Document.html#a75421666e05ff69aff63d0373ba190ad">00242</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classKate_1_1Document.html#a75421666e05ff69aff63d0373ba190ad" title="Spellchecking.">spellcheck</a>() {};
<a name="l00243"></a>00243
<a name="l00244"></a>00244 <span class="keyword">virtual</span> <span class="keywordtype">void</span> exportAs(<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &) = 0;
<a name="l00245"></a>00245
<a name="l00246"></a>00246 <span class="keyword">virtual</span> <span class="keywordtype">void</span> applyWordWrap () = 0;
<a name="l00247"></a>00247
<a name="l00248"></a>00248
<a name="l00249"></a>00249 <span class="keyword">public</span>:
<a name="l00250"></a>00250 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setWordWrap (<span class="keywordtype">bool</span> ) = 0;
<a name="l00251"></a>00251 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> wordWrap () = 0;
<a name="l00252"></a>00252
<a name="l00253"></a>00253 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setWordWrapAt (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) = 0;
<a name="l00254"></a>00254 <span class="keyword">virtual</span> uint wordWrapAt () = 0;
<a name="l00255"></a>00255
<a name="l00256"></a>00256
<a name="l00257"></a>00257 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setEncoding (<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &e) = 0;
<a name="l00258"></a>00258 <span class="keyword">virtual</span> <a class="codeRef" href="qstring.html">QString</a> encoding() <span class="keyword">const</span> = 0;
<a name="l00259"></a>00259
<a name="l00261"></a>00261 <span class="comment">// FIXME: Remove when BIC allowed.</span>
<a name="l00262"></a>00262 <span class="keyword">public</span>:
<a name="l00264"></a>00264 <span class="keyword">virtual</span> ConfigPage *colorConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00266"></a>00266 <span class="keyword">virtual</span> ConfigPage *fontConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00268"></a>00268 <span class="keyword">virtual</span> ConfigPage *indentConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00270"></a>00270 <span class="keyword">virtual</span> ConfigPage *selectConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00272"></a>00272 <span class="keyword">virtual</span> ConfigPage *editConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00274"></a>00274 <span class="keyword">virtual</span> ConfigPage *keysConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00276"></a><a class="code" href="classKate_1_1Document.html#a427ea6ceeb3d594876590a561abcf050">00276</a> <span class="keyword">virtual</span> ConfigPage *<a class="code" href="classKate_1_1Document.html#a427ea6ceeb3d594876590a561abcf050">kSpellConfigPage</a> (<a class="codeRef" href="qwidget.html">QWidget</a> *) { <span class="keywordflow">return</span> 0L; }
<a name="l00278"></a>00278 <span class="keyword">virtual</span> ConfigPage *hlConfigPage (<a class="codeRef" href="qwidget.html">QWidget</a> *) = 0;
<a name="l00279"></a>00279
<a name="l00280"></a>00280 <span class="keyword">public</span>:
<a name="l00281"></a>00281 <span class="keyword">virtual</span> uint configFlags () = 0;
<a name="l00282"></a>00282 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setConfigFlags (uint flags) = 0;
<a name="l00283"></a>00283
<a name="l00284"></a>00284 <span class="comment">// Flags for katedocument config !</span>
<a name="l00285"></a>00285 <span class="keyword">enum</span> ConfigFlags
<a name="l00286"></a>00286 {
<a name="l00287"></a>00287 cfAutoIndent= 0x1,
<a name="l00288"></a>00288 cfBackspaceIndents= 0x2,
<a name="l00289"></a>00289 cfWordWrap= 0x4,
<a name="l00290"></a>00290 cfReplaceTabs= 0x8,
<a name="l00291"></a>00291 cfRemoveSpaces = 0x10,
<a name="l00292"></a>00292 cfWrapCursor= 0x20,
<a name="l00293"></a>00293 cfAutoBrackets= 0x40,
<a name="l00294"></a>00294 cfPersistent= 0x80,
<a name="l00295"></a>00295 cfKeepSelection= 0x100,
<a name="l00296"></a>00296 cfDelOnInput= 0x400,
<a name="l00297"></a>00297 cfXorSelect= 0x800,
<a name="l00298"></a>00298 cfOvr= 0x1000,
<a name="l00299"></a>00299 cfMark= 0x2000,
<a name="l00300"></a>00300 cfKeepIndentProfile= 0x8000,
<a name="l00301"></a>00301 cfKeepExtraSpaces= 0x10000,
<a name="l00302"></a>00302 cfTabIndents= 0x80000,
<a name="l00303"></a>00303 cfShowTabs= 0x200000,
<a name="l00304"></a>00304 cfSpaceIndent= 0x400000,
<a name="l00305"></a>00305 cfSmartHome = 0x800000
<a name="l00306"></a>00306 };
<a name="l00307"></a>00307
<a name="l00308"></a>00308 signals:
<a name="l00319"></a>00319 <span class="keywordtype">void</span> modifiedOnDisc (<a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Kate::Document</a> *doc, <span class="keywordtype">bool</span> isModified, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> reason);
<a name="l00320"></a>00320
<a name="l00321"></a>00321 <span class="comment">/*</span>
<a name="l00322"></a>00322 <span class="comment"> * there static methodes are usefull to turn on/off the dialogs</span>
<a name="l00323"></a>00323 <span class="comment"> * kate part shows up on open file errors + file changed warnings</span>
<a name="l00324"></a>00324 <span class="comment"> * open file errors default on, file changed warnings default off, better</span>
<a name="l00325"></a>00325 <span class="comment"> * for other apps beside kate app using the part</span>
<a name="l00326"></a>00326 <span class="comment"> */</span>
<a name="l00327"></a>00327 <span class="keyword">public</span>:
<a name="l00328"></a>00328 <span class="comment">// default true</span>
<a name="l00329"></a>00329 <span class="keyword">static</span> <span class="keywordtype">void</span> setOpenErrorDialogsActivated (<span class="keywordtype">bool</span> on);
<a name="l00330"></a>00330
<a name="l00331"></a>00331 <span class="comment">// default false</span>
<a name="l00332"></a>00332 <span class="keyword">static</span> <span class="keywordtype">void</span> setFileChangedDialogsActivated (<span class="keywordtype">bool</span> on);
<a name="l00333"></a>00333
<a name="l00334"></a>00334 <span class="keyword">static</span> <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &defaultEncoding ();
<a name="l00335"></a>00335
<a name="l00336"></a>00336 <span class="keyword">protected</span>:
<a name="l00337"></a>00337 <span class="keyword">static</span> <span class="keywordtype">bool</span> s_openErrorDialogsActivated;
<a name="l00338"></a>00338 <span class="keyword">static</span> <span class="keywordtype">bool</span> s_fileChangedDialogsActivated;
<a name="l00339"></a>00339
<a name="l00340"></a>00340 <span class="keyword">static</span> <a class="codeRef" href="qstring.html">QString</a> s_defaultEncoding;
<a name="l00341"></a>00341 };
<a name="l00342"></a>00342
<a name="l00347"></a><a class="code" href="classKate_1_1DocumentExt.html">00347</a> <span class="keyword">class </span>KATEPARTINTERFACES_EXPORT <a class="code" href="classKate_1_1DocumentExt.html" title="Extensions to the Document Interface.">DocumentExt</a>
<a name="l00348"></a>00348 : <span class="keyword">public</span> KTextEditor::DocumentInfoInterface,
<a name="l00349"></a>00349 <span class="keyword">public</span> KTextEditor::VariableInterface
<a name="l00350"></a>00350 {
<a name="l00351"></a>00351 <span class="keyword">public</span>:
<a name="l00352"></a>00352 <a class="code" href="classKate_1_1DocumentExt.html" title="Extensions to the Document Interface.">DocumentExt</a> ();
<a name="l00353"></a>00353 <span class="keyword">virtual</span> ~<a class="code" href="classKate_1_1DocumentExt.html" title="Extensions to the Document Interface.">DocumentExt</a> ();
<a name="l00354"></a>00354
<a name="l00355"></a>00355 <span class="keyword">public</span>:
<a name="l00359"></a><a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8">00359</a> <span class="keyword">enum</span> <a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8" title="Reasons why a document is modified on disk.">ModifiedOnDiskReason</a> {
<a name="l00360"></a><a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8a3efe923cbfad136cc5604a61c5833e73">00360</a> Unmodified = 0,
<a name="l00361"></a><a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8a4a2df0a2f534458bc231e2b0324096f9">00361</a> Modified = 1,
<a name="l00362"></a><a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8a50d2877b477d3a74c0cfa95604263060">00362</a> Created = 2,
<a name="l00363"></a><a class="code" href="classKate_1_1DocumentExt.html#a06dbce3b2a9a2c549825a218bed976c8af61aea78e85a32c45942d5ad8fde65c5">00363</a> Deleted = 3
<a name="l00364"></a>00364 };
<a name="l00365"></a>00365
<a name="l00366"></a>00366 <span class="keyword">public</span>:
<a name="l00372"></a>00372 <span class="keyword">virtual</span> <span class="keywordtype">void</span> setModifiedOnDisk( <span class="keywordtype">int</span> reason ) = 0;
<a name="l00373"></a>00373
<a name="l00377"></a>00377 <span class="keyword">public</span>:
<a name="l00383"></a>00383 <span class="keyword">virtual</span> <span class="keywordtype">void</span> slotModifiedOnDisk( <a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">View</a> *v=0 ) = 0;
<a name="l00384"></a>00384 };
<a name="l00385"></a>00385
<a name="l00391"></a>00391 KATEPARTINTERFACES_EXPORT Document *<a class="code" href="namespaceKate.html#ad306089790b58359649832786779633e" title="Check if given document is a Kate::Document.">document</a> (KTextEditor::Document *doc);
<a name="l00392"></a>00392
<a name="l00398"></a>00398 KATEPARTINTERFACES_EXPORT DocumentExt *<a class="code" href="namespaceKate.html#acd2b771c19ff885dc36b07e17f78b0cb" title="Check if given document is a Kate::DocumentExt.">documentExt</a> (KTextEditor::Document *doc);
<a name="l00399"></a>00399
<a name="l00403"></a>00403 KATEPARTINTERFACES_EXPORT Document *<a class="code" href="namespaceKate.html#a6ed24f1ef4fae42da00221d2afb66fcb" title="Creates a new Kate::Document object.">createDocument</a> ( <a class="codeRef" href="qobject.html">QObject</a> *parent = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> *name = 0 );
<a name="l00404"></a>00404
<a name="l00405"></a>00405 }
<a name="l00406"></a>00406
<a name="l00407"></a>00407 <span class="preprocessor">#endif</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>
