<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>kate Library: kateviewspacecontainer.h Source File (kate Library)</title>
<link href="../../common/doxygen.css" rel="stylesheet" type="text/css">
</head>
<div class="header">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="2" width="92">
<a href="../../index.html" title="The API documentation main page"><img src="../../common/docheadergears.png" style="border:0px;" alt=""></a>
</td>
<td width="95%">
<h1>kate Library API Documentation</h1>
</td>
</tr>
<tr>
<td valign="bottom">
<table class="links" border=0 cellspacing=0>
<tr>
<td><a href="index.html">Overview</a></td>
<td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class Hierarchy</a></td>
<td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td>
<td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes (annotated)</a></td>
<td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td>
<td><a href="namespaces.html" title="All documented namespaces with brief descriptions">Namespaces</a></td>
<td><a href="files.html" title="A list of all documented files with brief descriptions">Source Files</a></td>
</tr>
</table>
</td></tr></table>
</div>
<div id="hgrad"></div>
<div class="text">
<!-- Generated by Doxygen 1.4.4 -->
<div class="nav">
<a class="el" href="dir_000002.html">app</a></div>
<h1>kateviewspacecontainer.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"> Copyright (C) 2001 Joseph Wenninger <jowenn@kde.org></span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 2001 Anders Lund <anders.lund@lund.tdcadsl.dk></span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment"> License version 2 as published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Library General Public License</span>
<a name="l00016"></a>00016 <span class="comment"> along with this library; see the file COPYING.LIB. If not, write to</span>
<a name="l00017"></a>00017 <span class="comment"> the Free Software Foundation, Inc., 59 Temple Place - Suite 330,</span>
<a name="l00018"></a>00018 <span class="comment"> Boston, MA 02111-1307, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __KATE_VIEWSPACE_CONTAINER_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __KATE_VIEWSPACE_CONTAINER_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "katemain.h"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "../interfaces/viewmanager.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#include <kate/view.h></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <kate/document.h></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">class </span><a class="code" href="classKateSplitter.html">KateSplitter</a>;
<a name="l00031"></a>00031 <span class="keyword">class </span>KConfig;
<a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classKateMainWindow.html">KateMainWindow</a>;
<a name="l00033"></a>00033
<a name="l00034"></a><a class="code" href="classKateViewSpaceContainer.html">00034</a> <span class="keyword">class </span><a class="code" href="classKateViewSpaceContainer.html">KateViewSpaceContainer</a>: <span class="keyword">public</span> QWidget
<a name="l00035"></a>00035 {
<a name="l00036"></a>00036 Q_OBJECT
<a name="l00037"></a>00037
<a name="l00038"></a><a class="code" href="classKateViewSpaceContainer.html#n0">00038</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKateViewSpace.html">KateViewSpace</a>;
<a name="l00039"></a><a class="code" href="classKateViewSpaceContainer.html#n1">00039</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKateVSStatusBar.html">KateVSStatusBar</a>;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">public</span>:
<a name="l00042"></a>00042 <a class="code" href="classKateViewSpaceContainer.html#a0">KateViewSpaceContainer</a> (QWidget *parent, <a class="code" href="classKateViewManager.html">KateViewManager</a> *viewManager);
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <a class="code" href="classKateViewSpaceContainer.html#a1">~KateViewSpaceContainer</a> ();
<a name="l00045"></a>00045
<a name="l00046"></a><a class="code" href="classKateViewSpaceContainer.html#a2">00046</a> <span class="keyword">inline</span> QPtrList<Kate::View> &<a class="code" href="classKateViewSpaceContainer.html#a2">viewList</a> () { <span class="keywordflow">return</span> m_viewList; };
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <span class="comment">/* This will save the splitter configuration */</span>
<a name="l00050"></a>00050 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#a3">saveViewConfiguration</a>(KConfig *config,<span class="keyword">const</span> QString& group);
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="comment">/* restore it */</span>
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#a4">restoreViewConfiguration</a> (KConfig *config,<span class="keyword">const</span> QString& group);
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keyword">private</span>:
<a name="l00060"></a>00060 <span class="keywordtype">bool</span> createView ( Kate::Document *doc =0L );
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keywordtype">bool</span> deleteView ( Kate::View *view, <span class="keywordtype">bool</span> delViewSpace = <span class="keyword">true</span>);
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keywordtype">void</span> moveViewtoSplit (Kate::View *view);
<a name="l00065"></a>00065 <span class="keywordtype">void</span> moveViewtoStack (Kate::View *view);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">/* Save the configuration of a single splitter.</span>
<a name="l00068"></a>00068 <span class="comment"> * If child splitters are found, it calls it self with those as the argument.</span>
<a name="l00069"></a>00069 <span class="comment"> * If a viewspace child is found, it is asked to save its filelist.</span>
<a name="l00070"></a>00070 <span class="comment"> */</span>
<a name="l00071"></a>00071 <span class="keywordtype">void</span> saveSplitterConfig(<a class="code" href="classKateSplitter.html">KateSplitter</a>* s, <span class="keywordtype">int</span> idx=0, KConfig* config=0L, <span class="keyword">const</span> QString& viewConfGrp=<span class="stringliteral">""</span>);
<a name="l00072"></a>00072
<a name="l00076"></a>00076 <span class="keywordtype">void</span> restoreSplitter ( KConfig* config, <span class="keyword">const</span> QString &group, QWidget* parent , <span class="keyword">const</span> QString& viewConfGrp);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">void</span> removeViewSpace (<a class="code" href="classKateViewSpace.html">KateViewSpace</a> *viewspace);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> showFullPath;
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keyword">public</span>:
<a name="l00083"></a>00083 Kate::View* <a class="code" href="classKateViewSpaceContainer.html#a5">activeView</a> ();
<a name="l00084"></a>00084 <a class="code" href="classKateViewSpace.html">KateViewSpace</a>* <a class="code" href="classKateViewSpaceContainer.html#a6">activeViewSpace</a> ();
<a name="l00085"></a>00085
<a name="l00086"></a>00086 uint <a class="code" href="classKateViewSpaceContainer.html#a7">viewCount</a> ();
<a name="l00087"></a>00087 uint <a class="code" href="classKateViewSpaceContainer.html#a8">viewSpaceCount</a> ();
<a name="l00088"></a>00088
<a name="l00089"></a><a class="code" href="classKateViewSpaceContainer.html#a9">00089</a> <span class="keywordtype">bool</span> <a class="code" href="classKateViewSpaceContainer.html#a9">isViewActivationBlocked</a>(){<span class="keywordflow">return</span> m_blockViewCreationAndActivation;};
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">public</span>:
<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#a10">closeViews</a>(uint documentNumber);
<a name="l00093"></a>00093 <a class="code" href="classKateMainWindow.html">KateMainWindow</a> *<a class="code" href="classKateViewSpaceContainer.html#a11">mainWindow</a>();
<a name="l00094"></a><a class="code" href="classKateViewSpaceContainer.html#n2">00094</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classKateViewManager.html">KateViewManager</a>;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keyword">private</span> slots:
<a name="l00097"></a>00097 <span class="keywordtype">void</span> activateView ( Kate::View *view );
<a name="l00098"></a>00098 <span class="keywordtype">void</span> activateSpace ( Kate::View* v );
<a name="l00099"></a>00099 <span class="keywordtype">void</span> slotViewChanged();
<a name="l00100"></a>00100 <span class="keywordtype">void</span> reactivateActiveView();
<a name="l00101"></a>00101 <span class="keywordtype">void</span> slotPendingDocumentNameChanged();
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="keywordtype">void</span> documentCreated (Kate::Document *doc);
<a name="l00104"></a>00104 <span class="keywordtype">void</span> documentDeleted (uint docNumber);
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keyword">public</span> slots:
<a name="l00107"></a>00107 <span class="comment">/* Splits a KateViewSpace into two.</span>
<a name="l00108"></a>00108 <span class="comment"> * The operation is performed by creating a KateSplitter in the parent of the KateViewSpace to be split,</span>
<a name="l00109"></a>00109 <span class="comment"> * which is then moved to that splitter. Then a new KateViewSpace is created and added to the splitter,</span>
<a name="l00110"></a>00110 <span class="comment"> * and a KateView is created to populate the new viewspace. The new KateView is made the active one,</span>
<a name="l00111"></a>00111 <span class="comment"> * because createView() does that.</span>
<a name="l00112"></a>00112 <span class="comment"> * If no viewspace is provided, the result of activeViewSpace() is used.</span>
<a name="l00113"></a>00113 <span class="comment"> * The isHoriz, true pr default, decides the orientation of the splitting action.</span>
<a name="l00114"></a>00114 <span class="comment"> * If atTop is true, the new viewspace will be moved to the first position in the new splitter.</span>
<a name="l00115"></a>00115 <span class="comment"> * If a newViewUrl is provided, the new view will show the document in that URL if any, otherwise</span>
<a name="l00116"></a>00116 <span class="comment"> * the document of the current view in the viewspace to be split is used.</span>
<a name="l00117"></a>00117 <span class="comment"> */</span>
<a name="l00118"></a>00118 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i0">splitViewSpace</a>( <a class="code" href="classKateViewSpace.html">KateViewSpace</a>* vs=0L, <span class="keywordtype">bool</span> isHoriz=<span class="keyword">true</span>, <span class="keywordtype">bool</span> atTop=<span class="keyword">false</span> );
<a name="l00119"></a>00119
<a name="l00120"></a><a class="code" href="classKateViewSpaceContainer.html#i1">00120</a> <span class="keywordtype">bool</span> <a class="code" href="classKateViewSpaceContainer.html#i1">getShowFullPath</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> showFullPath; }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="keywordtype">void</span> activateView ( uint documentNumber );
<a name="l00123"></a><a class="code" href="classKateViewSpaceContainer.html#i3">00123</a> <span class="keywordtype">void</span> activateView ( <span class="keywordtype">int</span> documentNumber ) { activateView((uint) documentNumber); };
<a name="l00124"></a>00124
<a name="l00126"></a><a class="code" href="classKateViewSpaceContainer.html#i4">00126</a> <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i4">slotSplitViewSpaceHoriz</a> () { <a class="code" href="classKateViewSpaceContainer.html#i0">splitViewSpace</a>(); }
<a name="l00128"></a><a class="code" href="classKateViewSpaceContainer.html#i5">00128</a> <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i5">slotSplitViewSpaceVert</a> () { <a class="code" href="classKateViewSpaceContainer.html#i0">splitViewSpace</a>( 0L, <span class="keyword">false</span> ); }
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i6">slotCloseCurrentViewSpace</a>();
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i7">statusMsg</a> ();
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i8">setActiveSpace</a> ( <a class="code" href="classKateViewSpace.html">KateViewSpace</a>* vs );
<a name="l00135"></a>00135 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i9">setActiveView</a> ( Kate::View* view );
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i10">setShowFullPath</a>(<span class="keywordtype">bool</span> enable);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i11">activateNextView</a>();
<a name="l00140"></a>00140 <span class="keywordtype">void</span> <a class="code" href="classKateViewSpaceContainer.html#i12">activatePrevView</a>();
<a name="l00141"></a>00141
<a name="l00142"></a>00142 signals:
<a name="l00143"></a>00143 <span class="keywordtype">void</span> statusChanged (Kate::View *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>, <span class="keywordtype">bool</span>, <span class="keywordtype">int</span>, <span class="keyword">const</span> QString &);
<a name="l00144"></a>00144 <span class="keywordtype">void</span> statChanged ();
<a name="l00145"></a>00145 <span class="keywordtype">void</span> viewChanged ();
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keyword">private</span>:
<a name="l00148"></a>00148 <a class="code" href="classKateViewManager.html">KateViewManager</a> *m_viewManager;
<a name="l00149"></a>00149 QPtrList<KateViewSpace> m_viewSpaceList;
<a name="l00150"></a>00150 QPtrList<Kate::View> m_viewList;
<a name="l00151"></a>00151
<a name="l00152"></a>00152 QGridLayout *m_grid;
<a name="l00153"></a>00153 <span class="keywordtype">bool</span> m_blockViewCreationAndActivation;
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keywordtype">bool</span> m_activeViewRunning;
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keywordtype">bool</span> m_pendingViewCreation;
<a name="l00158"></a>00158 QGuardedPtr<Kate::Document> m_pendingDocument;
<a name="l00159"></a>00159 };
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="preprocessor">#endif</span>
</pre></div></div>
<div id="bottom-nav">
<img src="../../common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo">
</div>
<div class="bottom">
This file is part of the documentation for kate Library Version 3.4.2.
</div>
<div class="bottom" style="color:#cccccc">
Documentation copyright © 1996-2004 the KDE developers.<br>
Generated on Wed Jun 14 19:05:33 2006 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.4.4 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2003
</div>
</body>
</html>
