<?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>Plasma.AbstractToolBox</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>AbstractToolBox Class Reference</h1> <code>from PyKDE4.plasma import *</code> <p> Inherits: QGraphicsWidget → QObject<br /> Namespace: <a href="../plasma/Plasma.html">Plasma</a><br /> <h2>Detailed Description</h2> <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="#ToolType">ToolType</a> </td><td class="memItemRight" valign="bottom">{ AddTool, ConfigureTool, ControlTool, MiscTool, DestructiveTool, UserToolType }</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="#toggled">toggled</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#visibilityChanged">visibilityChanged</a> (bool open)</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="#AbstractToolBox">__init__</a> (self, <a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> parent)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AbstractToolBox">__init__</a> (self, QObject parent=0, [QVariant] args=QVariantList())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addTool">addTool</a> (self, QAction action)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#containment">containment</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isShowing">isShowing</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeTool">removeTool</a> (self, QAction action)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reposition">reposition</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#restore">restore</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> group)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self, <a href="../kdecore/KConfigGroup.html">KConfigGroup</a> group)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setShowing">setShowing</a> (self, bool show)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#listToolBoxInfo">listToolBoxInfo</a> (QString parentApp=QString())</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.AbstractToolBox.html">Plasma.AbstractToolBox</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#load">load</a> (QString name, [QVariant] args=QVariantList(), <a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> containment=0)</td></tr> </table> <hr><h2>Signal Documentation</h2><a class="anchor" name="toggled"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> toggled</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">)</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Toolbox opened or closed </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("toggled()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="visibilityChanged"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> visibilityChanged</td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"><em>open</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Toolbox opened or closed </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>open</em> </td><td> tells if the toolbox opened or closed </td></tr> </table></dl> <p> </p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("visibilityChanged(bool)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="AbstractToolBox"></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"><a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> </td> <td class="paramname"><em>parent</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="AbstractToolBox"></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>parent=0</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">[QVariant] </td> <td class="paramname"><em>args=QVariantList()</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="addTool"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> addTool</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">QAction </td> <td class="paramname"><em>action</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>create a toolbox tool from the given action <b>action</b> the action to associate the tool with </p></div></div><a class="anchor" name="containment"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> containment</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="isShowing"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool isShowing</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the ToolBox is open and shown the actions list </dd></dl> </p></div></div><a class="anchor" name="removeTool"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> removeTool</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">QAction </td> <td class="paramname"><em>action</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>remove the tool associated with this action </p></div></div><a class="anchor" name="reposition"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> reposition</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>Inform the ToolBox it has to reposition itlself It has to be reimplemented in toolboxes that need it <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="restore"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> restore</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="../kdecore/KConfigGroup.html">KConfigGroup</a> </td> <td class="paramname"><em>group</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Restore the ToolBox settings It has to be reimplemented in toolboxes that need it <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="save"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> save</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="../kdecore/KConfigGroup.html">KConfigGroup</a> </td> <td class="paramname"><em>group</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Save the ToolBox settings It has to be reimplemented in toolboxes that need it <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="setShowing"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setShowing</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>show</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Opens or closes the ToolBox </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="listToolBoxInfo"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">[<a href="../kdecore/KPluginInfo.html">KPluginInfo</a>] listToolBoxInfo</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>parentApp=QString()</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns a list of all installed ToolBox plugins </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>parentApp</em> </td><td> the application to filter applets on. Uses the X-KDE-ParentApp entry (if any) in the plugin info. The default value of QString() will result in a list containing only applets not specifically registered to an application. </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><a class="anchor" name="load"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../plasma/Plasma.AbstractToolBox.html">Plasma.AbstractToolBox</a> load</td> <td>(</td> <td class="paramtype">QString </td> <td class="paramname"><em>name</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">[QVariant] </td> <td class="paramname"><em>args=QVariantList()</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../plasma/Plasma.Containment.html">Plasma.Containment</a> </td> <td class="paramname"><em>containment=0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Create a new AbstractToolBox, loading the proper plugin </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>name</em> </td><td> the plugin name <tr><td></td><td valign="top"><em>args</em> </td><td> the plugin arguments <tr><td></td><td valign="top"><em>containment</em> </td><td> the containment parent of the toolbox </td></tr> </table></dl> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6 </dd></dl> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ToolType"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">ToolType</td> </tr> </table> </div> <div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>AddTool</em> = 0</td><td><tr><td valign="top"><em>ConfigureTool</em> = 100</td><td><tr><td valign="top"><em>ControlTool</em> = 200</td><td><tr><td valign="top"><em>MiscTool</em> = 300</td><td><tr><td valign="top"><em>DestructiveTool</em> = 400</td><td><tr><td valign="top"><em>UserToolType</em> = DestructiveTool+1000</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>