<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>kwin/lib Library: kdecoration.h Source File (kwin/lib 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>kwin/lib 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 -->
<h1>kdecoration.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*****************************************************************</span>
<a name="l00002"></a>00002 <span class="comment">This file is part of the KDE project.</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (C) 2003 Lubos Lunak <l.lunak@kde.org></span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">Permission is hereby granted, free of charge, to any person obtaining a</span>
<a name="l00007"></a>00007 <span class="comment">copy of this software and associated documentation files (the "Software"),</span>
<a name="l00008"></a>00008 <span class="comment">to deal in the Software without restriction, including without limitation</span>
<a name="l00009"></a>00009 <span class="comment">the rights to use, copy, modify, merge, publish, distribute, sublicense,</span>
<a name="l00010"></a>00010 <span class="comment">and/or sell copies of the Software, and to permit persons to whom the</span>
<a name="l00011"></a>00011 <span class="comment">Software is furnished to do so, subject to the following conditions:</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment">The above copyright notice and this permission notice shall be included in</span>
<a name="l00014"></a>00014 <span class="comment">all copies or substantial portions of the Software.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00017"></a>00017 <span class="comment">IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00018"></a>00018 <span class="comment">FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL</span>
<a name="l00019"></a>00019 <span class="comment">THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00020"></a>00020 <span class="comment">LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span>
<a name="l00021"></a>00021 <span class="comment">FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span>
<a name="l00022"></a>00022 <span class="comment">DEALINGS IN THE SOFTWARE.</span>
<a name="l00023"></a>00023 <span class="comment">******************************************************************/</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef KDECORATION_H</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define KDECORATION_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <qcolor.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <qfont.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <qobject.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <qiconset.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <netwm_def.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <kdeversion.h></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">class </span>KDecorationOptionsPrivate;
<a name="l00036"></a>00036 <span class="keyword">class </span>KDecorationBridge;
<a name="l00037"></a>00037 <span class="keyword">class </span>KDecorationPrivate;
<a name="l00038"></a>00038 <span class="keyword">class </span><a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="preprocessor">#define KWIN_EXPORT KDE_EXPORT</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span>
<a name="l00047"></a><a class="code" href="classKDecorationDefines.html">00047</a> <span class="keyword">class </span>KWIN_EXPORT <a class="code" href="classKDecorationDefines.html">KDecorationDefines</a>
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00053"></a><a class="code" href="classKDecorationDefines.html#w70">00053</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w70">Position</a>
<a name="l00054"></a>00054 { <span class="comment">// without prefix, they'd conflict with Qt::TopLeft etc. :(</span>
<a name="l00055"></a>00055 PositionCenter = 0x00,
<a name="l00056"></a>00056 PositionLeft = 0x01,
<a name="l00057"></a>00057 PositionRight = 0x02,
<a name="l00058"></a>00058 PositionTop = 0x04,
<a name="l00059"></a>00059 PositionBottom = 0x08,
<a name="l00060"></a>00060 PositionTopLeft = PositionLeft | PositionTop,
<a name="l00061"></a>00061 PositionTopRight = PositionRight | PositionTop,
<a name="l00062"></a>00062 PositionBottomLeft = PositionLeft | PositionBottom,
<a name="l00063"></a>00063 PositionBottomRight = PositionRight | PositionBottom
<a name="l00064"></a>00064 };
<a name="l00068"></a>00068 <span class="comment">// these values are written to session files, don't change the order</span>
<a name="l00069"></a><a class="code" href="classKDecorationDefines.html#w71">00069</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w71">MaximizeMode</a>
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 MaximizeRestore = 0,
<a name="l00072"></a>00072 MaximizeVertical = 1,
<a name="l00073"></a>00073 MaximizeHorizontal = 2,
<a name="l00074"></a>00074
<a name="l00075"></a>00075 MaximizeFull = MaximizeVertical | MaximizeHorizontal
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077
<a name="l00078"></a><a class="code" href="classKDecorationDefines.html#w72">00078</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w72">WindowOperation</a>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080 MaximizeOp = 5000,
<a name="l00081"></a>00081 RestoreOp,
<a name="l00082"></a>00082 MinimizeOp,
<a name="l00083"></a>00083 MoveOp,
<a name="l00084"></a>00084 UnrestrictedMoveOp,
<a name="l00085"></a>00085 ResizeOp,
<a name="l00086"></a>00086 UnrestrictedResizeOp,
<a name="l00087"></a>00087 CloseOp,
<a name="l00088"></a>00088 OnAllDesktopsOp,
<a name="l00089"></a>00089 ShadeOp,
<a name="l00090"></a>00090 KeepAboveOp,
<a name="l00091"></a>00091 KeepBelowOp,
<a name="l00092"></a>00092 OperationsOp,
<a name="l00093"></a>00093 WindowRulesOp,
<a name="l00094"></a>00094 ToggleStoreSettingsOp = WindowRulesOp,
<a name="l00095"></a>00095 HMaximizeOp,
<a name="l00096"></a>00096 VMaximizeOp,
<a name="l00097"></a>00097 LowerOp,
<a name="l00098"></a>00098 FullScreenOp,
<a name="l00099"></a>00099 NoBorderOp,
<a name="l00100"></a>00100 NoOp,
<a name="l00101"></a>00101 SetupWindowShortcutOp
<a name="l00102"></a>00102 };
<a name="l00108"></a><a class="code" href="classKDecorationDefines.html#w73">00108</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w73">ColorType</a>
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 ColorTitleBar,
<a name="l00111"></a>00111 ColorTitleBlend,
<a name="l00112"></a>00112 ColorFont,
<a name="l00113"></a>00113 ColorButtonBg,
<a name="l00114"></a>00114 ColorFrame,
<a name="l00115"></a>00115 ColorHandle,
<a name="l00116"></a>00116 NUM_COLORS
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00123"></a>00123 <span class="keyword">enum</span>
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125 SettingDecoration = 1 << 0,
<a name="l00126"></a>00126 SettingColors = 1 << 1,
<a name="l00127"></a>00127 SettingFont = 1 << 2,
<a name="l00128"></a>00128 SettingButtons = 1 << 3,
<a name="l00129"></a>00129 SettingTooltips = 1 << 4,
<a name="l00130"></a><a class="code" href="classKDecorationDefines.html#w74w47">00130</a> SettingBorder = 1 << 5
<a name="l00131"></a>00131 };
<a name="l00132"></a>00132
<a name="l00137"></a><a class="code" href="classKDecorationDefines.html#w75">00137</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w75">BorderSize</a>
<a name="l00138"></a>00138 {
<a name="l00139"></a>00139 BorderTiny,
<a name="l00140"></a>00140 BorderNormal,
<a name="l00141"></a>00141 BorderLarge,
<a name="l00142"></a>00142 BorderVeryLarge,
<a name="l00143"></a>00143 BorderHuge,
<a name="l00144"></a>00144 BorderVeryHuge,
<a name="l00145"></a>00145 BorderOversized,
<a name="l00146"></a><a class="code" href="classKDecorationDefines.html#w75w55">00146</a> BordersCount
<a name="l00147"></a>00147 };
<a name="l00148"></a>00148
<a name="l00153"></a><a class="code" href="classKDecorationDefines.html#w76">00153</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w76">Ability</a>
<a name="l00154"></a>00154 {
<a name="l00155"></a>00155 AbilityAnnounceButtons = 0,
<a name="l00156"></a>00156 AbilityButtonMenu = 1000,
<a name="l00157"></a>00157 AbilityButtonOnAllDesktops = 1001,
<a name="l00158"></a>00158 AbilityButtonSpacer = 1002,
<a name="l00159"></a>00159 AbilityButtonHelp = 1003,
<a name="l00160"></a>00160 AbilityButtonMinimize = 1004,
<a name="l00161"></a>00161 AbilityButtonMaximize = 1005,
<a name="l00162"></a>00162 AbilityButtonClose = 1006,
<a name="l00163"></a>00163 AbilityButtonAboveOthers = 1007,
<a name="l00164"></a>00164 AbilityButtonBelowOthers = 1008,
<a name="l00165"></a>00165 AbilityButtonShade = 1009,
<a name="l00166"></a>00166 AbilityButtonResize = 1010,
<a name="l00167"></a>00167 ABILITY_DUMMY = 10000000
<a name="l00168"></a>00168 };
<a name="l00169"></a>00169
<a name="l00170"></a><a class="code" href="classKDecorationDefines.html#w77">00170</a> <span class="keyword">enum</span> <a class="code" href="classKDecorationDefines.html#w77">Requirement</a> { REQUIREMENT_DUMMY = 1000000 };
<a name="l00171"></a>00171 };
<a name="l00172"></a>00172
<a name="l00173"></a><a class="code" href="classKDecorationProvides.html">00173</a> <span class="keyword">class </span><a class="code" href="classKDecorationProvides.html">KDecorationProvides</a>
<a name="l00174"></a>00174 : <span class="keyword">public</span> <a class="code" href="classKDecorationDefines.html">KDecorationDefines</a>
<a name="l00175"></a>00175 {
<a name="l00176"></a>00176 <span class="keyword">public</span>:
<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> provides( <a class="code" href="classKDecorationDefines.html#w77">Requirement</a> req ) = 0;
<a name="l00178"></a>00178 };
<a name="l00179"></a>00179
<a name="l00186"></a><a class="code" href="classKDecorationOptions.html">00186</a> <span class="keyword">class </span>KWIN_EXPORT KDecorationOptions : <span class="keyword">public</span> <a class="code" href="classKDecorationDefines.html">KDecorationDefines</a>
<a name="l00187"></a>00187 {
<a name="l00188"></a>00188 <span class="keyword">public</span>:
<a name="l00189"></a>00189 KDecorationOptions();
<a name="l00190"></a>00190 <span class="keyword">virtual</span> ~KDecorationOptions();
<a name="l00198"></a>00198 <span class="keyword">const</span> QColor& color(ColorType type, <span class="keywordtype">bool</span> active=<span class="keyword">true</span>) <span class="keyword">const</span>;
<a name="l00206"></a>00206 <span class="keyword">const</span> QColorGroup& colorGroup(ColorType type, <span class="keywordtype">bool</span> active=<span class="keyword">true</span>) <span class="keyword">const</span>;
<a name="l00214"></a>00214 <span class="keyword">const</span> QFont& font(<span class="keywordtype">bool</span> active=<span class="keyword">true</span>, <span class="keywordtype">bool</span> small = <span class="keyword">false</span>) <span class="keyword">const</span>;
<a name="l00222"></a>00222 <span class="keywordtype">bool</span> customButtonPositions() <span class="keyword">const</span>;
<a name="l00244"></a>00244 QString titleButtonsLeft() <span class="keyword">const</span>;
<a name="l00256"></a>00256 QString titleButtonsRight() <span class="keyword">const</span>;
<a name="l00257"></a>00257
<a name="l00262"></a>00262 <span class="keywordtype">bool</span> showTooltips() <span class="keyword">const</span>;
<a name="l00263"></a>00263
<a name="l00274"></a>00274 BorderSize preferredBorderSize( <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* factory ) <span class="keyword">const</span>;
<a name="l00275"></a>00275
<a name="l00276"></a>00276 <span class="comment">/*</span>
<a name="l00277"></a>00277 <span class="comment"> * When this functions returns false, moving and resizing of maximized windows</span>
<a name="l00278"></a>00278 <span class="comment"> * is not allowed, and therefore the decoration is allowed to turn off (some of)</span>
<a name="l00279"></a>00279 <span class="comment"> * its borders.</span>
<a name="l00280"></a>00280 <span class="comment"> * The changed flags for this setting is SettingButtons.</span>
<a name="l00281"></a>00281 <span class="comment"> */</span>
<a name="l00282"></a>00282 <span class="keywordtype">bool</span> moveResizeMaximizedWindows() <span class="keyword">const</span>;
<a name="l00283"></a>00283
<a name="l00287"></a>00287 WindowOperation operationMaxButtonClick( Qt::ButtonState button ) <span class="keyword">const</span>;
<a name="l00288"></a>00288
<a name="l00292"></a>00292 <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> updateSettings() = 0; <span class="comment">// returns SettingXYZ mask</span>
<a name="l00293"></a>00293
<a name="l00294"></a>00294 <span class="keyword">protected</span>:
<a name="l00298"></a><a class="code" href="classKDecorationOptions.html#p0">00298</a> KDecorationOptionsPrivate* d;
<a name="l00299"></a>00299 };
<a name="l00300"></a>00300
<a name="l00301"></a>00301
<a name="l00309"></a><a class="code" href="classKDecoration.html">00309</a> <span class="keyword">class </span>KWIN_EXPORT KDecoration
<a name="l00310"></a>00310 : <span class="keyword">public</span> QObject, <span class="keyword">public</span> <a class="code" href="classKDecorationDefines.html">KDecorationDefines</a>
<a name="l00311"></a>00311 {
<a name="l00312"></a>00312 Q_OBJECT
<a name="l00313"></a>00313 <span class="keyword">public</span>:
<a name="l00319"></a>00319 KDecoration( KDecorationBridge* bridge, <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* factory );
<a name="l00323"></a>00323 <span class="keyword">virtual</span> ~KDecoration();
<a name="l00324"></a>00324
<a name="l00325"></a>00325 <span class="comment">// requests from decoration</span>
<a name="l00326"></a>00326
<a name="l00331"></a>00331 <span class="keyword">static</span> <span class="keyword">const</span> KDecorationOptions* options();
<a name="l00335"></a>00335 <span class="keywordtype">bool</span> isActive() <span class="keyword">const</span>;
<a name="l00339"></a>00339 <span class="keywordtype">bool</span> isCloseable() <span class="keyword">const</span>;
<a name="l00343"></a>00343 <span class="keywordtype">bool</span> isMaximizable() <span class="keyword">const</span>;
<a name="l00349"></a>00349 MaximizeMode maximizeMode() <span class="keyword">const</span>;
<a name="l00353"></a>00353 <span class="keywordtype">bool</span> isMinimizable() <span class="keyword">const</span>;
<a name="l00358"></a>00358 <span class="keywordtype">bool</span> providesContextHelp() <span class="keyword">const</span>;
<a name="l00364"></a>00364 <span class="keywordtype">int</span> desktop() <span class="keyword">const</span>;
<a name="l00369"></a>00369 <span class="keywordtype">bool</span> isOnAllDesktops() <span class="keyword">const</span>; <span class="comment">// convenience</span>
<a name="l00373"></a>00373 <span class="comment"></span> <span class="keywordtype">bool</span> isModal() <span class="keyword">const</span>;
<a name="l00377"></a>00377 <span class="keywordtype">bool</span> isShadeable() <span class="keyword">const</span>;
<a name="l00386"></a>00386 <span class="keywordtype">bool</span> isShade() <span class="keyword">const</span>;
<a name="l00394"></a>00394 <span class="keywordtype">bool</span> isSetShade() <span class="keyword">const</span>;
<a name="l00398"></a>00398 <span class="keywordtype">bool</span> keepAbove() <span class="keyword">const</span>;
<a name="l00402"></a>00402 <span class="keywordtype">bool</span> keepBelow() <span class="keyword">const</span>;
<a name="l00406"></a>00406 <span class="keywordtype">bool</span> isMovable() <span class="keyword">const</span>;
<a name="l00410"></a>00410 <span class="keywordtype">bool</span> isResizable() <span class="keyword">const</span>;
<a name="l00434"></a>00434 NET::WindowType windowType( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> supported_types ) <span class="keyword">const</span>;
<a name="l00438"></a>00438 QIconSet icon() <span class="keyword">const</span>;
<a name="l00442"></a>00442 QString caption() <span class="keyword">const</span>;
<a name="l00469"></a>00469 <span class="keywordtype">void</span> showWindowMenu( <span class="keyword">const</span> QRect &pos );
<a name="l00470"></a>00470
<a name="l00474"></a>00474 <span class="keywordtype">void</span> showWindowMenu( QPoint pos );
<a name="l00479"></a>00479 <span class="keywordtype">void</span> performWindowOperation( WindowOperation op );
<a name="l00488"></a>00488 <span class="keywordtype">void</span> setMask( <span class="keyword">const</span> QRegion& reg, <span class="keywordtype">int</span> mode = 0 );
<a name="l00492"></a>00492 <span class="keywordtype">void</span> clearMask(); <span class="comment">// convenience</span>
<a name="l00498"></a>00498 <span class="comment"></span> <span class="keywordtype">bool</span> isPreview() <span class="keyword">const</span>;
<a name="l00502"></a>00502 QRect geometry() <span class="keyword">const</span>;
<a name="l00508"></a>00508 QRect iconGeometry() <span class="keyword">const</span>;
<a name="l00517"></a>00517 QRegion unobscuredRegion( <span class="keyword">const</span> QRegion& r ) <span class="keyword">const</span>;
<a name="l00522"></a>00522 QWidget* workspaceWidget() <span class="keyword">const</span>;
<a name="l00536"></a>00536 WId windowId() <span class="keyword">const</span>;
<a name="l00540"></a>00540 <span class="keywordtype">int</span> width() <span class="keyword">const</span>; <span class="comment">// convenience</span>
<a name="l00544"></a>00544 <span class="comment"></span> <span class="keywordtype">int</span> height() <span class="keyword">const</span>; <span class="comment">// convenience</span>
<a name="l00550"></a>00550 <span class="comment"></span> <span class="keywordtype">void</span> processMousePressEvent( QMouseEvent* e );
<a name="l00551"></a>00551
<a name="l00552"></a>00552 <span class="comment">// requests to decoration</span>
<a name="l00553"></a>00553
<a name="l00559"></a>00559 <span class="keyword">virtual</span> <span class="keywordtype">void</span> init() = 0; <span class="comment">// called once right after created</span>
<a name="l00560"></a>00560
<a name="l00566"></a>00566 <span class="keyword">virtual</span> Position mousePosition( <span class="keyword">const</span> QPoint& p ) <span class="keyword">const </span>= 0;
<a name="l00567"></a>00567
<a name="l00580"></a>00580 <span class="comment">// mustn't do any repaints, resizes or anything like that</span>
<a name="l00581"></a>00581 <span class="keyword">virtual</span> <span class="keywordtype">void</span> borders( <span class="keywordtype">int</span>& left, <span class="keywordtype">int</span>& right, <span class="keywordtype">int</span>& top, <span class="keywordtype">int</span>& bottom ) <span class="keyword">const </span>= 0;
<a name="l00589"></a>00589 <span class="keyword">virtual</span> <span class="keywordtype">void</span> resize( <span class="keyword">const</span> QSize& s ) = 0;
<a name="l00595"></a>00595 <span class="keyword">virtual</span> QSize minimumSize() <span class="keyword">const </span>= 0;
<a name="l00600"></a>00600 <span class="keyword">virtual</span> <span class="keywordtype">void</span> activeChange() = 0;
<a name="l00604"></a>00604 <span class="keyword">virtual</span> <span class="keywordtype">void</span> captionChange() = 0;
<a name="l00608"></a>00608 <span class="keyword">virtual</span> <span class="keywordtype">void</span> iconChange() = 0;
<a name="l00613"></a>00613 <span class="keyword">virtual</span> <span class="keywordtype">void</span> maximizeChange() = 0;
<a name="l00619"></a>00619 <span class="keyword">virtual</span> <span class="keywordtype">void</span> desktopChange() = 0;
<a name="l00624"></a>00624 <span class="keyword">virtual</span> <span class="keywordtype">void</span> shadeChange() = 0;
<a name="l00625"></a>00625 <span class="preprocessor">#if KDE_IS_VERSION( 3, 90, 0 )</span>
<a name="l00626"></a>00626 <span class="preprocessor"></span><span class="preprocessor">#warning Redo all the XYZChange() virtuals as signals.</span>
<a name="l00627"></a>00627 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00628"></a>00628 <span class="preprocessor"></span> signals:
<a name="l00633"></a>00633 <span class="keywordtype">void</span> keepAboveChanged( <span class="keywordtype">bool</span> );
<a name="l00638"></a>00638 <span class="keywordtype">void</span> keepBelowChanged( <span class="keywordtype">bool</span> );
<a name="l00639"></a>00639 <span class="keyword">public</span>:
<a name="l00653"></a>00653 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> drawbound( <span class="keyword">const</span> QRect& geom, <span class="keywordtype">bool</span> clear );
<a name="l00664"></a>00664 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> animateMinimize( <span class="keywordtype">bool</span> minimize );
<a name="l00668"></a>00668 <span class="comment">// TODO position will need also values for top+left+bottom etc. docking ?</span>
<a name="l00669"></a>00669 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> windowDocked( Position side );
<a name="l00676"></a>00676 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset( <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> changed );
<a name="l00677"></a>00677
<a name="l00678"></a>00678 <span class="comment">// special</span>
<a name="l00679"></a>00679
<a name="l00686"></a>00686 <span class="keywordtype">void</span> setMainWidget( QWidget* );
<a name="l00696"></a>00696 <span class="keywordtype">void</span> createMainWidget( WFlags flags = 0 );
<a name="l00700"></a>00700 QWidget* initialParentWidget() <span class="keyword">const</span>;
<a name="l00707"></a>00707 WFlags initialWFlags() <span class="keyword">const</span>;
<a name="l00714"></a>00714 <span class="keywordtype">void</span> helperShowHide( <span class="keywordtype">bool</span> show );
<a name="l00718"></a>00718 QWidget* widget();
<a name="l00722"></a>00722 <span class="keyword">const</span> QWidget* widget() <span class="keyword">const</span>;
<a name="l00726"></a>00726 <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* factory() <span class="keyword">const</span>;
<a name="l00730"></a>00730 <span class="keywordtype">void</span> grabXServer();
<a name="l00734"></a>00734 <span class="keywordtype">void</span> ungrabXServer();
<a name="l00735"></a>00735 <span class="keyword">public</span> slots:
<a name="l00736"></a>00736 <span class="comment">// requests from decoration</span>
<a name="l00737"></a>00737
<a name="l00745"></a>00745 <span class="keywordtype">void</span> closeWindow();
<a name="l00746"></a>00746 <span class="comment">/*</span>
<a name="l00747"></a>00747 <span class="comment"> * Changes the maximize mode of the decorated window. This function should</span>
<a name="l00748"></a>00748 <span class="comment"> * be preferred to the other maximize() overload for reacting on clicks</span>
<a name="l00749"></a>00749 <span class="comment"> * on the maximize titlebar button.</span>
<a name="l00750"></a>00750 <span class="comment"> * NOTE: This function is new in KDE3.3. In order to support also KDE3.2,</span>
<a name="l00751"></a>00751 <span class="comment"> * it is recommended to use code like this:</span>
<a name="l00752"></a>00752 <span class="comment"> * \code</span>
<a name="l00753"></a>00753 <span class="comment"> * ButtonState button = ... ;</span>
<a name="l00754"></a>00754 <span class="comment"> * #if KDE_IS_VERSION( 3, 3, 0 )</span>
<a name="l00755"></a>00755 <span class="comment"> * maximize( button );</span>
<a name="l00756"></a>00756 <span class="comment"> * #else</span>
<a name="l00757"></a>00757 <span class="comment"> * if( button == MidButton )</span>
<a name="l00758"></a>00758 <span class="comment"> * maximize( maximizeMode() ^ MaximizeVertical );</span>
<a name="l00759"></a>00759 <span class="comment"> * else if( button == RightButton )</span>
<a name="l00760"></a>00760 <span class="comment"> * maximize( maximizeMode() ^ MaximizeHorizontal );</span>
<a name="l00761"></a>00761 <span class="comment"> * else</span>
<a name="l00762"></a>00762 <span class="comment"> * maximize( maximizeMode() == MaximizeFull ? MaximizeRestore : MaximizeFull );</span>
<a name="l00763"></a>00763 <span class="comment"> * #endif</span>
<a name="l00764"></a>00764 <span class="comment"> * \endcode</span>
<a name="l00765"></a>00765 <span class="comment"> * @since 3.3</span>
<a name="l00766"></a>00766 <span class="comment"> */</span>
<a name="l00767"></a>00767 <span class="preprocessor">#if KDE_IS_VERSION( 3, 90, 0 )</span>
<a name="l00768"></a>00768 <span class="preprocessor"></span><span class="preprocessor">#warning Update the docs.</span>
<a name="l00769"></a>00769 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00770"></a>00770 <span class="preprocessor"></span> <span class="keywordtype">void</span> maximize( ButtonState button );
<a name="l00775"></a>00775 <span class="keywordtype">void</span> maximize( MaximizeMode mode );
<a name="l00779"></a>00779 <span class="keywordtype">void</span> minimize();
<a name="l00784"></a>00784 <span class="keywordtype">void</span> showContextHelp();
<a name="l00789"></a>00789 <span class="keywordtype">void</span> setDesktop( <span class="keywordtype">int</span> desktop );
<a name="l00793"></a>00793 <span class="keywordtype">void</span> toggleOnAllDesktops(); <span class="comment">// convenience</span>
<a name="l00798"></a>00798 <span class="comment"></span> <span class="keywordtype">void</span> titlebarDblClickOperation();
<a name="l00803"></a>00803 <span class="keywordtype">void</span> setShade( <span class="keywordtype">bool</span> set );
<a name="l00808"></a>00808 <span class="keywordtype">void</span> setKeepAbove( <span class="keywordtype">bool</span> set );
<a name="l00813"></a>00813 <span class="keywordtype">void</span> setKeepBelow( <span class="keywordtype">bool</span> set );
<a name="l00817"></a><a class="code" href="classKDecoration.html#i11">00817</a> <span class="keywordtype">void</span> emitKeepAboveChanged( <span class="keywordtype">bool</span> above ) { emit keepAboveChanged( above ); }
<a name="l00821"></a><a class="code" href="classKDecoration.html#i12">00821</a> <span class="keywordtype">void</span> emitKeepBelowChanged( <span class="keywordtype">bool</span> below ) { emit keepBelowChanged( below ); }
<a name="l00822"></a>00822 <span class="keyword">private</span>:
<a name="l00823"></a>00823 KDecorationBridge* bridge_;
<a name="l00824"></a>00824 QWidget* w_;
<a name="l00825"></a>00825 <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* factory_;
<a name="l00826"></a><a class="code" href="classKDecoration.html#n0">00826</a> <span class="keyword">friend</span> <span class="keyword">class </span>KDecorationOptions; <span class="comment">// for options_</span>
<a name="l00827"></a>00827 <span class="keyword">static</span> KDecorationOptions* options_;
<a name="l00828"></a>00828 KDecorationPrivate* <a class="code" href="classKDecorationOptions.html#p0">d</a>;
<a name="l00829"></a>00829 };
<a name="l00830"></a>00830
<a name="l00831"></a>00831 <span class="keyword">inline</span>
<a name="l00832"></a>00832 <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> operator^( <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m1, <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m2 )
<a name="l00833"></a>00833 {
<a name="l00834"></a>00834 <span class="keywordflow">return</span> <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a>( <span class="keywordtype">int</span>(m1) ^ <span class="keywordtype">int</span>(m2) );
<a name="l00835"></a>00835 }
<a name="l00836"></a>00836
<a name="l00837"></a>00837 <span class="keyword">inline</span>
<a name="l00838"></a>00838 <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> operator&( <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m1, <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m2 )
<a name="l00839"></a>00839 {
<a name="l00840"></a>00840 <span class="keywordflow">return</span> <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a>( <span class="keywordtype">int</span>(m1) & <span class="keywordtype">int</span>(m2) );
<a name="l00841"></a>00841 }
<a name="l00842"></a>00842
<a name="l00843"></a>00843 <span class="keyword">inline</span>
<a name="l00844"></a>00844 <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> operator|( <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m1, <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a> m2 )
<a name="l00845"></a>00845 {
<a name="l00846"></a>00846 <span class="keywordflow">return</span> <a class="code" href="classKDecorationDefines.html#w71">KDecorationDefines::MaximizeMode</a>( <span class="keywordtype">int</span>(m1) | <span class="keywordtype">int</span>(m2) );
<a name="l00847"></a>00847 }
<a name="l00848"></a>00848
<a name="l00849"></a><a class="code" href="classKDecoration.html#a55">00849</a> <span class="keyword">inline</span> QWidget* <a class="code" href="classKDecoration.html#a55">KDecoration::widget</a>()
<a name="l00850"></a>00850 {
<a name="l00851"></a>00851 <span class="keywordflow">return</span> w_;
<a name="l00852"></a>00852 }
<a name="l00853"></a>00853
<a name="l00854"></a><a class="code" href="classKDecoration.html#a56">00854</a> <span class="keyword">inline</span> <span class="keyword">const</span> QWidget* <a class="code" href="classKDecoration.html#a55">KDecoration::widget</a>()<span class="keyword"> const</span>
<a name="l00855"></a>00855 <span class="keyword"> </span>{
<a name="l00856"></a>00856 <span class="keywordflow">return</span> w_;
<a name="l00857"></a>00857 }
<a name="l00858"></a>00858
<a name="l00859"></a><a class="code" href="classKDecoration.html#a57">00859</a> <span class="keyword">inline</span> <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* <a class="code" href="classKDecoration.html#a57">KDecoration::factory</a>()<span class="keyword"> const</span>
<a name="l00860"></a>00860 <span class="keyword"> </span>{
<a name="l00861"></a>00861 <span class="keywordflow">return</span> factory_;
<a name="l00862"></a>00862 }
<a name="l00863"></a>00863
<a name="l00864"></a><a class="code" href="classKDecoration.html#a9">00864</a> <span class="keyword">inline</span> <span class="keywordtype">bool</span> <a class="code" href="classKDecoration.html#a9">KDecoration::isOnAllDesktops</a>()<span class="keyword"> const</span>
<a name="l00865"></a>00865 <span class="keyword"> </span>{
<a name="l00866"></a>00866 <span class="keywordflow">return</span> <a class="code" href="classKDecoration.html#a8">desktop</a>() == NET::OnAllDesktops;
<a name="l00867"></a>00867 }
<a name="l00868"></a>00868
<a name="l00869"></a><a class="code" href="classKDecoration.html#a32">00869</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classKDecoration.html#a32">KDecoration::width</a>()<span class="keyword"> const</span>
<a name="l00870"></a>00870 <span class="keyword"> </span>{
<a name="l00871"></a>00871 <span class="keywordflow">return</span> <a class="code" href="classKDecoration.html#a27">geometry</a>().width();
<a name="l00872"></a>00872 }
<a name="l00873"></a>00873
<a name="l00874"></a><a class="code" href="classKDecoration.html#a33">00874</a> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="classKDecoration.html#a33">KDecoration::height</a>()<span class="keyword"> const</span>
<a name="l00875"></a>00875 <span class="keyword"> </span>{
<a name="l00876"></a>00876 <span class="keywordflow">return</span> <a class="code" href="classKDecoration.html#a27">geometry</a>().height();
<a name="l00877"></a>00877 }
<a name="l00878"></a>00878
<a name="l00879"></a>00879 <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 kwin/lib 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:07:27 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>
