<!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 Class Reference (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 Class Reference</h1><!-- doxytag: class="KDecoration" --><!-- doxytag: inherits="QObject,KDecorationDefines" -->This is the base class for a decoration object.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>></code>
<p>
Inheritance diagram for KDecoration:<p><center><img src="classKDecoration__inherit__graph.png" border="0" usemap="#KDecoration__inherit__map" alt="Inheritance graph"></center>
<map name="KDecoration__inherit__map">
<area href="classKDecorationDefines.html" shape="rect" coords="7,7,149,34" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for KDecoration:<p><center><img src="classKDecoration__coll__graph.png" border="0" usemap="#KDecoration__coll__map" alt="Collaboration graph"></center>
<map name="KDecoration__coll__map">
<area href="classKDecorationDefines.html" shape="rect" coords="58,8,200,34" alt="">
<area href="classKDecorationOptions.html" shape="rect" coords="58,85,200,112" alt="">
<area href="classKDecorationFactory.html" shape="rect" coords="224,85,362,112" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classKDecoration-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i0">closeWindow</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i1"></a><!-- doxytag: member="KDecoration::maximize" ref="i1" args="(ButtonState button)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i1">maximize</a> (ButtonState button)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i2">maximize</a> (<a class="el" href="classKDecorationDefines.html#w71">MaximizeMode</a> mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i3">minimize</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i4">showContextHelp</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i5">setDesktop</a> (int desktop)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i6">toggleOnAllDesktops</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i7">titlebarDblClickOperation</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i8">setShade</a> (bool set)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i9">setKeepAbove</a> (bool set)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i10">setKeepBelow</a> (bool set)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i11"></a><!-- doxytag: member="KDecoration::emitKeepAboveChanged" ref="i11" args="(bool above)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i11">emitKeepAboveChanged</a> (bool above)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="i12"></a><!-- doxytag: member="KDecoration::emitKeepBelowChanged" ref="i12" args="(bool below)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#i12">emitKeepBelowChanged</a> (bool below)</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#l0">keepAboveChanged</a> (bool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#l1">keepBelowChanged</a> (bool)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a0">KDecoration</a> (KDecorationBridge *bridge, <a class="el" href="classKDecorationFactory.html">KDecorationFactory</a> *factory)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a1">~KDecoration</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a2">isActive</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a3">isCloseable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a4">isMaximizable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKDecorationDefines.html#w71">MaximizeMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a5">maximizeMode</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a6">isMinimizable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a7">providesContextHelp</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a8">desktop</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a9">isOnAllDesktops</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a10">isModal</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a11">isShadeable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a12">isShade</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a13">isSetShade</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a14">keepAbove</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a15">keepBelow</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a16">isMovable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a17">isResizable</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NET::WindowType </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a18">windowType</a> (unsigned long supported_types) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QIconSet </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a19">icon</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a20">caption</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a21">showWindowMenu</a> (const QRect &pos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a22">showWindowMenu</a> (QPoint pos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a23">performWindowOperation</a> (<a class="el" href="classKDecorationDefines.html#w72">WindowOperation</a> op)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a24">setMask</a> (const QRegion &reg, int mode=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a25">clearMask</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a26">isPreview</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRect </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a27">geometry</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRect </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a28">iconGeometry</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRegion </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a29">unobscuredRegion</a> (const QRegion &r) const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a30">workspaceWidget</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">WId </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a31">windowId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a32">width</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a33">height</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a34">processMousePressEvent</a> (QMouseEvent *e)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a35">init</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classKDecorationDefines.html#w70">Position</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a36">mousePosition</a> (const QPoint &p) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a37">borders</a> (int &left, int &right, int &top, int &bottom) const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a38">resize</a> (const QSize &s)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QSize </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a39">minimumSize</a> () const =0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a40">activeChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a41">captionChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a42">iconChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a43">maximizeChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a44">desktopChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a45">shadeChange</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a46">drawbound</a> (const QRect &geom, bool clear)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a47">animateMinimize</a> (bool minimize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a48"></a><!-- doxytag: member="KDecoration::windowDocked" ref="a48" args="(Position side)" -->
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a48">windowDocked</a> (<a class="el" href="classKDecorationDefines.html#w70">Position</a> side)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a49">reset</a> (unsigned long changed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a50">setMainWidget</a> (QWidget *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a51">createMainWidget</a> (WFlags flags=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a52">initialParentWidget</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">WFlags </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a53">initialWFlags</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a54">helperShowHide</a> (bool show)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a55">widget</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const QWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a56">widget</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKDecorationFactory.html">KDecorationFactory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a57">factory</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a58">grabXServer</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#a59">ungrabXServer</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="classKDecorationOptions.html">KDecorationOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#e0">options</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="n0"></a><!-- doxytag: member="KDecoration::KDecorationOptions" ref="n0" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKDecoration.html#n0">KDecorationOptions</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is the base class for a decoration object.
<p>
It provides functions that give various information about the decorated window, and also provides pure virtual functions for controlling the decoration that every decoration should implement. <dl compact><dt><b>Since:</b></dt><dd>3.2</dd></dl>
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00309">309</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="KDecoration::KDecoration" ref="a0" args="(KDecorationBridge *bridge, KDecorationFactory *factory)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">KDecoration::KDecoration </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">KDecorationBridge * </td>
<td class="mdname" nowrap> <em>bridge</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="classKDecorationFactory.html">KDecorationFactory</a> * </td>
<td class="mdname" nowrap> <em>factory</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Constructs a KDecoration object.
<p>
Both the arguments are passed from <a class="el" href="classKDecorationFactory.html">KDecorationFactory</a>. Note that the initialization code of the decoration should be done in the <a class="el" href="classKDecoration.html#a35">init()</a> method.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00041">41</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="kdecorationfactory_8cpp-source.html#l00064">KDecorationFactory::addDecoration()</a>. </td>
</tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="KDecoration::~KDecoration" ref="a1" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">KDecoration::~KDecoration </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroys the KDecoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00049">49</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="kdecoration_8h-source.html#l00859">factory()</a>, and <a class="el" href="kdecorationfactory_8cpp-source.html#l00069">KDecorationFactory::removeDecoration()</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0"></a><!-- doxytag: member="KDecoration::options" ref="e0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const <a class="el" href="classKDecorationOptions.html">KDecorationOptions</a> * KDecoration::options </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the <a class="el" href="classKDecorationOptions.html">KDecorationOptions</a> object, which is used to access configuration settings for the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00055">55</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00239">maximize()</a>, and <a class="el" href="kdecorationfactory_8h-source.html#l00115">KDecorationFactory::options()</a>. </td>
</tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="KDecoration::isActive" ref="a2" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isActive </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window is currently active.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00084">84</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="KDecoration::isCloseable" ref="a3" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isCloseable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decoration window can be closed by the user.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00089">89</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="KDecoration::isMaximizable" ref="a4" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isMaximizable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window can be maximized.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00094">94</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="KDecoration::maximizeMode" ref="a5" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classKDecorationDefines.html#w71">KDecoration::MaximizeMode</a> KDecoration::maximizeMode </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the current maximization mode of the decorated window.
<p>
Note that only fully maximized windows should be treated as "maximized" (e.g. if the maximize button has only two states).
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00099">99</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="KDecoration::isMinimizable" ref="a6" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isMinimizable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window can be minimized by the user.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00104">104</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="KDecoration::providesContextHelp" ref="a7" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::providesContextHelp </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return <em>true</em> if the decorated window can show context help (i.e.
<p>
the decoration should provide the context help button).
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00109">109</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="KDecoration::desktop" ref="a8" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int KDecoration::desktop </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the number of the virtual desktop the decorated window is currently on (including NET::OnAllDesktops for being on all desktops).
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00114">114</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8h-source.html#l00864">isOnAllDesktops()</a>. </td>
</tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="KDecoration::isOnAllDesktops" ref="a9" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isOnAllDesktops </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convenience function that returns <em>true</em> if the window is on all virtual desktops.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00864">864</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.
<p>
References <a class="el" href="kdecoration_8cpp-source.html#l00114">desktop()</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00264">toggleOnAllDesktops()</a>. </td>
</tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="KDecoration::isModal" ref="a10" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isModal </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decoration window is modal (usually a modal dialog).
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00119">119</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a11"></a><!-- doxytag: member="KDecoration::isShadeable" ref="a11" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isShadeable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window can be shaded.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00124">124</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a12"></a><!-- doxytag: member="KDecoration::isShade" ref="a12" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isShade </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window is currently shaded.
<p>
If the window is e.g. hover unshaded, it's not considered to be shaded. This function should not be used for the shade titlebar button, use <a class="el" href="classKDecoration.html#a13">isSetShade()</a> instead.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classKDecoration.html#a13">isSetShade</a></dd></dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00129">129</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a13"></a><!-- doxytag: member="KDecoration::isSetShade" ref="a13" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isSetShade </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window was set to be shaded.
<p>
This function returns also true if the window is e.g. hover unshaded, so it doesn't always correspond to the actual window state.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classKDecoration.html#a12">isShade</a></dd></dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00134">134</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a14"></a><!-- doxytag: member="KDecoration::keepAbove" ref="a14" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::keepAbove </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window should be kept above other windows.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00139">139</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a15"></a><!-- doxytag: member="KDecoration::keepBelow" ref="a15" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::keepBelow </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window should be kept below other windows.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00144">144</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a16"></a><!-- doxytag: member="KDecoration::isMovable" ref="a16" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isMovable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window can be moved by the user.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00149">149</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a17"></a><!-- doxytag: member="KDecoration::isResizable" ref="a17" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isResizable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns <em>true</em> if the decorated window can be resized by the user.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00154">154</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a18"></a><!-- doxytag: member="KDecoration::windowType" ref="a18" args="(unsigned long supported_types) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">NET::WindowType KDecoration::windowType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned long </td>
<td class="mdname1" valign="top" nowrap> <em>supported_types</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function returns the window type of the decorated window.
<p>
The argument to this function is a mask of all window types the decoration knows about (as the list of valid window types is extended over time, and fallback types are specified in order to support older code). For a description of all window types, see the definition of the NET::WindowType type. Note that some window types never have decorated windows.<p>
An example of usage: <div class="fragment"><pre class="fragment"> <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> supported_types = NET::NormalMask | NET::DesktopMask
| NET::DockMask | NET::ToolbarMask | NET::MenuMask | NET::DialogMask
| NET::OverrideMask | NET::TopMenuMask | NET::UtilityMask | NET::SplashMask;
NET::WindowType type = <a class="code" href="classKDecoration.html#a18">windowType</a>( supported_types );
<span class="keywordflow">if</span>( type == NET::Utility || type == NET::Menu || type == NET::Toolbar )
<span class="comment">// ... use smaller decorations for tool window types</span>
<span class="keywordflow">else</span>
<span class="comment">// ... use normal decorations</span>
</pre></div>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00159">159</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a19"></a><!-- doxytag: member="KDecoration::icon" ref="a19" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QIconSet KDecoration::icon </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns an icon set with the decorated window's icon.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00164">164</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a20"></a><!-- doxytag: member="KDecoration::caption" ref="a20" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QString KDecoration::caption </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the decorated window's caption that should be shown in the titlebar.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00169">169</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a21"></a><!-- doxytag: member="KDecoration::showWindowMenu" ref="a21" args="(const QRect &pos)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::showWindowMenu </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QRect & </td>
<td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function invokes the window operations menu.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>specifies the place on the screen where the menu should show up. The menu pops up at the bottom-left corner of the specified rectangle, unless there is no space, in which case the menu is displayed above the rectangle.</td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>Decorations that enable a double-click operation for the menu button must ensure to call <em><a class="el" href="classKDecoration.html#a21">showWindowMenu()</a></em> with the <em>pos</em> rectangle set to the menu button geometry. IMPORTANT: As a result of this function, the decoration object that called it may be destroyed after the function returns. This means that the decoration object must either return immediately after calling <a class="el" href="classKDecoration.html#a21">showWindowMenu()</a>, or it must use <a class="el" href="classKDecorationFactory.html#a8">KDecorationFactory::exists()</a> to check it's still valid. For example, the code handling clicks on the menu button should look similarly like this:</dd></dl>
<div class="fragment"><pre class="fragment"> <a class="code" href="classKDecorationFactory.html">KDecorationFactory</a>* f = <a class="code" href="classKDecoration.html#a57">factory</a>(); <span class="comment">// needs to be saved before</span>
<a class="code" href="classKDecoration.html#a21">showWindowMenu</a>( button[MenuButton]->mapToGlobal( menuPoint ));
<span class="keywordflow">if</span>( !f-><a class="code" href="classKDecorationFactory.html#a8">exists</a>( <span class="keyword">this</span> )) <span class="comment">// destroyed, return immediately</span>
<span class="keywordflow">return</span>;
button[MenuButton]->setDown(<span class="keyword">false</span>);
</pre></div>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00179">179</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a22"></a><!-- doxytag: member="KDecoration::showWindowMenu" ref="a22" args="(QPoint pos)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::showWindowMenu </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">QPoint </td>
<td class="mdname1" valign="top" nowrap> <em>pos</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Overloaded version of the above.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00184">184</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a23"></a><!-- doxytag: member="KDecoration::performWindowOperation" ref="a23" args="(WindowOperation op)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::performWindowOperation </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classKDecorationDefines.html#w72">WindowOperation</a> </td>
<td class="mdname1" valign="top" nowrap> <em>op</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function performs the given window operation.
<p>
This function may destroy the current decoration object, just like <a class="el" href="classKDecoration.html#a21">showWindowMenu()</a>.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00189">189</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00239">maximize()</a>. </td>
</tr>
</table>
<a class="anchor" name="a24"></a><!-- doxytag: member="KDecoration::setMask" ref="a24" args="(const QRegion &reg, int mode=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setMask </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QRegion & </td>
<td class="mdname" nowrap> <em>reg</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>mode</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
If the decoration is non-rectangular, this function needs to be called to set the shape of the decoration.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>reg</em> </td><td>The shape of the decoration. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The X11 values Unsorted, YSorted, YXSorted and YXBanded that specify the sorting of the rectangles, default value is Unsorted.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00194">194</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a25"></a><!-- doxytag: member="KDecoration::clearMask" ref="a25" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::clearMask </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This convenience function resets the shape mask.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00199">199</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a26"></a><!-- doxytag: member="KDecoration::isPreview" ref="a26" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::isPreview </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
If this function returns <em>true</em>, the decorated window is used as a preview e.g.
<p>
in the configuration module. In such case, the decoration can e.g. show some information in the window area.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00204">204</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a27"></a><!-- doxytag: member="KDecoration::geometry" ref="a27" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QRect KDecoration::geometry </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the geometry of the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00209">209</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8h-source.html#l00874">height()</a>, <a class="el" href="kdecoration_8cpp-source.html#l00066">setMainWidget()</a>, and <a class="el" href="kdecoration_8h-source.html#l00869">width()</a>. </td>
</tr>
</table>
<a class="anchor" name="a28"></a><!-- doxytag: member="KDecoration::iconGeometry" ref="a28" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QRect KDecoration::iconGeometry </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the icon geometry for the window, i.e.
<p>
the geometry of the taskbar entry. This is used mainly for window minimize animations. Note that the geometry may be null.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00214">214</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a29"></a><!-- doxytag: member="KDecoration::unobscuredRegion" ref="a29" args="(const QRegion &r) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QRegion KDecoration::unobscuredRegion </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QRegion & </td>
<td class="mdname1" valign="top" nowrap> <em>r</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the intersection of the given region with the region left unobscured by the windows stacked above the current one.
<p>
You can use this function to, for example, try to keep the titlebar visible if there is a hole available. The region returned is in the coordinate space of the decoration. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>r</em> </td><td>The region you want to check for holes</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00219">219</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a30"></a><!-- doxytag: member="KDecoration::workspaceWidget" ref="a30" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QWidget * KDecoration::workspaceWidget </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the main workspace widget.
<p>
The main purpose of this function is to allow painting the minimize animation or the transparent move bound on it.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00224">224</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a31"></a><!-- doxytag: member="KDecoration::windowId" ref="a31" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">WId KDecoration::windowId </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the handle of the window that is being decorated.
<p>
It is possible the returned value will be 0. IMPORTANT: This function is meant for special purposes, and it usually should not be used. The main purpose is finding out additional information about the window's state. Also note that different kinds of windows are decorated: Toplevel windows managed by the window manager, test window in the window manager decoration module, and possibly also other cases. Careless abuse of this function will usually sooner or later lead to problems. <dl compact><dt><b>Since:</b></dt><dd>3.4</dd></dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00229">229</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a32"></a><!-- doxytag: member="KDecoration::width" ref="a32" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int KDecoration::width </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convenience function that returns the width of the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00869">869</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.
<p>
References <a class="el" href="kdecoration_8cpp-source.html#l00209">geometry()</a>. </td>
</tr>
</table>
<a class="anchor" name="a33"></a><!-- doxytag: member="KDecoration::height" ref="a33" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int KDecoration::height </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convenience function that returns the height of the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00874">874</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.
<p>
References <a class="el" href="kdecoration_8cpp-source.html#l00209">geometry()</a>. </td>
</tr>
</table>
<a class="anchor" name="a34"></a><!-- doxytag: member="KDecoration::processMousePressEvent" ref="a34" args="(QMouseEvent *e)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::processMousePressEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">QMouseEvent * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is the default handler for mouse events.
<p>
All mouse events that are not handled by the decoration itself should be passed to it in order to make work operations like window resizing by dragging borders etc.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00174">174</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a35"></a><!-- doxytag: member="KDecoration::init" ref="a35" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::init </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called immediately after the decoration object is created.
<p>
Due to some technical reasons, initialization should be done here instead of in the constructor. </td>
</tr>
</table>
<a class="anchor" name="a36"></a><!-- doxytag: member="KDecoration::mousePosition" ref="a36" args="(const QPoint &p) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classKDecorationDefines.html#w70">KDecoration::Position</a> KDecoration::mousePosition </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QPoint & </td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function should return mouse cursor position in the decoration.
<p>
Positions at the edge will result in window resizing with mouse button pressed, center position will result in moving.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00326">326</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="classKDecoration.html#a37">borders()</a>, and <a class="el" href="kdecoration_8h-source.html#l00849">widget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a37"></a><!-- doxytag: member="KDecoration::borders" ref="a37" args="(int &left, int &right, int &top, int &bottom) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::borders </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int & </td>
<td class="mdname" nowrap> <em>left</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int & </td>
<td class="mdname" nowrap> <em>right</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int & </td>
<td class="mdname" nowrap> <em>top</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int & </td>
<td class="mdname" nowrap> <em>bottom</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function should return the distance from each window side to the inner window.
<p>
The sizes may depend on the state of the decorated window, such as whether it's shaded. Decorations often turn off their bottom border when the window is shaded, and turn off their left/right/bottom borders when the window is maximized and moving and resizing of maximized windows is disabled. This function mustn't do any repaints or resizes. Also, if the sizes returned by this function don't match the real values, this may result in drawing errors or other problems.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classKDecorationOptions.html#a10">KDecorationOptions::moveResizeMaximizedWindows()</a></dd></dl>
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00326">mousePosition()</a>. </td>
</tr>
</table>
<a class="anchor" name="a38"></a><!-- doxytag: member="KDecoration::resize" ref="a38" args="(const QSize &s)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::resize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QSize & </td>
<td class="mdname1" valign="top" nowrap> <em>s</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This method is called by kwin when the style should resize the decoration window.
<p>
The usual implementation is to resize the main widget of the decoration to the given size.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>Specifies the new size of the decoration window.</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a39"></a><!-- doxytag: member="KDecoration::minimumSize" ref="a39" args="() const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual QSize KDecoration::minimumSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function should return the minimum required size for the decoration.
<p>
Note that the returned size shouldn't be too large, because it will be used to keep the decorated window at least as large. </td>
</tr>
</table>
<a class="anchor" name="a40"></a><!-- doxytag: member="KDecoration::activeChange" ref="a40" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::activeChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the window either becomes or stops being active.
<p>
Use <a class="el" href="classKDecoration.html#a2">isActive()</a> to find out the current state. </td>
</tr>
</table>
<a class="anchor" name="a41"></a><!-- doxytag: member="KDecoration::captionChange" ref="a41" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::captionChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the caption changes.
<p>
Use <a class="el" href="classKDecoration.html#a20">caption()</a> to get it. </td>
</tr>
</table>
<a class="anchor" name="a42"></a><!-- doxytag: member="KDecoration::iconChange" ref="a42" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::iconChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the window icon changes.
<p>
Use <a class="el" href="classKDecoration.html#a19">icon()</a> to get it. </td>
</tr>
</table>
<a class="anchor" name="a43"></a><!-- doxytag: member="KDecoration::maximizeChange" ref="a43" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::maximizeChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the maximalization state of the window changes.
<p>
Use <a class="el" href="classKDecoration.html#a5">maximizeMode()</a> to get the current state. </td>
</tr>
</table>
<a class="anchor" name="a44"></a><!-- doxytag: member="KDecoration::desktopChange" ref="a44" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::desktopChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the desktop for the window changes.
<p>
Use <a class="el" href="classKDecoration.html#a8">desktop()</a> or <a class="el" href="classKDecoration.html#a9">isOnAllDesktops()</a> to find out the current desktop on which the window is. </td>
</tr>
</table>
<a class="anchor" name="a45"></a><!-- doxytag: member="KDecoration::shadeChange" ref="a45" args="()=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void KDecoration::shadeChange </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called whenever the window is shaded or unshaded.
<p>
Use <a class="el" href="classKDecoration.html#a12">isShade()</a> to get the current state. </td>
</tr>
</table>
<a class="anchor" name="l0"></a><!-- doxytag: member="KDecoration::keepAboveChanged" ref="l0" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::keepAboveChanged </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [signal]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever the window's keep-above state changes.
<p>
<dl compact><dt><b>Since:</b></dt><dd>3.3</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="l1"></a><!-- doxytag: member="KDecoration::keepBelowChanged" ref="l1" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::keepBelowChanged </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [signal]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This signal is emitted whenever the window's keep-below state changes.
<p>
<dl compact><dt><b>Since:</b></dt><dd>3.3</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a46"></a><!-- doxytag: member="KDecoration::drawbound" ref="a46" args="(const QRect &geom, bool clear)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::drawbound </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const QRect & </td>
<td class="mdname" nowrap> <em>geom</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>clear</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function may be reimplemented to provide custom bound drawing for transparent moving or resizing of the window.
<p>
<em>False</em> should be returned if the default implementation should be used. Note that if you e.g. paint the outline using a 5 pixels wide line, you should compensate for the 2 pixels that would make the window look larger.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>geom</em> </td><td>The geometry at this the bound should be drawn </td></tr>
<tr><td valign="top"></td><td valign="top"><em>clear</em> </td><td><em>true</em> if the bound should be cleared</td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classKDecoration.html#a30">workspaceWidget()</a> and <a class="el" href="classKDecoration.html#a27">geometry()</a>.</dd></dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00292">292</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a47"></a><!-- doxytag: member="KDecoration::animateMinimize" ref="a47" args="(bool minimize)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool KDecoration::animateMinimize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>minimize</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function may be reimplemented to provide custom minimize/restore animations The reimplementation is allowed to perform X server grabs if necessary (only using the functions provided by this API, no direct Xlib calls), but no futher event processing is allowed (i.e.
<p>
no kapp->processEvents()). <em>False</em> should be returned if the default implementation should be used. Note that you should not use this function to force disabling of the animation.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classKDecoration.html#a30">workspaceWidget()</a>, <a class="el" href="classKDecoration.html#a27">geometry()</a> and <a class="el" href="classKDecoration.html#a54">helperShowHide()</a>.</dd></dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00297">297</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a49"></a><!-- doxytag: member="KDecoration::reset" ref="a49" args="(unsigned long changed)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::reset </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned long </td>
<td class="mdname1" valign="top" nowrap> <em>changed</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is called to reset the decoration on settings changes.
<p>
It is usually invoked by calling <a class="el" href="classKDecorationFactory.html#b0">KDecorationFactory::resetDecorations()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>changed</em> </td><td>Specifies which settings were changed, given by the SettingXXX masks</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00312">312</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a50"></a><!-- doxytag: member="KDecoration::setMainWidget" ref="a50" args="(QWidget *)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setMainWidget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">QWidget * </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This should be the first function called in <a class="el" href="classKDecoration.html#a35">init()</a> to specify the main widget of the decoration.
<p>
The widget should be created with parent specified by <a class="el" href="classKDecoration.html#a52">initialParentWidget()</a> and flags specified by <a class="el" href="classKDecoration.html#a53">initialWFlags()</a>.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00066">66</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="kdecoration_8cpp-source.html#l00209">geometry()</a>, and <a class="el" href="kdecoration_8h-source.html#l00849">widget()</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00060">createMainWidget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a51"></a><!-- doxytag: member="KDecoration::createMainWidget" ref="a51" args="(WFlags flags=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::createMainWidget </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">WFlags </td>
<td class="mdname1" valign="top" nowrap> <em>flags</em> = <code>0</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Convenience functions that creates and sets a main widget as necessary.
<p>
In such case, it's usually needed to install an event filter on the main widget to receive important events on it.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Additional widget flags for the main widget. Note that only flags that affect widget drawing are allowed. Window type flags like WX11BypassWM or WStyle_NoBorder are forbidden.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00060">60</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="kdecoration_8cpp-source.html#l00074">initialParentWidget()</a>, <a class="el" href="kdecoration_8cpp-source.html#l00079">initialWFlags()</a>, and <a class="el" href="kdecoration_8cpp-source.html#l00066">setMainWidget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a52"></a><!-- doxytag: member="KDecoration::initialParentWidget" ref="a52" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QWidget * KDecoration::initialParentWidget </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The parent widget that should be used for the main widget.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00074">74</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00060">createMainWidget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a53"></a><!-- doxytag: member="KDecoration::initialWFlags" ref="a53" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">Qt::WFlags KDecoration::initialWFlags </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The flags that should be used when creating the main widget.
<p>
It is possible to add more flags when creating the main widget, but only flags that affect widget drawing are allowed. Window type flags like WX11BypassWM or WStyle_NoBorder are forbidden.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00079">79</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00060">createMainWidget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a54"></a><!-- doxytag: member="KDecoration::helperShowHide" ref="a54" args="(bool show)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::helperShowHide </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>show</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function is only allowed to be called once from <a class="el" href="classKDecoration.html#a47">animateMinimize()</a>.
<p>
It can be used if the window should be shown or hidden at a specific time during the animation. It is forbidden to use this function for other purposes.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00307">307</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a55"></a><!-- doxytag: member="KDecoration::widget" ref="a55" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QWidget * KDecoration::widget </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the main widget for the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00849">849</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00326">mousePosition()</a>, and <a class="el" href="kdecoration_8cpp-source.html#l00066">setMainWidget()</a>. </td>
</tr>
</table>
<a class="anchor" name="a56"></a><!-- doxytag: member="KDecoration::widget" ref="a56" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const QWidget * KDecoration::widget </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the main widget for the decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00854">854</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>. </td>
</tr>
</table>
<a class="anchor" name="a57"></a><!-- doxytag: member="KDecoration::factory" ref="a57" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="classKDecorationFactory.html">KDecorationFactory</a> * KDecoration::factory </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Returns the factory that created this decoration.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8h-source.html#l00859">859</a> of file <a class="el" href="kdecoration_8h-source.html">kdecoration.h</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00049">~KDecoration()</a>. </td>
</tr>
</table>
<a class="anchor" name="a58"></a><!-- doxytag: member="KDecoration::grabXServer" ref="a58" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::grabXServer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Performs X server grab.
<p>
It is safe to call it several times in a row.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00316">316</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="a59"></a><!-- doxytag: member="KDecoration::ungrabXServer" ref="a59" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::ungrabXServer </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Ungrabs X server (if the number of ungrab attempts matches the number of grab attempts).
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00321">321</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i0"></a><!-- doxytag: member="KDecoration::closeWindow" ref="i0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::closeWindow </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function can be called by the decoration to request closing of the decorated window.
<p>
Note that closing the window also involves destroying the decoration. IMPORTANT: This function may destroy the current decoration object, just like <a class="el" href="classKDecoration.html#a21">showWindowMenu()</a>.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00234">234</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i2"></a><!-- doxytag: member="KDecoration::maximize" ref="i2" args="(MaximizeMode mode)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::maximize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classKDecorationDefines.html#w71">MaximizeMode</a> </td>
<td class="mdname1" valign="top" nowrap> <em>mode</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the maximize mode of the decorated window.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>The maximization mode to be set.</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00244">244</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i3"></a><!-- doxytag: member="KDecoration::minimize" ref="i3" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::minimize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Minimize the decorated window.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00249">249</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i4"></a><!-- doxytag: member="KDecoration::showContextHelp" ref="i4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::showContextHelp </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Start showing context help in the window (i.e.
<p>
the mouse will enter the what's this mode).
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00254">254</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i5"></a><!-- doxytag: member="KDecoration::setDesktop" ref="i5" args="(int desktop)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setDesktop </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>desktop</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Moves the window to the given desktop.
<p>
Use NET::OnAllDesktops for making the window appear on all desktops.
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00259">259</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
Referenced by <a class="el" href="kdecoration_8cpp-source.html#l00264">toggleOnAllDesktops()</a>. </td>
</tr>
</table>
<a class="anchor" name="i6"></a><!-- doxytag: member="KDecoration::toggleOnAllDesktops" ref="i6" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::toggleOnAllDesktops </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function toggles the on-all-desktops state of the decorated window.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00264">264</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>.
<p>
References <a class="el" href="kdecoration_8h-source.html#l00864">isOnAllDesktops()</a>, and <a class="el" href="kdecoration_8cpp-source.html#l00259">setDesktop()</a>. </td>
</tr>
</table>
<a class="anchor" name="i7"></a><!-- doxytag: member="KDecoration::titlebarDblClickOperation" ref="i7" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::titlebarDblClickOperation </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This function performs the operation configured as titlebar double click operation.
<p>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00272">272</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i8"></a><!-- doxytag: member="KDecoration::setShade" ref="i8" args="(bool set)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setShade </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>set</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Shades or unshades the decorated window.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>set</em> </td><td>Whether the window should be shaded</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00277">277</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i9"></a><!-- doxytag: member="KDecoration::setKeepAbove" ref="i9" args="(bool set)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setKeepAbove </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>set</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets or reset keeping this window above others.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>set</em> </td><td>Whether to keep the window above others</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00282">282</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="i10"></a><!-- doxytag: member="KDecoration::setKeepBelow" ref="i10" args="(bool set)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void KDecoration::setKeepBelow </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>set</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [slot]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Sets or reset keeping this window below others.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>set</em> </td><td>Whether to keep the window below others</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="kdecoration_8cpp-source.html#l00287">287</a> of file <a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kdecoration_8h-source.html">kdecoration.h</a><li><a class="el" href="kdecoration_8cpp-source.html">kdecoration.cpp</a></ul>
</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>
