<?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.Delegate</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>Delegate Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Inherits: QAbstractItemDelegate → QObject<br />
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>Delegate plasma/delegate.h <Plasma/Delegate>
</p>
<p>
Item delegate for rendering items in Plasma menus implemented with item views.
</p>
<p>
The delegate makes use of its own data roles that are:
SubTitleRole: the text of the subtitle
SubTitleMandatoryRole: if the subtitle is to always be displayed
(as default the subtitle is displayed only on mouse over)
NOTE: if model doesn't return a valid data for SubTitleMandatoryRole (i.e. if it returns QVaraint())
then subtitles will be shown for adjasent items with the same content and not shown
otherwise.
</p>
<p>
ColumnTypeRole: if the column is a main column (with title and subtitle)
or a secondary action column (only a little icon that appears on mouse
over is displayed)
</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="#ColumnType">ColumnType</a> </td><td class="memItemRight" valign="bottom">{ MainColumn, SecondaryActionColumn }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#SpecificRoles">SpecificRoles</a> </td><td class="memItemRight" valign="bottom">{ SubTitleRole, SubTitleMandatoryRole, ColumnTypeRole }</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="#Delegate">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRect </td><td class="memItemRight" valign="bottom"><a class="el" href="#emptyRect">emptyRect</a> (self, QStyleOptionViewItem option, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#paint">paint</a> (self, QPainter painter, QStyleOptionViewItem option, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRect </td><td class="memItemRight" valign="bottom"><a class="el" href="#rectAfterSubTitle">rectAfterSubTitle</a> (self, QStyleOptionViewItem option, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QRect </td><td class="memItemRight" valign="bottom"><a class="el" href="#rectAfterTitle">rectAfterTitle</a> (self, QStyleOptionViewItem option, QModelIndex index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#roleMapping">roleMapping</a> (self, <a href="../plasma/Plasma.Delegate.html#SpecificRoles">Plasma.Delegate.SpecificRoles</a> role)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRoleMapping">setRoleMapping</a> (self, <a href="../plasma/Plasma.Delegate.html#SpecificRoles">Plasma.Delegate.SpecificRoles</a> role, int actual)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#showToolTip">showToolTip</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, QStyleOptionViewItem option, QModelIndex index)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="Delegate"></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></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="emptyRect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QRect emptyRect</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">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the empty area after both the title and the subtitle.
The height is the height of the item.
It can be used by subclasses that wants to paint additional data
</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>option</em> </td><td> options for the title and subtitle text
<tr><td></td><td valign="top"><em>index</em> </td><td> model index that we want to compute the free area
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="paint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> paint</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">QPainter </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>index</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="rectAfterSubTitle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QRect rectAfterSubTitle</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">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the empty area after the subtitle.
The height is the height of the subtitle.
It can be used by subclasses, that wants to paint additional data.
</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>option</em> </td><td> options for the subtitle text
<tr><td></td><td valign="top"><em>index</em> </td><td> model index that we want to compute the free area
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="rectAfterTitle"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QRect rectAfterTitle</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">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the empty area after the title.
The height is the height of the subtitle.
It can be used by subclasses that wants to paint additional data after
calling the paint function of the superclass.
</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>option</em> </td><td> options for the title text
<tr><td></td><td valign="top"><em>index</em> </td><td> model index that we want to compute the free area
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="roleMapping"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int roleMapping</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.Delegate.html#SpecificRoles">Plasma.Delegate.SpecificRoles</a> </td>
<td class="paramname"><em>role</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="setRoleMapping"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRoleMapping</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.Delegate.html#SpecificRoles">Plasma.Delegate.SpecificRoles</a> </td>
<td class="paramname"><em>role</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>actual</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Maps an arbitrary role to a role belonging to SpecificRoles.
Using this function you can use any model with this delegate.
</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>role</em> </td><td> a role belonging to SpecificRoles
<tr><td></td><td valign="top"><em>actual</em> </td><td> an arbitrary role of the model we are using
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="showToolTip"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool showToolTip</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="return" compact><dt><b>Returns:</b></dt><dd> true if a tooltip should be shown
</dd></dl>
</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"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStyleOptionViewItem </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QModelIndex </td>
<td class="paramname"><em>index</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ColumnType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ColumnType</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>MainColumn</em> = 1</td><td><tr><td valign="top"><em>SecondaryActionColumn</em> = 2</td><td></table>
</dl>
</div></div><p><a class="anchor" name="SpecificRoles"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">SpecificRoles</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>SubTitleRole</em> = Qt::UserRole+1</td><td><tr><td valign="top"><em>SubTitleMandatoryRole</em> = Qt::UserRole+2</td><td><tr><td valign="top"><em>ColumnTypeRole</em> = Qt::UserRole+3</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>
