<?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" xml:lang="en">
<head>
<title>KLed</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KLed Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QWidget → QObject<br />
<h2>Detailed Description</h2>
<p>An LED widget.
</p>
<p>
Displays a round or rectangular light emitting diode.
</p>
<p>
It is configurable to arbitrary colors, the two on/off states and three
styles (or "looks");
</p>
<p>
It may display itself in a performant flat view, a round view with
light spot or a round view sunken in the screen.
</p>
<p>
<div align="center"><img src="../images/kled.png" /><p><strong> "KDE LED Widget" </strong></p></div>
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Joerg Habenicht, Richard J. Moore (rich@kde.org) 1998, 1999 </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Look">Look</a> </td><td class="memItemRight" valign="bottom">{ Flat, Raised, Sunken }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Shape">Shape</a> </td><td class="memItemRight" valign="bottom">{ Rectangular, Circular }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#State">State</a> </td><td class="memItemRight" valign="bottom">{ Off, On }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KLed">__init__</a> (self, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KLed">__init__</a> (self, QColor color, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KLed">__init__</a> (self, QColor color, <a href="../kdeui/KLed.html#State">KLed.State</a> state, <a href="../kdeui/KLed.html#Look">KLed.Look</a> look, <a href="../kdeui/KLed.html#Shape">KLed.Shape</a> shape, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QColor </td><td class="memItemRight" valign="bottom"><a class="el" href="#color">color</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#darkFactor">darkFactor</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ledWidth">ledWidth</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KLed.html#Look">KLed.Look</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#look">look</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSize </td><td class="memItemRight" valign="bottom"><a class="el" href="#minimumSizeHint">minimumSizeHint</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#off">off</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#on">on</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintCachedPixmap">paintCachedPixmap</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintEvent">paintEvent</a> (self, QPaintEvent a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintFlat">paintFlat</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintLed">paintLed</a> (self, <a href="../kdeui/KLed.html#Shape">KLed.Shape</a> shape, <a href="../kdeui/KLed.html#Look">KLed.Look</a> look)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintRaised">paintRaised</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintRect">paintRect</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintRectFrame">paintRectFrame</a> (self, bool raised)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paintSunken">paintSunken</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resizeEvent">resizeEvent</a> (self, QResizeEvent a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setColor">setColor</a> (self, QColor color)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDarkFactor">setDarkFactor</a> (self, int darkFactor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setLook">setLook</a> (self, <a href="../kdeui/KLed.html#Look">KLed.Look</a> look)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setShape">setShape</a> (self, <a href="../kdeui/KLed.html#Shape">KLed.Shape</a> shape)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setState">setState</a> (self, <a href="../kdeui/KLed.html#State">KLed.State</a> state)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KLed.html#Shape">KLed.Shape</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#shape">shape</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSize </td><td class="memItemRight" valign="bottom"><a class="el" href="#sizeHint">sizeHint</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KLed.html#State">KLed.State</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#state">state</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toggle">toggle</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#updateCachedPixmap">updateCachedPixmap</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KLed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs a green, round LED widget which will initially
be turned on.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KLed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructs a round LED widget with the supplied color which will
initially be turned on.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>color</em> </td><td> Initial color of the LED.
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget.
</td></tr> </table></dl>
<p> Constructor
</p></div></div><a class="anchor" name="KLed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#State">KLed.State</a> </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Look">KLed.Look</a> </td>
<td class="paramname"><em>look</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Shape">KLed.Shape</a> </td>
<td class="paramname"><em>shape</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor with the color, state and look.
</p>
<p>
Differs from above only in the parameters, which configure all settings.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>color</em> </td><td> Initial color of the LED.
<tr><td></td><td valign="top"><em>state</em> </td><td> Sets the State.
<tr><td></td><td valign="top"><em>look</em> </td><td> Sets the Look.
<tr><td></td><td valign="top"><em>shape</em> </td><td> Sets the Shape (rectangular or circular).
<tr><td></td><td valign="top"><em>parent</em> </td><td> The parent widget.
</td></tr> </table></dl>
<p> Constructor
</p></div></div><a class="anchor" name="color"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QColor color</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the current color of the widget.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Color
</dd></dl> Returns LED color.
</p></div></div><a class="anchor" name="darkFactor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int darkFactor</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the factor to darken the LED.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setDarkFactor()
</dd></dl> Returns dark factor.
</p></div></div><a class="anchor" name="ledWidth"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int ledWidth</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the width of the led.
</p></div></div><a class="anchor" name="look"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KLed.html#Look">KLed.Look</a> look</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the current look of the widget.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Look
</dd></dl> Returns LED look.
</p></div></div><a class="anchor" name="minimumSizeHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSize minimumSizeHint</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="off"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> off</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Sets the state of the widget to Off.
</p>
<p>
The widget will be painted immediately.
<dl class="see" compact><dt><b>See also:</b></dt><dd> on() toggle() setState()
</dd></dl>
</p></div></div><a class="anchor" name="on"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> on</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Sets the state of the widget to On.
</p>
<p>
The widget will be painted immediately.
<dl class="see" compact><dt><b>See also:</b></dt><dd> off() toggle() setState()
</dd></dl>
</p></div></div><a class="anchor" name="paintCachedPixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool paintCachedPixmap</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Paint the cached antialiased pixmap corresponding to the state if any
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the pixmap was painted, false if it hasn't been created yet
</dd></dl>
</p></div></div><a class="anchor" name="paintEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintEvent</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QPaintEvent </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="paintFlat"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintFlat</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Paints a circular, flat LED.
</p></div></div><a class="anchor" name="paintLed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintLed</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Shape">KLed.Shape</a> </td>
<td class="paramname"><em>shape</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Look">KLed.Look</a> </td>
<td class="paramname"><em>look</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="paintRaised"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintRaised</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Paints a circular, raised LED.
</p></div></div><a class="anchor" name="paintRect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintRect</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Paints a rectangular, flat LED.
</p></div></div><a class="anchor" name="paintRectFrame"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintRectFrame</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>raised</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Paints a rectangular LED, either raised or
sunken, depending on its argument.
</p></div></div><a class="anchor" name="paintSunken"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paintSunken</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Paints a circular, sunken LED.
</p></div></div><a class="anchor" name="resizeEvent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resizeEvent</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QResizeEvent </td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setColor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setColor</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QColor </td>
<td class="paramname"><em>color</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the color of the widget.
</p>
<p>
The LED is shown with Color when in the KLed.On state
or with the darken Color (@see setDarkFactor) in KLed.Off
state.
</p>
<p>
The widget calls the update() method, so it will
be updated when entering the main event loop.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Color
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>color</em> </td><td> New color of the LED.
</td></tr> </table></dl>
<p> Sets the LED color.
</p></div></div><a class="anchor" name="setDarkFactor"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDarkFactor</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>darkFactor</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the factor to darken the LED in KLed.Off state.
</p>
<p>
The </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>darkFactor</em> </td><td> should be greater than 100, otherwise the LED
becomes lighter in KLed.Off state.
</td></tr>
</table></dl>
<p> Defaults to 300.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QColor
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>darkFactor</em> </td><td> Sets the factor to darken the LED.
</td></tr> </table></dl>
<p> Sets the factor to darken the LED.
</p></div></div><a class="anchor" name="setLook"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setLook</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Look">KLed.Look</a> </td>
<td class="paramname"><em>look</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the look of the widget.
</p>
<p>
The look may be Flat, Raised or Sunken.
</p>
<p>
The widget calls the update() method, so it will
be updated when entering the main event loop.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Look
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>look</em> </td><td> New look of the LED.
</td></tr> </table></dl>
<p> Sets LED look.
</p></div></div><a class="anchor" name="setShape"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setShape</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#Shape">KLed.Shape</a> </td>
<td class="paramname"><em>shape</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the shape of the LED.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>shape</em> </td><td> The LED shape.
</td></tr> </table></dl>
<p> Set LED shape.
</p></div></div><a class="anchor" name="setState"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setState</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KLed.html#State">KLed.State</a> </td>
<td class="paramname"><em>state</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the state of the widget to On or Off.
</p>
<p>
The widget will be painted immediately.
<dl class="see" compact><dt><b>See also:</b></dt><dd> on() off() toggle()
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>state</em> </td><td> The LED state: on or off.
</td></tr> </table></dl>
<p> Set LED state.
</p></div></div><a class="anchor" name="shape"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KLed.html#Shape">KLed.Shape</a> shape</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the current shape of the widget.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> Shape
</dd></dl> Returns LED shape.
</p></div></div><a class="anchor" name="sizeHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSize sizeHint</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="state"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KLed.html#State">KLed.State</a> state</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the current state of the widget (on/off).
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> State
</dd></dl> Returns LED state.
</p></div></div><a class="anchor" name="toggle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> toggle</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Toggles the state of the led from Off to On or vice versa.
</p>
<p>
The widget repaints itself immediately.
</p></div></div><a class="anchor" name="updateCachedPixmap"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> updateCachedPixmap</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
invalidates caches after property changes and calls update()
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Look"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Look</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Displays a flat, round or sunken LED.
</p>
<p>
Displaying the LED flat is less time and color consuming,
but not so nice to see.
</p>
<p>
The sunken LED itself is (certainly) smaller than the round LED
because of the 3 shading circles and is
most time consuming. Makes sense for LED > 15x15 pixels.
</p>
<p>
<b>Timings:</b>
( AMD K5/133, Diamond Stealth 64 PCI Graphics, widgetsize 29x29 )
<li> flat Approximately 0.7 msec per paint </li>
<li> round Approximately 2.9 msec per paint </li>
<li> sunken Approximately 3.3 msec per paint </li>
</p>
<p>
The widget will be updated on the next repaining event.
</p>
<p>
LED look.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Flat</em> </td><td><tr><td valign="top"><em>Raised</em> </td><td><tr><td valign="top"><em>Sunken</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="Shape"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Shape</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Shades of the lamp.
LED shape
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Rectangular</em> </td><td><tr><td valign="top"><em>Circular</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="State"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">State</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Status of the light is on/off.
LED on/off.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Modal</em> = 1<<0</td><td><tr><td valign="top"><em>Sticky</em> = 1<<1</td><td><tr><td valign="top"><em>MaxVert</em> = 1<<2</td><td><tr><td valign="top"><em>MaxHoriz</em> = 1<<3</td><td><tr><td valign="top"><em>Max</em> = MaxVert|MaxHoriz</td><td><tr><td valign="top"><em>Shaded</em> = 1<<4</td><td><tr><td valign="top"><em>SkipTaskbar</em> = 1<<5</td><td><tr><td valign="top"><em>KeepAbove</em> = 1<<6</td><td><tr><td valign="top"><em>StaysOnTop</em> = KeepAbove</td><td><tr><td valign="top"><em>SkipPager</em> = 1<<7</td><td><tr><td valign="top"><em>Hidden</em> = 1<<8</td><td><tr><td valign="top"><em>FullScreen</em> = 1<<9</td><td><tr><td valign="top"><em>KeepBelow</em> = 1<<10</td><td><tr><td valign="top"><em>DemandsAttention</em> = 1<<11</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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>
</body>
</html>
