<?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>Solid.Battery</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>Battery Class Reference</h1> <code>from PyKDE4.solid import *</code> <p> Inherits: <a href="../solid/Solid.DeviceInterface.html">Solid.DeviceInterface</a> → QObject<br /> Namespace: <a href="../solid/Solid.html">Solid</a><br /> <h2>Detailed Description</h2> <p>This device interface is available on batteries. </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="#BatteryType">BatteryType</a> </td><td class="memItemRight" valign="bottom">{ UnknownBattery, PdaBattery, UpsBattery, PrimaryBattery, MouseBattery, KeyboardBattery, KeyboardMouseBattery, CameraBattery, PhoneBattery, MonitorBattery }</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ChargeState">ChargeState</a> </td><td class="memItemRight" valign="bottom">{ NoCharge, Charging, Discharging }</td></tr> <tr><td colspan="2"><br><h2>Signals</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#chargePercentChanged">chargePercentChanged</a> (int value, QString udi)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#chargeStateChanged">chargeStateChanged</a> (int newState, QString udi)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#plugStateChanged">plugStateChanged</a> (bool newState, QString udi)</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="#Battery">__init__</a> (self, QObject backendObject)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#chargePercent">chargePercent</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.Battery.html#ChargeState">Solid.Battery.ChargeState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#chargeState">chargeState</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isPlugged">isPlugged</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isRechargeable">isRechargeable</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.Battery.html#BatteryType">Solid.Battery.BatteryType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#type">type</a> (self)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deviceInterfaceType">deviceInterfaceType</a> ()</td></tr> </table> <hr><h2>Signal Documentation</h2><a class="anchor" name="chargePercentChanged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> chargePercentChanged</td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>udi</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This signal is emitted when the charge percent value of this battery has changed. </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>value</em> </td><td> the new charge percent value of the battery <tr><td></td><td valign="top"><em>udi</em> </td><td> the UDI of the battery with the new charge percent </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("chargePercentChanged(int, const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="chargeStateChanged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> chargeStateChanged</td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"><em>newState</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>udi</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This signal is emitted when the charge state of this battery has changed. </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>newState</em> </td><td> the new charge state of the battery, it's one of the type Solid.Battery.ChargeState </td></tr> </table></dl> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Battery.ChargeState </dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>udi</em> </td><td> the UDI of the battery with the new charge state </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("chargeStateChanged(int, const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="plugStateChanged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> plugStateChanged</td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>newState</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QString </td> <td class="paramname"><em>udi</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>This signal is emitted if the battery get plugged in/out of the battery bay. </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>newState</em> </td><td> the new plugging state of the battery, type is boolean <tr><td></td><td valign="top"><em>udi</em> </td><td> the UDI of the battery with the new plugging state </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("plugStateChanged(bool, const QString&)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="Battery"></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">QObject </td> <td class="paramname"><em>backendObject</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Creates a new Battery object. You generally won't need this. It's created when necessary using Device.as(). </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>backendObject</em> </td><td> the device interface object provided by the backend </td></tr> </table></dl> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Device.as() </dd></dl> </p></div></div><a class="anchor" name="chargePercent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">int chargePercent</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>Retrieves the current charge level of the battery normalised to percent. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the current charge level normalised to percent </dd></dl> </p></div></div><a class="anchor" name="chargeState"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../solid/Solid.Battery.html#ChargeState">Solid.Battery.ChargeState</a> chargeState</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>Retrieves the current charge state of the battery. It can be in a stable state (no charge), charging or discharging. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the current battery charge state </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Battery.ChargeState </dd></dl> </p></div></div><a class="anchor" name="isPlugged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isPlugged</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>Indicates if this battery is plugged. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the battery is plugged, false otherwise </dd></dl> </p></div></div><a class="anchor" name="isRechargeable"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isRechargeable</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>Indicates if the battery is rechargeable. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the battery is rechargeable, false otherwise (one time usage) </dd></dl> </p></div></div><a class="anchor" name="type"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../solid/Solid.Battery.html#BatteryType">Solid.Battery.BatteryType</a> type</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>Retrieves the type of device holding this battery. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the type of device holding this battery </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Battery.BatteryType </dd></dl> </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="deviceInterfaceType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> deviceInterfaceType</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Get the Solid.DeviceInterface.Type of the Battery device interface. </p> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the Battery device interface type </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.DeviceInterface.Type </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="BatteryType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">BatteryType</td> </tr> </table> </div> <div class="memdoc"><p>This enum type defines the type of the device holding the battery </p> <p> - PdaBattery : A battery in a Personal Digital Assistant - UpsBattery : A battery in an Uninterruptible Power Supply - PrimaryBattery : A primary battery for the system (for example laptop battery) - MouseBattery : A battery in a mouse - KeyboardBattery : A battery in a keyboard - KeyboardMouseBattery : A battery in a combined keyboard and mouse - CameraBattery : A battery in a camera - PhoneBattery : A battery in a phone - MonitorBattery : A battery in a monitor - UnknownBattery : A battery in an unknown device </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UnknownBattery</em> </td><td><tr><td valign="top"><em>PdaBattery</em> </td><td><tr><td valign="top"><em>UpsBattery</em> </td><td><tr><td valign="top"><em>PrimaryBattery</em> </td><td><tr><td valign="top"><em>MouseBattery</em> </td><td><tr><td valign="top"><em>KeyboardBattery</em> </td><td><tr><td valign="top"><em>KeyboardMouseBattery</em> </td><td><tr><td valign="top"><em>CameraBattery</em> </td><td><tr><td valign="top"><em>PhoneBattery</em> </td><td><tr><td valign="top"><em>MonitorBattery</em> </td><td></table> </dl> </div></div><p><a class="anchor" name="ChargeState"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">ChargeState</td> </tr> </table> </div> <div class="memdoc"><p>This enum type defines charge state of a battery </p> <p> - NoCharge : Battery charge is stable, not charging or discharging or the state is Unknown - Charging : Battery is charging - Discharging : Battery is discharging </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoCharge</em> </td><td><tr><td valign="top"><em>Charging</em> </td><td><tr><td valign="top"><em>Discharging</em> </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>