Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-updates > by-pkgid > 7a18965e2ffd92515e6886f479af5961 > files > 104

kdebase-devel-doc-3.5.9-37.2mdv2008.1.x86_64.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: katesession.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.5.5 -->
<h1>katesession.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) 2005 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">#ifndef __KATE_SESSION_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __KATE_SESSION_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "katemain.h"</span>
<a name="l00023"></a>00023 
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;kdialogbase.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;ksimpleconfig.h&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;ksharedptr.h&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;kaction.h&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;qobject.h&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;qvaluelist.h&gt;</span>
<a name="l00031"></a>00031 
<a name="l00032"></a>00032 <span class="keyword">class </span>KateSessionManager;
<a name="l00033"></a>00033 
<a name="l00034"></a>00034 <span class="keyword">class </span>KDirWatch;
<a name="l00035"></a>00035 <span class="keyword">class </span>KListView;
<a name="l00036"></a>00036 <span class="keyword">class </span>KPushButton;
<a name="l00037"></a>00037 
<a name="l00038"></a>00038 <span class="keyword">class </span>QCheckBox;
<a name="l00039"></a>00039 
<a name="l00040"></a>00040 <span class="keyword">class </span>KateSession  : <span class="keyword">public</span> KShared
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042   <span class="keyword">public</span>:
<a name="l00046"></a>00046     <span class="keyword">typedef</span> KSharedPtr&lt;KateSession&gt; Ptr;
<a name="l00047"></a>00047 
<a name="l00048"></a>00048   <span class="keyword">public</span>:
<a name="l00055"></a>00055     KateSession (KateSessionManager *manager, <span class="keyword">const</span> QString &amp;fileName, <span class="keyword">const</span> QString &amp;name);
<a name="l00056"></a>00056 
<a name="l00060"></a>00060     <span class="keywordtype">void</span> init ();
<a name="l00061"></a>00061 
<a name="l00065"></a>00065     ~KateSession ();
<a name="l00066"></a>00066 
<a name="l00071"></a>00071     QString sessionFile () <span class="keyword">const</span>;
<a name="l00072"></a>00072 
<a name="l00077"></a>00077     <span class="keyword">const</span> QString &amp;sessionFileRelative ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sessionFileRel; }
<a name="l00078"></a>00078 
<a name="l00083"></a>00083     <span class="keyword">const</span> QString &amp;sessionName ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sessionName; }
<a name="l00084"></a>00084 
<a name="l00089"></a>00089     <span class="keywordtype">bool</span> isNew ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sessionName.isEmpty(); }
<a name="l00090"></a>00090 
<a name="l00097"></a>00097     <span class="keywordtype">bool</span> create (<span class="keyword">const</span> QString &amp;name, <span class="keywordtype">bool</span> force = <span class="keyword">false</span>);
<a name="l00098"></a>00098 
<a name="l00104"></a>00104     <span class="keywordtype">bool</span> rename (<span class="keyword">const</span> QString &amp;name);
<a name="l00105"></a>00105 
<a name="l00112"></a>00112     KConfig *configRead ();
<a name="l00113"></a>00113 
<a name="l00120"></a>00120     KConfig *configWrite ();
<a name="l00121"></a>00121 
<a name="l00126"></a>00126     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> documents ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_documents; }
<a name="l00127"></a>00127 
<a name="l00128"></a>00128   <span class="keyword">private</span>:
<a name="l00133"></a>00133     QString m_sessionFileRel;
<a name="l00134"></a>00134 
<a name="l00138"></a>00138     QString m_sessionName;
<a name="l00139"></a>00139 
<a name="l00143"></a>00143     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m_documents;
<a name="l00144"></a>00144 
<a name="l00148"></a>00148     KateSessionManager *m_manager;
<a name="l00149"></a>00149 
<a name="l00153"></a>00153     KSimpleConfig *m_readConfig;
<a name="l00154"></a>00154 
<a name="l00158"></a>00158     KSimpleConfig *m_writeConfig;
<a name="l00159"></a>00159 };
<a name="l00160"></a>00160 
<a name="l00161"></a>00161 <span class="keyword">typedef</span> QValueList&lt;KateSession::Ptr&gt; KateSessionList;
<a name="l00162"></a>00162 
<a name="l00163"></a>00163 <span class="keyword">class </span>KateSessionManager : <span class="keyword">public</span> QObject
<a name="l00164"></a>00164 {
<a name="l00165"></a>00165   Q_OBJECT
<a name="l00166"></a>00166 
<a name="l00167"></a>00167   <span class="keyword">public</span>:
<a name="l00168"></a>00168     KateSessionManager(QObject *parent);
<a name="l00169"></a>00169     ~KateSessionManager();
<a name="l00170"></a>00170 
<a name="l00175"></a>00175     <span class="keyword">static</span> KateSessionManager *<span class="keyword">self</span>();
<a name="l00176"></a>00176 
<a name="l00181"></a>00181     <span class="keyword">inline</span> KateSessionList &amp; sessionList () { updateSessionList (); <span class="keywordflow">return</span> m_sessionList; }
<a name="l00182"></a>00182 
<a name="l00192"></a>00192     <span class="keywordtype">void</span> activateSession (KateSession::Ptr session, <span class="keywordtype">bool</span> closeLast = <span class="keyword">true</span>, <span class="keywordtype">bool</span> saveLast = <span class="keyword">true</span>, <span class="keywordtype">bool</span> loadNew = <span class="keyword">true</span>);
<a name="l00193"></a>00193 
<a name="l00198"></a>00198     KateSession::Ptr createSession (<span class="keyword">const</span> QString &amp;name);
<a name="l00199"></a>00199 
<a name="l00205"></a>00205     KateSession::Ptr giveSession (<span class="keyword">const</span> QString &amp;name);
<a name="l00206"></a>00206 
<a name="l00214"></a>00214     <span class="keywordtype">bool</span> saveActiveSession (<span class="keywordtype">bool</span> tryAsk = <span class="keyword">false</span>, <span class="keywordtype">bool</span> rememberAsLast = <span class="keyword">false</span>);
<a name="l00215"></a>00215 
<a name="l00221"></a>00221     <span class="keyword">inline</span> KateSession::Ptr activeSession () { <span class="keywordflow">return</span> m_activeSession; }
<a name="l00222"></a>00222 
<a name="l00227"></a>00227     <span class="keyword">inline</span> <span class="keyword">const</span> QString &amp;sessionsDir ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_sessionsDir; }
<a name="l00228"></a>00228 
<a name="l00233"></a>00233     <span class="keywordtype">bool</span> chooseSession ();
<a name="l00234"></a>00234 
<a name="l00235"></a>00235   <span class="keyword">public</span> slots:
<a name="l00240"></a>00240     <span class="keywordtype">void</span> sessionNew ();
<a name="l00241"></a>00241 
<a name="l00245"></a>00245     <span class="keywordtype">void</span> sessionOpen ();
<a name="l00246"></a>00246 
<a name="l00250"></a>00250     <span class="keywordtype">void</span> sessionSave ();
<a name="l00251"></a>00251 
<a name="l00255"></a>00255     <span class="keywordtype">void</span> sessionSaveAs ();
<a name="l00256"></a>00256 
<a name="l00260"></a>00260     <span class="keywordtype">void</span> sessionManage ();
<a name="l00261"></a>00261 
<a name="l00262"></a>00262   <span class="keyword">private</span> slots:
<a name="l00263"></a>00263     <span class="keywordtype">void</span> dirty (<span class="keyword">const</span> QString &amp;path);
<a name="l00264"></a>00264 
<a name="l00265"></a>00265   <span class="keyword">public</span>:
<a name="l00269"></a>00269     <span class="keywordtype">void</span> updateSessionList ();
<a name="l00270"></a>00270 
<a name="l00271"></a>00271   <span class="keyword">private</span>:
<a name="l00275"></a>00275     QString m_sessionsDir;
<a name="l00276"></a>00276 
<a name="l00280"></a>00280     KateSessionList m_sessionList;
<a name="l00281"></a>00281 
<a name="l00285"></a>00285     KateSession::Ptr m_activeSession;
<a name="l00286"></a>00286 };
<a name="l00287"></a>00287 
<a name="l00288"></a>00288 <span class="keyword">class </span>KateSessionChooser : <span class="keyword">public</span> KDialogBase
<a name="l00289"></a>00289 {
<a name="l00290"></a>00290   Q_OBJECT
<a name="l00291"></a>00291 
<a name="l00292"></a>00292   <span class="keyword">public</span>:
<a name="l00293"></a>00293     KateSessionChooser (QWidget *parent, <span class="keyword">const</span> QString &amp;lastSession);
<a name="l00294"></a>00294     ~KateSessionChooser ();
<a name="l00295"></a>00295 
<a name="l00296"></a>00296     KateSession::Ptr selectedSession ();
<a name="l00297"></a>00297 
<a name="l00298"></a>00298     <span class="keywordtype">bool</span> reopenLastSession ();
<a name="l00299"></a>00299 
<a name="l00300"></a>00300     <span class="keyword">enum</span> {
<a name="l00301"></a>00301       resultQuit = QDialog::Rejected,
<a name="l00302"></a>00302       resultOpen,
<a name="l00303"></a>00303       resultNew,
<a name="l00304"></a>00304       resultNone
<a name="l00305"></a>00305     };
<a name="l00306"></a>00306 
<a name="l00307"></a>00307   <span class="keyword">protected</span> slots:
<a name="l00311"></a>00311     <span class="keywordtype">void</span> slotUser1 ();
<a name="l00312"></a>00312 
<a name="l00316"></a>00316     <span class="keywordtype">void</span> slotUser2 ();
<a name="l00317"></a>00317 
<a name="l00321"></a>00321     <span class="keywordtype">void</span> slotUser3 ();
<a name="l00322"></a>00322 
<a name="l00326"></a>00326     <span class="keywordtype">void</span> selectionChanged ();
<a name="l00327"></a>00327 
<a name="l00328"></a>00328   <span class="keyword">private</span>:
<a name="l00329"></a>00329     KListView *m_sessions;
<a name="l00330"></a>00330     QCheckBox *m_useLast;
<a name="l00331"></a>00331 };
<a name="l00332"></a>00332 
<a name="l00333"></a>00333 <span class="keyword">class </span>KateSessionOpenDialog : <span class="keyword">public</span> KDialogBase
<a name="l00334"></a>00334 {
<a name="l00335"></a>00335   Q_OBJECT
<a name="l00336"></a>00336 
<a name="l00337"></a>00337   <span class="keyword">public</span>:
<a name="l00338"></a>00338     KateSessionOpenDialog (QWidget *parent);
<a name="l00339"></a>00339     ~KateSessionOpenDialog ();
<a name="l00340"></a>00340 
<a name="l00341"></a>00341     KateSession::Ptr selectedSession ();
<a name="l00342"></a>00342 
<a name="l00343"></a>00343     <span class="keyword">enum</span> {
<a name="l00344"></a>00344       resultOk,
<a name="l00345"></a>00345       resultCancel
<a name="l00346"></a>00346     };
<a name="l00347"></a>00347 
<a name="l00348"></a>00348   <span class="keyword">protected</span> slots:
<a name="l00352"></a>00352     <span class="keywordtype">void</span> slotUser1 ();
<a name="l00353"></a>00353 
<a name="l00357"></a>00357     <span class="keywordtype">void</span> slotUser2 ();
<a name="l00358"></a>00358 
<a name="l00359"></a>00359   <span class="keyword">private</span>:
<a name="l00360"></a>00360     KListView *m_sessions;
<a name="l00361"></a>00361 };
<a name="l00362"></a>00362 
<a name="l00363"></a>00363 <span class="keyword">class </span>KateSessionManageDialog : <span class="keyword">public</span> KDialogBase
<a name="l00364"></a>00364 {
<a name="l00365"></a>00365   Q_OBJECT
<a name="l00366"></a>00366 
<a name="l00367"></a>00367   <span class="keyword">public</span>:
<a name="l00368"></a>00368     KateSessionManageDialog (QWidget *parent);
<a name="l00369"></a>00369     ~KateSessionManageDialog ();
<a name="l00370"></a>00370 
<a name="l00371"></a>00371   <span class="keyword">protected</span> slots:
<a name="l00375"></a>00375     <span class="keywordtype">void</span> slotUser1 ();
<a name="l00376"></a>00376 
<a name="l00380"></a>00380     <span class="keywordtype">void</span> selectionChanged ();
<a name="l00381"></a>00381 
<a name="l00385"></a>00385     <span class="keywordtype">void</span> rename ();
<a name="l00386"></a>00386 
<a name="l00390"></a>00390     <span class="keywordtype">void</span> del ();
<a name="l00391"></a>00391 
<a name="l00392"></a>00392   <span class="keyword">private</span>:
<a name="l00396"></a>00396     <span class="keywordtype">void</span> updateSessionList ();
<a name="l00397"></a>00397 
<a name="l00398"></a>00398   <span class="keyword">private</span>:
<a name="l00399"></a>00399     KListView *m_sessions;
<a name="l00400"></a>00400     KPushButton *m_rename;
<a name="l00401"></a>00401     KPushButton *m_del;
<a name="l00402"></a>00402 };
<a name="l00403"></a>00403 
<a name="l00404"></a>00404 <span class="keyword">class </span>KateSessionsAction : <span class="keyword">public</span> KActionMenu
<a name="l00405"></a>00405 {
<a name="l00406"></a>00406   Q_OBJECT
<a name="l00407"></a>00407 
<a name="l00408"></a>00408   <span class="keyword">public</span>:
<a name="l00409"></a>00409     KateSessionsAction(<span class="keyword">const</span> QString&amp; text, QObject* parent = 0, <span class="keyword">const</span> <span class="keywordtype">char</span>* name = 0);
<a name="l00410"></a>00410     ~KateSessionsAction (){;};
<a name="l00411"></a>00411 
<a name="l00412"></a>00412   <span class="keyword">public</span>  slots:
<a name="l00413"></a>00413     <span class="keywordtype">void</span> slotAboutToShow();
<a name="l00414"></a>00414 
<a name="l00415"></a>00415     <span class="keywordtype">void</span> openSession (<span class="keywordtype">int</span> i);
<a name="l00416"></a>00416 };
<a name="l00417"></a>00417 
<a name="l00418"></a>00418 <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>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></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="classKate_1_1Application.html">kate::application</option>,  <option value="classKate_1_1DockViewBase.html">kate::dockviewbase</option>,  <option value="classKate_1_1DocumentManager.html">kate::documentmanager</option>,  <option value="classKate_1_1PluginManager.html">kate::pluginmanager</option>,  <option value="classKate_1_1ToolViewManager.html">kate::toolviewmanager</option>,  <option value="classKate_1_1ViewManager.html">kate::viewmanager</option>,  <option value="classKateApp.html">kateapp</option>,  <option value="classKateConsole.html">kateconsole</option>,  <option value="classKateExternalTool.html">kateexternaltool</option>,  <option value="classKateExternalToolAction.html">kateexternaltoolaction</option>,  <option value="classKateExternalToolsCommand.html">kateexternaltoolscommand</option>,  <option value="classKateExternalToolsConfigWidget.html">kateexternaltoolsconfigwidget</option>,  <option value="classKateExternalToolServiceEditor.html">kateexternaltoolserviceeditor</option>,  <option value="classKateExternalToolsMenuAction.html">kateexternaltoolsmenuaction</option>,  <option value="classKateMailDialog.html">katemaildialog</option>,  <option value="classKateMDI_1_1Splitter.html">katemdi::splitter</option>,  <option value="classKateMwModOnHdDialog.html">katemwmodonhddialog</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kwin/html/index.html">kwin</a></li><li>&nbsp;&nbsp;<a href="../../kwin/lib/html/index.html">lib</a></li><li><a href="../../libkonq/html/index.html">libkonq</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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional