Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 1518

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?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: interfaces.cpp 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">interfaces.cpp</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 &lt;cullmann@kde.org&gt;</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">#include &quot;document.h&quot;</span>
<a name="l00020"></a>00020 <span class="preprocessor">#include &quot;document.moc&quot;</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#include &quot;view.h&quot;</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include &quot;view.moc&quot;</span>
<a name="l00024"></a>00024 
<a name="l00025"></a>00025 <span class="preprocessor">#include &quot;katecmd.h&quot;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">namespace </span>Kate
<a name="l00028"></a>00028 {
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="keywordtype">bool</span> Document::s_openErrorDialogsActivated = <span class="keyword">true</span>;
<a name="l00031"></a>00031 <span class="keywordtype">bool</span> Document::s_fileChangedDialogsActivated = <span class="keyword">false</span>;
<a name="l00032"></a>00032 <a class="codeRef" href="qstring.html">QString</a> Document::s_defaultEncoding;
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 Document::Document (<a class="codeRef" href="qobject.html">QObject</a>* parent, <span class="keyword">const</span> <span class="keywordtype">char</span>* name)
<a name="l00035"></a>00035     : KTextEditor::Document (parent, name)
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037 }
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 Document::Document () : KTextEditor::Document (0L, <span class="stringliteral">&quot;Kate::Document&quot;</span>)
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 }
<a name="l00042"></a>00042 
<a name="l00043"></a>00043 Document::~Document ()
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046 
<a name="l00047"></a>00047 <span class="keywordtype">void</span> Document::setOpenErrorDialogsActivated (<span class="keywordtype">bool</span> on)
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049   s_openErrorDialogsActivated = on;
<a name="l00050"></a>00050 }
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="keywordtype">void</span> Document::setFileChangedDialogsActivated (<span class="keywordtype">bool</span> on)
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054   s_fileChangedDialogsActivated = on;
<a name="l00055"></a>00055 }
<a name="l00056"></a>00056 
<a name="l00057"></a>00057 <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &amp;Document::defaultEncoding ()
<a name="l00058"></a>00058 {
<a name="l00059"></a>00059   <span class="keywordflow">return</span> s_defaultEncoding;
<a name="l00060"></a>00060 }
<a name="l00061"></a>00061 
<a name="l00062"></a><a class="code" href="classKate_1_1Document.html#a61aa3a67db109b0d14a088d55a748c58">00062</a> <span class="keywordtype">bool</span> <a class="code" href="classKate_1_1Document.html#a61aa3a67db109b0d14a088d55a748c58" title="Commands handling.">Document::registerCommand</a> (<a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> *cmd)
<a name="l00063"></a>00063 {
<a name="l00064"></a>00064   <span class="keywordflow">return</span> KateCmd::self()-&gt;registerCommand (cmd);
<a name="l00065"></a>00065 }
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="keywordtype">bool</span> Document::unregisterCommand (<a class="code" href="classKate_1_1Command.html" title="Kate Commands.">Command</a> *cmd)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069   <span class="keywordflow">return</span> KateCmd::self()-&gt;unregisterCommand (cmd);
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071 
<a name="l00072"></a>00072 Command *Document::queryCommand (<span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a> &amp;cmd)
<a name="l00073"></a>00073 {
<a name="l00074"></a>00074   <span class="keywordflow">return</span> KateCmd::self()-&gt;queryCommand (cmd);
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 
<a name="l00077"></a><a class="code" href="classKate_1_1View.html#a86461288ff007976801ba4f2ee567be0">00077</a> <a class="code" href="classKate_1_1View.html#a86461288ff007976801ba4f2ee567be0" title="Constructor (should much rather take a reference to the document).">View::View</a> ( KTextEditor::Document *doc, <a class="codeRef" href="qwidget.html">QWidget</a> *parent, <span class="keyword">const</span> <span class="keywordtype">char</span> *name ) : KTextEditor::<a class="code" href="classKate_1_1View.html" title="The Kate::View text editor interface.">View</a> (doc, parent, name)
<a name="l00078"></a>00078 {
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080 
<a name="l00081"></a><a class="code" href="classKate_1_1View.html#ae91d348477899249062af3ad8ae5313d">00081</a> <a class="code" href="classKate_1_1View.html#ae91d348477899249062af3ad8ae5313d" title="Destructor, you need a destructor if Scott Meyers says so.">View::~View</a> ()
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 <span class="keywordtype">void</span> ConfigPage::slotChanged()
<a name="l00086"></a>00086 {
<a name="l00087"></a>00087   emit changed();
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 DocumentExt::DocumentExt ()
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 }
<a name="l00093"></a>00093 
<a name="l00094"></a>00094 DocumentExt::~DocumentExt ()
<a name="l00095"></a>00095 {
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097 
<a name="l00098"></a><a class="code" href="namespaceKate.html#ad306089790b58359649832786779633e">00098</a> <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> *<a class="code" href="namespaceKate.html#ad306089790b58359649832786779633e" title="Check if given document is a Kate::Document.">document</a> (KTextEditor::Document *doc)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100   <span class="keywordflow">if</span> (!doc)
<a name="l00101"></a>00101     <span class="keywordflow">return</span> 0;
<a name="l00102"></a>00102 
<a name="l00103"></a>00103   <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a>*<span class="keyword">&gt;</span>(doc-&gt;qt_cast(<span class="stringliteral">&quot;Kate::Document&quot;</span>));
<a name="l00104"></a>00104 }
<a name="l00105"></a>00105 
<a name="l00106"></a><a class="code" href="namespaceKate.html#acd2b771c19ff885dc36b07e17f78b0cb">00106</a> <a class="code" href="classKate_1_1DocumentExt.html" title="Extensions to the Document Interface.">DocumentExt</a> *<a class="code" href="namespaceKate.html#acd2b771c19ff885dc36b07e17f78b0cb" title="Check if given document is a Kate::DocumentExt.">documentExt</a> (KTextEditor::Document *doc)
<a name="l00107"></a>00107 {
<a name="l00108"></a>00108   <span class="keywordflow">if</span> (!doc)
<a name="l00109"></a>00109     <span class="keywordflow">return</span> 0;
<a name="l00110"></a>00110 
<a name="l00111"></a>00111   <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><a class="code" href="classKate_1_1DocumentExt.html" title="Extensions to the Document Interface.">DocumentExt</a>*<span class="keyword">&gt;</span>(doc-&gt;qt_cast(<span class="stringliteral">&quot;Kate::DocumentExt&quot;</span>));
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113 
<a name="l00114"></a><a class="code" href="namespaceKate.html#a6ed24f1ef4fae42da00221d2afb66fcb">00114</a> <a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a> *<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, <span class="keyword">const</span> <span class="keywordtype">char</span> *name )
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116   <span class="keywordflow">return</span> (<a class="code" href="classKate_1_1Document.html" title="This interface provides access to the Kate Document class.">Document</a>* ) <a class="code" href="namespaceKate.html#a6ed24f1ef4fae42da00221d2afb66fcb" title="Creates a new Kate::Document object.">KTextEditor::createDocument</a> (<span class="stringliteral">&quot;libkatepart&quot;</span>, parent, name);
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118 
<a name="l00119"></a>00119 View *view (KTextEditor::View *view)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121   <span class="keywordflow">if</span> (!view)
<a name="l00122"></a>00122     <span class="keywordflow">return</span> 0;
<a name="l00123"></a>00123 
<a name="l00124"></a>00124   <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span>View*<span class="keyword">&gt;</span>(view-&gt;qt_cast(<span class="stringliteral">&quot;Kate::View&quot;</span>));
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 }
</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>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>