<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kdeui: KPanelApplet Class Reference (kdeui)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kdeui</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">KPanelApplet Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KPanelApplet" --><!-- doxytag: inherits="QFrame" -->
<p>KDE Panel Applet class
<a href="classKPanelApplet.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KPanelApplet:</div>
<div class="dyncontent">
<div class="center">
<img src="classKPanelApplet.png" usemap="#KPanelApplet_map" alt=""/>
<map id="KPanelApplet_map" name="KPanelApplet_map">
<area href="qframe.html" alt="QFrame" shape="rect" coords="0,0,88,24"/>
</map>
</div></div>
<p><a href="classKPanelApplet-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">Type</a> { <b>Normal</b> = 0,
<b>Stretch</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a703f2366ae0ec355a7b9ae2c20dc8e2c">Action</a> { <b>About</b> = 1,
<b>Help</b> = 2,
<b>Preferences</b> = 4,
<b>ReportBug</b> = 8
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Position</b> { <b>pLeft</b> = 0,
<b>pRight</b>,
<b>pTop</b>,
<b>pBottom</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Alignment</b> { <b>LeftTop</b> = 0,
<b>Center</b>,
<b>RightBottom</b>
}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><b>Direction</b> { <b>Up</b> = 0,
<b>Down</b>,
<b>Left</b>,
<b>Right</b>
}</td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a7b0c2bc434a01c202764a621e22506bc">updateLayout</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#aed0ebaf1fa7ea890c65d471c80567a68">requestFocus</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#aee9059ecb5a90c11f56be7f8b086621d">requestFocus</a> (bool focus)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#ad9dcab8ad6088c1bcdab151316ed4fe2">KPanelApplet</a> (const <a class="elRef" href="qstring.html">QString</a> &configFile, <a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">Type</a> t=Normal, int actions=0, <a class="elRef" href="qwidget.html">QWidget</a> *parent=0, const char *name=0, WFlags f=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#af97d197fd03d0425c5f870a387bb6f30">~KPanelApplet</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#abd5aba1ab119f3b04798f5eb35c30f1a">widthForHeight</a> (int height) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#abedad8c89c1c3eae0061fbf3cbde14a3">heightForWidth</a> (int width) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKConfig.html">KConfig</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#aff8c1eb2c3b73fd02b4d3892f7a82f9b">config</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ae6bd0a0136262bf77282a19369b64c"></a><!-- doxytag: member="KPanelApplet::sharedConfig" ref="a4ae6bd0a0136262bf77282a19369b64c" args="() const " -->
<a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKSharedPtr.html">KSharedConfig::Ptr</a> </td><td class="memItemRight" valign="bottom"><b>sharedConfig</b> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a3a555a9052479177b6c6895ebe4eefe3">type</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a2308ce047a617ed323755a53c46d451d">actions</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a871e004515c90666901245c566de0dd7">action</a> (<a class="el" href="classKPanelApplet.html#a703f2366ae0ec355a7b9ae2c20dc8e2c">Action</a> a)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="elRef" href="qpopupmenu.html">QPopupMenu</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a8885265a16f0220101a81cf6d1ed29bf">customMenu</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a882a9262f16f35d2c5f8128dfe2b250a">setPosition</a> (Position p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a6b575dc3ede4f96ef42e3b2710b35a98">setAlignment</a> (Alignment a)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#afd6b395114dc89416f7e34908e463a21">about</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#ae5f782dd049d172de2207158c47d0379">help</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a368011a825bae345a9b239efc9a466cf">preferences</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a2612129733fd033479997972408079e3">reportBug</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Orientation </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a6879645c4d64b85463427323ff8fc071">orientation</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Position </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a7acd26caf294a1eabca648d7b7e81419">position</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Alignment </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a6851e229218338bfb1e0e772e7e284ef">alignment</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a50a80e11a72e6096458a7f7e1f8154df">positionChange</a> (Position p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a4ab65b01dbe48943ed3ca31212f0c33f">alignmentChange</a> (Alignment)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#ace4f7b22056ab0f72eaa6810ecda60e8">setCustomMenu</a> (const <a class="elRef" href="qpopupmenu.html">QPopupMenu</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#af285c91e55d3d4d6b5a2fa7e7354148d">watchForFocus</a> (<a class="elRef" href="qwidget.html">QWidget</a> *widget, bool watch=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a7b24ca5547299f2367898e16656cb591">needsFocus</a> (bool focus)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual KDE_DEPRECATED void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a1cba678033fac46ce7c4bce41b82a03d">orientationChange</a> (Orientation)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Direction </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a53f4c4305efa096ccbfac2d1f610d0d2">popupDirection</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual KDE_DEPRECATED void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKPanelApplet.html#a888d169c58153e7523afc2012858151e">popupDirectionChange</a> (Direction)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad839a23b211c66f258b845da8e1feb82"></a><!-- doxytag: member="KPanelApplet::eventFilter" ref="ad839a23b211c66f258b845da8e1feb82" args="(QObject *, QEvent *)" -->
bool </td><td class="memItemRight" valign="bottom"><b>eventFilter</b> (<a class="elRef" href="qobject.html">QObject</a> *, <a class="elRef" href="qevent.html">QEvent</a> *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76d82f650ed3ba06030d4dbe0073ea65"></a><!-- doxytag: member="KPanelApplet::virtual_hook" ref="a76d82f650ed3ba06030d4dbe0073ea65" args="(int id, void *data)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>virtual_hook</b> (int id, void *data)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a404f5bd8e5d44617a5caa0763b22b748"></a><!-- doxytag: member="KPanelApplet::d" ref="a404f5bd8e5d44617a5caa0763b22b748" args="" -->
KPanelAppletPrivate * </td><td class="memItemRight" valign="bottom"><b>d</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>KDE Panel Applet class </p>
<p>Panel applets </p>
<ul>
<li>Are small applications living in the KDE panel. </li>
<li>Are implemented as DSOs (Dynamic Shared Objects).</li>
</ul>
<p>Note: For security and stability reasons the panel won't load untrusted third party applets directly into its namespace but via an external wrapper process.</p>
<p>The panel locates available applets by searching for applet desktop files in (ALL_DIRS)/share/apps/kicker/applets. Every panel applet should install a desktop file there to be recognized by the panel.</p>
<p>Besides standard keys like "Name", "Comment" and "Icon" there are two panel applet specific keys:</p>
<p><b>X-KDE-Library</b> <br/>
</p>
<p>Used by the panel to locate the applet DSO (Dynamic Shared Object) Example: X-KDE-Library=libexampleapplet</p>
<p><b>X-KDE-UniqueApplet</b> <br/>
</p>
<p>Similar to <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKApplication.html">KApplication</a> and <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKUniqueApplication.html">KUniqueApplication</a> there are two types of panel applets. Use unique applets when it makes no sence to run more than one instance of a applet in the panel. A good example for unique applets is the taskbar applet. Use normal applets when you need instance specific configuration. An example is the koolclock applet where you might want to run two instances in your panel, one configured as analog clock, the other one as digital clock. X-KDE-UniqueApplet is a boolean key which defaults to "false". Example: X-KDE-UniqueApplet=true</p>
<p>Back to panel applet DSOs, the following conventions are used for KDE: Name: lib<appletname>applet.la LDFLAGS: -module -no-undefined</p>
<p>To implement a panel applet it is not enough to write a class inheriting from <a class="el" href="classKPanelApplet.html" title="KDE Panel Applet class">KPanelApplet</a> but you also have to provide a factory function in your DSO. A sample factory function could look like this:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">extern</span> <span class="stringliteral">"C"</span>
{
<a class="code" href="classKPanelApplet.html" title="KDE Panel Applet class">KPanelApplet</a>* init(<a class="codeRef" href="qwidget.html">QWidget</a> *parent, <span class="keyword">const</span> <a class="codeRef" href="qstring.html">QString</a>& configFile)
{
<a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKGlobal.html#a8c3e5ecff78f674b94eadfe0eae067e1">KGlobal::locale</a>()-><a class="codeRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKLocale.html#af14d084c90a004164fa037458377740e">insertCatalogue</a>(<span class="stringliteral">"exampleapplet"</span>);
<span class="keywordflow">return</span> <span class="keyword">new</span> ExampleApplet(configFile, KPanelApplet::Normal,
KPanelApplet::About | KPanelApplet::Help | KPanelApplet::Preferences,
parent, <span class="stringliteral">"exampleapplet"</span>);
}
}
</pre></div><p>Note: Don't change the factory function signature or the panel will fail to load your applet.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Matthias Elter <<a href="mailto:elter@kde.org">elter@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00097">97</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="a703f2366ae0ec355a7b9ae2c20dc8e2c"></a><!-- doxytag: member="KPanelApplet::Action" ref="a703f2366ae0ec355a7b9ae2c20dc8e2c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKPanelApplet.html#a703f2366ae0ec355a7b9ae2c20dc8e2c">KPanelApplet::Action</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This enum holds flags which can be ORed together to describe which items the context menu over the applet handle contains. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00112">112</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a30aa521323e193f47607dc9b4f45fb7b"></a><!-- doxytag: member="KPanelApplet::Type" ref="a30aa521323e193f47607dc9b4f45fb7b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">KPanelApplet::Type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This enum describes the type of the applet. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00106">106</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ad9dcab8ad6088c1bcdab151316ed4fe2"></a><!-- doxytag: member="KPanelApplet::KPanelApplet" ref="ad9dcab8ad6088c1bcdab151316ed4fe2" args="(const QString &configFile, Type t=Normal, int actions=0, QWidget *parent=0, const char *name=0, WFlags f=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KPanelApplet::KPanelApplet </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>configFile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">Type</a> </td>
<td class="paramname"><em>t</em> = <code>Normal</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>actions</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">WFlags </td>
<td class="paramname"><em>f</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a <a class="el" href="classKPanelApplet.html" title="KDE Panel Applet class">KPanelApplet</a> just like any other widget. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">configFile</td><td>The configFile handed over in the factory function. </td></tr>
<tr><td class="paramname">t</td><td>The applet <a class="el" href="classKPanelApplet.html#a3a555a9052479177b6c6895ebe4eefe3">type()</a>. </td></tr>
<tr><td class="paramname">actions</td><td>Standard RMB menu actions supported by the applet (see <a class="el" href="classKPanelApplet.html#a871e004515c90666901245c566de0dd7" title="Generic action dispatcher.">action()</a> ). </td></tr>
<tr><td class="paramname">parent</td><td>The pointer to the parent widget handed over in the factory function. </td></tr>
<tr><td class="paramname">name</td><td>A <a class="elRef" href="qt.html">Qt</a> object name for your applet. </td></tr>
<tr><td class="paramname">f</td><td>Window control flags </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00045">45</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="af97d197fd03d0425c5f870a387bb6f30"></a><!-- doxytag: member="KPanelApplet::~KPanelApplet" ref="af97d197fd03d0425c5f870a387bb6f30" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KPanelApplet::~KPanelApplet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00067">67</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afd6b395114dc89416f7e34908e463a21"></a><!-- doxytag: member="KPanelApplet::about" ref="afd6b395114dc89416f7e34908e463a21" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KPanelApplet::about </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Is called when the user selects "About" from the applet's RMB menu. </p>
<p>Reimplement this function to launch a about dialog.</p>
<p>Note that this is called only when your applet supports the About action. See Action and <a class="el" href="classKPanelApplet.html#ad9dcab8ad6088c1bcdab151316ed4fe2" title="Constructs a KPanelApplet just like any other widget.">KPanelApplet()</a>. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00272">272</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a871e004515c90666901245c566de0dd7"></a><!-- doxytag: member="KPanelApplet::action" ref="a871e004515c90666901245c566de0dd7" args="(Action a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::action </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKPanelApplet.html#a703f2366ae0ec355a7b9ae2c20dc8e2c">Action</a> </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generic action dispatcher. </p>
<p>Called when the user selects an item from the applet's RMB menu.</p>
<p>Reimplement this function to handle actions.</p>
<p>For About, Help, Preferences and ReportBug, use the convenience handlers ref <a class="el" href="classKPanelApplet.html#afd6b395114dc89416f7e34908e463a21" title="Is called when the user selects "About" from the applet's RMB menu.">about()</a>, <a class="el" href="classKPanelApplet.html#ae5f782dd049d172de2207158c47d0379" title="Is called when the user selects "Help" from the applet's RMB menu.">help()</a>, <a class="el" href="classKPanelApplet.html#a368011a825bae345a9b239efc9a466cf" title="Is called when the user selects "Preferences" from the applet's RMB menu.">preferences()</a>, <a class="el" href="classKPanelApplet.html#a2612129733fd033479997972408079e3" title="Is called when the user selects "Report bug" from the applet's RMB menu.">reportBug()</a> </p>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00118">118</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2308ce047a617ed323755a53c46d451d"></a><!-- doxytag: member="KPanelApplet::actions" ref="a2308ce047a617ed323755a53c46d451d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KPanelApplet::actions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>int indicating the supported RMB menu actions. Action </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00200">200</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a6851e229218338bfb1e0e772e7e284ef"></a><!-- doxytag: member="KPanelApplet::alignment" ref="a6851e229218338bfb1e0e772e7e284ef" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Alignment KPanelApplet::alignment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the applet's alignment. (top/left, center, or bottom/right) </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00313">313</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a4ab65b01dbe48943ed3ca31212f0c33f"></a><!-- doxytag: member="KPanelApplet::alignmentChange" ref="a4ab65b01dbe48943ed3ca31212f0c33f" args="(Alignment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KPanelApplet::alignmentChange </td>
<td>(</td>
<td class="paramtype">Alignment </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The panel on which this applet resides has changed its alignment. </p>
<p>Reimplement this change handler in order to adjust the look of your applet. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00327">327</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff8c1eb2c3b73fd02b4d3892f7a82f9b"></a><!-- doxytag: member="KPanelApplet::config" ref="aff8c1eb2c3b73fd02b4d3892f7a82f9b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKConfig.html">KConfig</a>* KPanelApplet::config </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Always use this <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKConfig.html">KConfig</a> object to save/load your applet's configuration. </p>
<p>For unique applets this config object will write to a config file called <appletname>rc in the user's local KDE directory.</p>
<p>For normal applets this config object will write to a instance specific config file called <appletname><instanceid>rc in the user's local KDE directory. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00187">187</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8885265a16f0220101a81cf6d1ed29bf"></a><!-- doxytag: member="KPanelApplet::customMenu" ref="a8885265a16f0220101a81cf6d1ed29bf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="elRef" href="qpopupmenu.html">QPopupMenu</a> * KPanelApplet::customMenu </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the applet's custom menu, usually the same as the context menu, or 0 if none see setCustomMenu(QPopupMenu*) </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00130">130</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abedad8c89c1c3eae0061fbf3cbde14a3"></a><!-- doxytag: member="KPanelApplet::heightForWidth" ref="abedad8c89c1c3eae0061fbf3cbde14a3" args="(int width) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int KPanelApplet::heightForWidth </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>width</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>A suggested height for a given width.</dd></dl>
<p>Every applet should reimplement this function.</p>
<p>Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.</p>
<p>On a vertical panel the applet width is fixed, the panel will call heightForWidth(int width) with <code>width</code> equal to 'the fixed applet width' when laying out the applets.</p>
<p>The applet can now choose the other size component (height) based on the given width.</p>
<p>The height you return is granted. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00176">176</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae5f782dd049d172de2207158c47d0379"></a><!-- doxytag: member="KPanelApplet::help" ref="ae5f782dd049d172de2207158c47d0379" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KPanelApplet::help </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Is called when the user selects "Help" from the applet's RMB menu. </p>
<p>Reimplement this function to launch a manual or help page.</p>
<p>Note that this is called only when your applet supports the Help action. See Action and <a class="el" href="classKPanelApplet.html#ad9dcab8ad6088c1bcdab151316ed4fe2" title="Constructs a KPanelApplet just like any other widget.">KPanelApplet()</a>. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00281">281</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7b24ca5547299f2367898e16656cb591"></a><!-- doxytag: member="KPanelApplet::needsFocus" ref="a7b24ca5547299f2367898e16656cb591" args="(bool focus)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::needsFocus </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>focus</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call this whenever focus is needed or not needed. </p>
<p>You do not have to call this method for widgets that have been registered with watchForFocus </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">focus</td><td>whether to or not to request focus </td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00162">162</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6879645c4d64b85463427323ff8fc071"></a><!-- doxytag: member="KPanelApplet::orientation" ref="a6879645c4d64b85463427323ff8fc071" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Qt::Orientation KPanelApplet::orientation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the applet's orientation. (horizontal or vertical) </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00097">97</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1cba678033fac46ce7c4bce41b82a03d"></a><!-- doxytag: member="KPanelApplet::orientationChange" ref="a1cba678033fac46ce7c4bce41b82a03d" args="(Orientation)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual KDE_DEPRECATED void KPanelApplet::orientationChange </td>
<td>(</td>
<td class="paramtype">Orientation </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The orientation changed to <code>orientation</code>. </p>
<p>Reimplement this change handler in order to adjust the look of your applet.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000059">Deprecated:</a></b></dt><dd>Reimplement positionChange instead. </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00364">364</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a53f4c4305efa096ccbfac2d1f610d0d2"></a><!-- doxytag: member="KPanelApplet::popupDirection" ref="a53f4c4305efa096ccbfac2d1f610d0d2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KPanelApplet::Direction KPanelApplet::popupDirection </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A convenience method that translates the position of the applet into which direction to show a popup. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00107">107</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a888d169c58153e7523afc2012858151e"></a><!-- doxytag: member="KPanelApplet::popupDirectionChange" ref="a888d169c58153e7523afc2012858151e" args="(Direction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual KDE_DEPRECATED void KPanelApplet::popupDirectionChange </td>
<td>(</td>
<td class="paramtype">Direction </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The popup direction changed to <code>direction</code>. </p>
<p>Reimplement this change handler in order to adjust the look of your applet.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000060">Deprecated:</a></b></dt><dd>Reimplement positionChange instead. </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00379">379</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7acd26caf294a1eabca648d7b7e81419"></a><!-- doxytag: member="KPanelApplet::position" ref="a7acd26caf294a1eabca648d7b7e81419" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Position KPanelApplet::position </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the applet's position. (top, left, bottom, or right) </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00309">309</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a50a80e11a72e6096458a7f7e1f8154df"></a><!-- doxytag: member="KPanelApplet::positionChange" ref="a50a80e11a72e6096458a7f7e1f8154df" args="(Position p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::positionChange </td>
<td>(</td>
<td class="paramtype">Position </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The panel on which this applet resides has changed its position. </p>
<p>Reimplement this change handler in order to adjust the look of your applet. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00089">89</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a368011a825bae345a9b239efc9a466cf"></a><!-- doxytag: member="KPanelApplet::preferences" ref="a368011a825bae345a9b239efc9a466cf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KPanelApplet::preferences </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Is called when the user selects "Preferences" from the applet's RMB menu. </p>
<p>Reimplement this function to launch a preferences dialog or kcontrol module.</p>
<p>Note that this is called only when your applet supports the preferences action. See Action and <a class="el" href="classKPanelApplet.html#ad9dcab8ad6088c1bcdab151316ed4fe2" title="Constructs a KPanelApplet just like any other widget.">KPanelApplet()</a>. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00290">290</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2612129733fd033479997972408079e3"></a><!-- doxytag: member="KPanelApplet::reportBug" ref="a2612129733fd033479997972408079e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void KPanelApplet::reportBug </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Is called when the user selects "Report bug" from the applet's RMB menu. </p>
<p>Reimplement this function to launch a bug reporting dialog.</p>
<p>Note that this is called only when your applet supports the ReportBug action. See Action and <a class="el" href="classKPanelApplet.html#ad9dcab8ad6088c1bcdab151316ed4fe2" title="Constructs a KPanelApplet just like any other widget.">KPanelApplet()</a> </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00300">300</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="aed0ebaf1fa7ea890c65d471c80567a68"></a><!-- doxytag: member="KPanelApplet::requestFocus" ref="aed0ebaf1fa7ea890c65d471c80567a68" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::requestFocus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request keyboard focus from the panel. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000058">Deprecated:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="aee9059ecb5a90c11f56be7f8b086621d"></a><!-- doxytag: member="KPanelApplet::requestFocus" ref="aee9059ecb5a90c11f56be7f8b086621d" args="(bool focus)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::requestFocus </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>focus</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Request keyboard focus from the panel. </p>
<p>Applets should never call this directly but rather call <a class="el" href="classKPanelApplet.html#a7b24ca5547299f2367898e16656cb591" title="Call this whenever focus is needed or not needed.">needsFocus(bool)</a> </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classKPanelApplet.html#a7b24ca5547299f2367898e16656cb591" title="Call this whenever focus is needed or not needed.">needsFocus</a> </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">focus</td><td>activate the window and ensure the panel remains visible when true Each and ever time a requestFocus(true) is emitted, it MUST be paired eventually with a requestFocus(false) otherwise the panel may end up never hiding </td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
</div>
</div>
<a class="anchor" id="a6b575dc3ede4f96ef42e3b2710b35a98"></a><!-- doxytag: member="KPanelApplet::setAlignment" ref="a6b575dc3ede4f96ef42e3b2710b35a98" args="(Alignment a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::setAlignment </td>
<td>(</td>
<td class="paramtype">Alignment </td>
<td class="paramname"><em>a</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00081">81</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ace4f7b22056ab0f72eaa6810ecda60e8"></a><!-- doxytag: member="KPanelApplet::setCustomMenu" ref="ace4f7b22056ab0f72eaa6810ecda60e8" args="(const QPopupMenu *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::setCustomMenu </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qpopupmenu.html">QPopupMenu</a> * </td>
<td class="paramname"><em>menu</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Use this method to set the custom menu for this applet so that it can be shown in the applet handle menu and other appropriate places that the applet many not itself be aware of. </p>
<p>The applet itself is still responsible for deleting and managing the the menu.</p>
<p>If the menu is deleted during the life of the applet, be sure to call this method again with the new menu (or 0) to avoid crashes </p>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00135">135</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a882a9262f16f35d2c5f8128dfe2b250a"></a><!-- doxytag: member="KPanelApplet::setPosition" ref="a882a9262f16f35d2c5f8128dfe2b250a" args="(Position p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::setPosition </td>
<td>(</td>
<td class="paramtype">Position </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00074">74</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a555a9052479177b6c6895ebe4eefe3"></a><!-- doxytag: member="KPanelApplet::type" ref="a3a555a9052479177b6c6895ebe4eefe3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKPanelApplet.html#a30aa521323e193f47607dc9b4f45fb7b">Type</a> KPanelApplet::type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>Type indicating the applet's type. Type </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00194">194</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7b0c2bc434a01c202764a621e22506bc"></a><!-- doxytag: member="KPanelApplet::updateLayout" ref="a7b0c2bc434a01c202764a621e22506bc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::updateLayout </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emit this signal to make the panel relayout all applets, when you want to change your width (horizontal panel) or height (vertical panel). </p>
<p>The panel is going to relayout all applets based on their widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel).</p>
<p>Please note that the panel may change the applet's location if the new widthForHeight(int height) (horizontal panel) or heightForWidth(int width) (vertical panel) does not fit into the current panel layout. </p>
</div>
</div>
<a class="anchor" id="af285c91e55d3d4d6b5a2fa7e7354148d"></a><!-- doxytag: member="KPanelApplet::watchForFocus" ref="af285c91e55d3d4d6b5a2fa7e7354148d" args="(QWidget *widget, bool watch=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KPanelApplet::watchForFocus </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qwidget.html">QWidget</a> * </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>watch</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register widgets that can receive keyboard focus with this this method This call results in an eventFilter being places on the widget. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">widget</td><td>the widget to watch for keyboard focus </td></tr>
<tr><td class="paramname">watch</td><td>whether to start watching the widget, or to stop doing so </td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kpanelapplet_8cpp_source.html#l00140">140</a> of file <a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abd5aba1ab119f3b04798f5eb35c30f1a"></a><!-- doxytag: member="KPanelApplet::widthForHeight" ref="abd5aba1ab119f3b04798f5eb35c30f1a" args="(int height) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int KPanelApplet::widthForHeight </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>height</em></td><td>)</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a suggested width for a given height. </p>
<p>Every applet should reimplement this function.</p>
<p>Depending on the panel orientation the height (horizontal panel) or the width (vertical panel) of the applets is fixed. The exact values of the fixed size component depend on the panel size.</p>
<p>On a horizontal panel the applet height is fixed, the panel will call widthForHeight(int height) with <code>height</code> equal to 'the fixed applet height' when laying out the applets.</p>
<p>The applet can now choose the other size component (width) based on the given height.</p>
<p>The width you return is granted. </p>
<p>Definition at line <a class="el" href="kpanelapplet_8h_source.html#l00155">155</a> of file <a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kpanelapplet_8h_source.html">kpanelapplet.h</a></li>
<li><a class="el" href="kpanelapplet_8cpp_source.html">kpanelapplet.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kdeui</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKAboutApplication.html">kaboutapplication</option>, <option value="classKAboutContainer.html">kaboutcontainer</option>, <option value="classKAboutContainerBase.html">kaboutcontainerbase</option>, <option value="classKAboutContributor.html">kaboutcontributor</option>, <option value="classKAboutDialog.html">kaboutdialog</option>, <option value="classKAboutKDE.html">kaboutkde</option>, <option value="classKAboutWidget.html">kaboutwidget</option>, <option value="classKAccelGen_1_1Deref.html">kaccelgen::deref</option>, <option value="classKAccelGen_1_1Deref__Key.html">kaccelgen::deref__key</option>, <option value="classKAction.html">kaction</option>, <option value="classKActionCollection.html">kactioncollection</option>, <option value="classKActionMenu.html">kactionmenu</option>, <option value="classKActionSelector.html">kactionselector</option>, <option value="classKActiveLabel.html">kactivelabel</option>, <option value="classKAnimWidget.html">kanimwidget</option>, <option value="classKArrowButton.html">karrowbutton</option>, <option value="classKAuthIcon.html">kauthicon</option>, <option value="classKBugReport.html">kbugreport</option>, <option value="classKButtonBox.html">kbuttonbox</option>, <option value="classKCharSelect.html">kcharselect</option>, <option value="classKCharSelectTable.html">kcharselecttable</option>, <option value="classKCModule.html">kcmodule</option>, <option value="classKColor.html">kcolor</option>, <option value="classKColorButton.html">kcolorbutton</option>, <option value="classKColorCells.html">kcolorcells</option>, <option value="classKColorCombo.html">kcolorcombo</option>, <option value="classKColorDialog.html">kcolordialog</option>, <option value="classKColorDrag.html">kcolordrag</option>, <option value="classKColorPatch.html">kcolorpatch</option>, <option value="classKComboBox.html">kcombobox</option>, <option value="classKCommand.html">kcommand</option>, <option value="classKCommandHistory.html">kcommandhistory</option>, <option value="classKCompletionBox.html">kcompletionbox</option>, <option value="classKConfigDialog.html">kconfigdialog</option>, <option value="classKContextMenuManager.html">kcontextmenumanager</option>, <option value="classKCursor.html">kcursor</option>, <option value="classKCursorPrivate.html">kcursorprivate</option>, <option value="classKCursorPrivateAutoHideEventFilter.html">kcursorprivateautohideeventfilter</option>, <option value="classKDateInternalMonthPicker.html">kdateinternalmonthpicker</option>, <option value="classKDateInternalWeekSelector.html">kdateinternalweekselector</option>, <option value="classKDateInternalYearSelector.html">kdateinternalyearselector</option>, <option value="classKDatePicker.html">kdatepicker</option>, <option value="classKDateTable.html">kdatetable</option>, <option value="classKDateTimeWidget.html">kdatetimewidget</option>, <option value="classKDateValidator.html">kdatevalidator</option>, <option value="classKDateWidget.html">kdatewidget</option>, <option value="classKDCOPActionProxy.html">kdcopactionproxy</option>, <option value="classKDEPrivate_1_1ToolBarHandler.html">kdeprivate::toolbarhandler</option>, <option value="classKDialog.html">kdialog</option>, <option value="classKDialogBase.html">kdialogbase</option>, <option value="classKDialogBaseButton.html">kdialogbasebutton</option>, <option value="classKDialogBaseTile.html">kdialogbasetile</option>, <option value="classKDictSpellingHighlighter.html">kdictspellinghighlighter</option>, <option value="classKDockButton__Private.html">kdockbutton__private</option>, <option value="classKDockMainWindow.html">kdockmainwindow</option>, <option value="classKDockManager.html">kdockmanager</option>, <option value="classKDockSplitter.html">kdocksplitter</option>, <option value="classKDockTabGroup.html">kdocktabgroup</option>, <option value="classKDockWidget.html">kdockwidget</option>, <option value="classKDockWidgetAbstractHeader.html">kdockwidgetabstractheader</option>, <option value="classKDockWidgetAbstractHeaderDrag.html">kdockwidgetabstractheaderdrag</option>, <option value="classKDockWidgetHeader.html">kdockwidgetheader</option>, <option value="classKDockWidgetHeaderDrag.html">kdockwidgetheaderdrag</option>, <option value="classKDockWidgetPrivate.html">kdockwidgetprivate</option>, <option value="classKDockWindow.html">kdockwindow</option>, <option value="classKDoubleNumInput.html">kdoublenuminput</option>, <option value="classKDoubleSpinBox.html">kdoublespinbox</option>, <option value="classKDoubleValidator.html">kdoublevalidator</option>, <option value="classKDualColorButton.html">kdualcolorbutton</option>, <option value="classKEdit.html">kedit</option>, <option value="classKEditListBox.html">keditlistbox</option>, <option value="classKEditListBox_1_1CustomEditor.html">keditlistbox::customeditor</option>, <option value="classKEditToolbar.html">kedittoolbar</option>, <option value="classKEditToolbarWidget.html">kedittoolbarwidget</option>, <option value="classKFloatValidator.html">kfloatvalidator</option>, <option value="classKFontChooser.html">kfontchooser</option>, <option value="classKFontCombo.html">kfontcombo</option>, <option value="classKFontDialog.html">kfontdialog</option>, <option value="classKFontRequester.html">kfontrequester</option>, <option value="classKGradientSelector.html">kgradientselector</option>, <option value="classKGuiItem.html">kguiitem</option>, <option value="classKHelpMenu.html">khelpmenu</option>, <option value="classKHistoryCombo.html">khistorycombo</option>, <option value="classKHSSelector.html">khsselector</option>, <option value="classKIconView.html">kiconview</option>, <option value="classKIconViewItem.html">kiconviewitem</option>, <option value="classKIconViewSearchLine.html">kiconviewsearchline</option>, <option value="classKImageTrackLabel.html">kimagetracklabel</option>, <option value="classKInputDialog.html">kinputdialog</option>, <option value="classKIntNumInput.html">kintnuminput</option>, <option value="classKIntSpinBox.html">kintspinbox</option>, <option value="classKIntValidator.html">kintvalidator</option>, <option value="classKJanusWidget.html">kjanuswidget</option>, <option value="classKKeyButton.html">kkeybutton</option>, <option value="classKKeyChooser.html">kkeychooser</option>, <option value="classKKeyDialog.html">kkeydialog</option>, <option value="classKLanguageButton.html">klanguagebutton</option>, <option value="classKLed.html">kled</option>, <option value="classKLineEdit.html">klineedit</option>, <option value="classKLineEditDlg.html">klineeditdlg</option>, <option value="classKListAction.html">klistaction</option>, <option value="classKListBox.html">klistbox</option>, <option value="classKListView.html">klistview</option>, <option value="classKListViewItem.html">klistviewitem</option>, <option value="classKListViewLineEdit.html">klistviewlineedit</option>, <option value="classKListViewSearchLine.html">klistviewsearchline</option>, <option value="classKListViewSearchLineWidget.html">klistviewsearchlinewidget</option>, <option value="classKMacroCommand.html">kmacrocommand</option>, <option value="classKMainWindow.html">kmainwindow</option>, <option value="classKMainWindowInterface.html">kmainwindowinterface</option>, <option value="classKMenuBar.html">kmenubar</option>, <option value="classKMessageBox.html">kmessagebox</option>, <option value="classKMimeTypeValidator.html">kmimetypevalidator</option>, <option value="classKNamedCommand.html">knamedcommand</option>, <option value="classKNumInput.html">knuminput</option>, <option value="classKPaletteTable.html">kpalettetable</option>, <option value="classKPanelApplet.html">kpanelapplet</option>, <option value="classKPanelAppMenu.html">kpanelappmenu</option>, <option value="classKPanelExtension.html">kpanelextension</option>, <option value="classKPanelMenu.html">kpanelmenu</option>, <option value="classKPassivePopup.html">kpassivepopup</option>, <option value="classKPasswordDialog.html">kpassworddialog</option>, <option value="classKPasswordEdit.html">kpasswordedit</option>, <option value="classKPasteTextAction.html">kpastetextaction</option>, <option value="classKPixmapIO.html">kpixmapio</option>, <option value="classKPixmapRegionSelectorDialog.html">kpixmapregionselectordialog</option>, <option value="classKPixmapRegionSelectorWidget.html">kpixmapregionselectorwidget</option>, <option value="classKPopupFrame.html">kpopupframe</option>, <option value="classKPopupMenu.html">kpopupmenu</option>, <option value="classKPopupTitle.html">kpopuptitle</option>, <option value="classKProgress.html">kprogress</option>, <option value="classKProgressDialog.html">kprogressdialog</option>, <option value="classKPushButton.html">kpushbutton</option>, <option value="classKRadioAction.html">kradioaction</option>, <option value="classKRecentFilesAction.html">krecentfilesaction</option>, <option value="classKRestrictedLine.html">krestrictedline</option>, <option value="classKRootPermsIcon.html">krootpermsicon</option>, <option value="classKRootPixmap.html">krootpixmap</option>, <option value="classKRuler.html">kruler</option>, <option value="classKScrollView.html">kscrollview</option>, <option value="classKSelectAction.html">kselectaction</option>, <option value="classKSelector.html">kselector</option>, <option value="classKSeparator.html">kseparator</option>, <option value="classKShortcutDialog.html">kshortcutdialog</option>, <option value="classKSpell.html">kspell</option>, <option value="classKSpellConfig.html">kspellconfig</option>, <option value="classKSplashScreen.html">ksplashscreen</option>, <option value="classKSqueezedTextLabel.html">ksqueezedtextlabel</option>, <option value="classKStatusBar.html">kstatusbar</option>, <option value="classKStatusBarLabel.html">kstatusbarlabel</option>, <option value="classKStdGuiItem.html">kstdguiitem</option>, <option value="classKStringListValidator.html">kstringlistvalidator</option>, <option value="classKSwitchLanguageDialog.html">kswitchlanguagedialog</option>, <option value="classKSyntaxHighlighter.html">ksyntaxhighlighter</option>, <option value="classKSystemTray.html">ksystemtray</option>, <option value="classKTabBar.html">ktabbar</option>, <option value="classKTabCtl.html">ktabctl</option>, <option value="classKTabWidget.html">ktabwidget</option>, <option value="classKTextBrowser.html">ktextbrowser</option>, <option value="classKTextEdit.html">ktextedit</option>, <option value="classKTimeWidget.html">ktimewidget</option>, <option value="classKTimezoneWidget.html">ktimezonewidget</option>, <option value="classKTipDatabase.html">ktipdatabase</option>, <option value="classKTipDialog.html">ktipdialog</option>, <option value="classKToggleAction.html">ktoggleaction</option>, <option value="classKToggleFullScreenAction.html">ktogglefullscreenaction</option>, <option value="classKToggleToolBarAction.html">ktoggletoolbaraction</option>, <option value="classKToolBar.html">ktoolbar</option>, <option value="classKToolBarButton.html">ktoolbarbutton</option>, <option value="classKToolBarButtonList.html">ktoolbarbuttonlist</option>, <option value="classKToolBarLabelAction.html">ktoolbarlabelaction</option>, <option value="classKToolBarPopupAction.html">ktoolbarpopupaction</option>, <option value="classKToolBarRadioGroup.html">ktoolbarradiogroup</option>, <option value="classKURLLabel.html">kurllabel</option>, <option value="classKValueSelector.html">kvalueselector</option>, <option value="classKWidgetAction.html">kwidgetaction</option>, <option value="classKWindowInfo.html">kwindowinfo</option>, <option value="classKWizard.html">kwizard</option>, <option value="classKWordWrap.html">kwordwrap</option>, <option value="classKWritePermsIcon.html">kwritepermsicon</option>, <option value="classKXMLGUIBuilder.html">kxmlguibuilder</option>, <option value="classKXMLGUIClient.html">kxmlguiclient</option>, <option value="classKXMLGUIFactory.html">kxmlguifactory</option>, <option value="classKXYSelector.html">kxyselector</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
