<?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>KIconEffect</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>KIconEffect Class Reference</h1> <code>from PyKDE4.kdeui import *</code> <p> <h2>Detailed Description</h2> <p>Applies effects to icons. </p> <p> This class applies effects to icons depending on their state and group. For example, it can be used to make all disabled icons in a toolbar gray. </p> <p> <div align="center"><img src="../images/kiconeffect-apply.png" /><p><strong> "Various Effects applied to an image" </strong></p></div> </p> <p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KIcon </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="#Effects">Effects</a> </td><td class="memItemRight" valign="bottom">{ NoEffect, ToGray, Colorize, ToGamma, DeSaturate, ToMonochrome, LastEffect }</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="#KIconEffect">__init__</a> (self, <a href="../kdeui/KIconEffect.html">KIconEffect</a> other)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KIconEffect">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QImage </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QImage src, int group, int state)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QImage </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QImage src, int effect, float value, QColor rgb, bool trans)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QImage </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QImage src, int effect, float value, QColor rgb, QColor rgb2, bool trans)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QPixmap src, int group, int state)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QPixmap src, int effect, float value, QColor rgb, bool trans)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#apply">apply</a> (self, QPixmap src, int effect, float value, QColor rgb, QColor rgb2, bool trans)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QImage </td><td class="memItemRight" valign="bottom"><a class="el" href="#doublePixels">doublePixels</a> (self, QImage src)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#fingerprint">fingerprint</a> (self, int group, int state)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasEffect">hasEffect</a> (self, int group, int state)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#init">init</a> (self)</td></tr> <tr><td colspan="2"><br><h2>Static Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#colorize">colorize</a> (QImage image, QColor col, float value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deSaturate">deSaturate</a> (QImage image, float value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#overlay">overlay</a> (QImage src, QImage overlay)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#semiTransparent">semiTransparent</a> (QImage image)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#semiTransparent">semiTransparent</a> (QPixmap pixmap)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toGamma">toGamma</a> (QImage image, float value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toGray">toGray</a> (QImage image, float value)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#toMonochrome">toMonochrome</a> (QImage image, QColor black, QColor white, float value)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="KIconEffect"></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="../kdeui/KIconEffect.html">KIconEffect</a> </td> <td class="paramname"><em>other</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="KIconEffect"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</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>Create a new KIconEffect. You will most likely never have to use this to create a new KIconEffect yourself, as you can use the KIconEffect provided by the global KIconLoader (which itself is accessible by KIconLoader.global()) through its iconEffect() function. </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QImage apply</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">QImage </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>group</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </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>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QImage apply</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">QImage </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>effect</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>trans</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QImage apply</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">QImage </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>effect</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb2</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>trans</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QPixmap apply</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">QPixmap </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>group</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </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>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QPixmap apply</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">QPixmap </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>effect</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>trans</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="apply"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QPixmap apply</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">QPixmap </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>effect</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>rgb2</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>trans</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Applies an effect to a pixmap. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> The pixmap. <tr><td></td><td valign="top"><em>effect</em> </td><td> The effect to apply, one of KIconEffect.Effects. <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1. <tr><td></td><td valign="top"><em>rgb</em> </td><td> Color parameter for effects that need one. <tr><td></td><td valign="top"><em>trans</em> </td><td> Add Transparency if trans = true. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A pixmap with the effect applied. </dd></dl> </p></div></div><a class="anchor" name="doublePixels"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QImage doublePixels</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">QImage </td> <td class="paramname"><em>src</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Returns an image twice as large, consisting of 2x2 pixels. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>src</em> </td><td> the image. </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the scaled image. </dd></dl> </p></div></div><a class="anchor" name="fingerprint"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">QString fingerprint</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>group</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </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>Returns a fingerprint for the effect by encoding the given <b>group</b> and <b>state</b> into a QString. This is useful for caching. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>group</em> </td><td> the group, see KIconLoader.Group <tr><td></td><td valign="top"><em>state</em> </td><td> the state, see KIconLoader.States </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the fingerprint of the given <b>group+@p</b> state </dd></dl> </p></div></div><a class="anchor" name="hasEffect"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">bool hasEffect</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>group</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">int </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>Tests whether an effect has been configured for the given icon group. </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>group</em> </td><td> the group to check, see KIconLoader.Group <tr><td></td><td valign="top"><em>state</em> </td><td> the state to check, see KIconLoader.States </td></tr> </table></dl> <p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if an effect is configured for the given <b>group</b> in <b>state,</b> otherwise false. </dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KIconLoader.Group KIconLoader.States </dd></dl> </p></div></div><a class="anchor" name="init"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> init</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>Rereads configuration. </p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="colorize"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> colorize</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>col</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Colorizes an image with a specific color. </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>image</em> </td><td> The image <tr><td></td><td valign="top"><em>col</em> </td><td> The color with which the <b>image</b> is tinted <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1 </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="deSaturate"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> deSaturate</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Desaturates an image. </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>image</em> </td><td> The image <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1 </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="overlay"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> overlay</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>src</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QImage </td> <td class="paramname"><em>overlay</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Overlays an image with an other image. </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>src</em> </td><td> The image <tr><td></td><td valign="top"><em>overlay</em> </td><td> The image to overlay <b>src</b> with </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="semiTransparent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> semiTransparent</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Renders a pixmap semi-transparent. </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>pixmap</em> </td><td> The pixmap </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="semiTransparent"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> semiTransparent</td> <td>(</td> <td class="paramtype">QPixmap </td> <td class="paramname"><em>pixmap</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Renders a pixmap semi-transparent. </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>pixmap</em> </td><td> The pixmap </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="toGamma"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> toGamma</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Changes the gamma value of an image. </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>image</em> </td><td> The image <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1 </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="toGray"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> toGray</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Tints an image gray. </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>image</em> </td><td> The image <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1 </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="toMonochrome"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> toMonochrome</td> <td>(</td> <td class="paramtype">QImage </td> <td class="paramname"><em>image</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>black</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">QColor </td> <td class="paramname"><em>white</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"><em>value</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Produces a monochrome icon with a given foreground and background color </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>image</em> </td><td> The image <tr><td></td><td valign="top"><em>white</em> </td><td> The color with which the white parts of <b>image</b> are painted <tr><td></td><td valign="top"><em>black</em> </td><td> The color with which the black parts of <b>image</b> are painted <tr><td></td><td valign="top"><em>value</em> </td><td> Strength of the effect. 0 <= <b>value</b> <= 1 </td></tr> </table></dl> <p> </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Effects"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Effects</td> </tr> </table> </div> <div class="memdoc"><p>This is the enumeration of all possible icon effects. Note that 'LastEffect' is no valid icon effect but only used internally to check for invalid icon effects. </p> <p> <li> NoEffect: Don't apply any icon effect </li> <li> ToGray: Tints the icon gray </li> <li> Colorize: Tints the icon with an other color </li> <li> ToGamma: Change the gamma value of the icon </li> <li> DeSaturate: Reduce the saturation of the icon </li> <li> ToMonochrome: Produces a monochrome icon </li> </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoEffect</em> </td><td><tr><td valign="top"><em>ToGray</em> </td><td><tr><td valign="top"><em>Colorize</em> </td><td><tr><td valign="top"><em>ToGamma</em> </td><td><tr><td valign="top"><em>DeSaturate</em> </td><td><tr><td valign="top"><em>ToMonochrome</em> </td><td><tr><td valign="top"><em>LastEffect</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>