<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html><head><title>QIconEngineV2 Class Reference</title><style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
td.postheader { font-family: sans-serif }
tr.address { font-family: sans-serif }
body { background: #ffffff; color: black; }
</style></head><body><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr /><td align="left" valign="top" width="32"><img align="left" border="0" height="32" src="images/rb-logo.png" width="32" /></td><td width="1">  </td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a> · <a href="classes.html"><font color="#004faf">All Classes</font></a> · <a href="modules.html"><font color="#004faf">Modules</font></a></td></table><h1 align="center">QIconEngineV2 Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1><p>The QIconEngineV2 class provides an abstract base class for
<a href="qicon.html">QIcon</a> renderers. <a href="#details">More...</a></p>
<p>Inherits <a href="qiconengine.html">QIconEngine</a>.</p><h3>Types</h3><ul><li><div class="fn" />class <b><a href="qiconenginev2-availablesizesargument.html">AvailableSizesArgument</a></b></li><li><div class="fn" />enum <b><a href="qiconenginev2.html#IconEngineHook-enum">IconEngineHook</a></b> { AvailableSizesHook, IconNameHook }</li></ul><h3>Methods</h3><ul><li><div class="fn" /><b><a href="qiconenginev2.html#QIconEngineV2">__init__</a></b> (<i>self</i>)</li><li><div class="fn" /><b><a href="qiconenginev2.html#QIconEngineV2-2">__init__</a></b> (<i>self</i>, QIconEngineV2)</li><li><div class="fn" />list-of-QSize <b><a href="qiconenginev2.html#availableSizes">availableSizes</a></b> (<i>self</i>, QIcon.Mode <i>mode</i> = QIcon.Normal, QIcon.State <i>state</i> = QIcon.Off)</li><li><div class="fn" />QIconEngineV2 <b><a href="qiconenginev2.html#clone">clone</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qiconenginev2.html#iconName">iconName</a></b> (<i>self</i>)</li><li><div class="fn" />QString <b><a href="qiconenginev2.html#key">key</a></b> (<i>self</i>)</li><li><div class="fn" />bool <b><a href="qiconenginev2.html#read">read</a></b> (<i>self</i>, QDataStream <i>in</i>)</li><li><div class="fn" />bool <b><a href="qiconenginev2.html#write">write</a></b> (<i>self</i>, QDataStream <i>out</i>)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QIconEngineV2 class provides an abstract base class for
<a href="qicon.html">QIcon</a> renderers.</p>
<p>An icon engine renders <a href="qicon.html">QIcon</a>s. With
icon engines, you can customize icons. Qt provides a default engine
that makes icons adhere to the current style by scaling the icons
and providing a disabled appearance.</p>
<p>An engine is installed on an icon either through a <a href="qicon.html">QIcon</a> constructor or through a <a href="qiconenginepluginv2.html">QIconEnginePluginV2</a>. The plugins are
used by Qt if a specific engine is not given when the icon is
created. See the QIconEngineV2 class description to learn how to
create icon engine plugins.</p>
<p>An icon engine provides the rendering functions for a <a href="qicon.html">QIcon</a>. Each icon has a corresponding icon engine
that is responsible for drawing the icon with a requested size,
mode and state.</p>
<p>QIconEngineV2 extends the API of <a href="qiconengine.html">QIconEngine</a> to allow streaming of the icon
engine contents, and should be used instead of <a href="qiconengine.html">QIconEngine</a> for implementing new icon
engines.</p>
<hr /><h2>Type Documentation</h2><h3 class="fn"><a name="IconEngineHook-enum" />QIconEngineV2.IconEngineHook</h3><p>These enum values are used for <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>() to allow
additional queries to icon engine without breaking binary
compatibility.</p>
<table class="valuelist">
<tr class="odd" valign="top">
<th class="tblConst">Constant</th>
<th class="tblval">Value</th>
<th class="tbldscr">Description</th>
</tr>
<tr>
<td class="topAlign">
<tt>QIconEngineV2.AvailableSizesHook</tt></td>
<td class="topAlign"><tt>1</tt></td>
<td class="topAlign">Allows to query the sizes of the contained
pixmaps for pixmap-based engines. The <i>data</i> argument of the
<a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
function is a <a href="qiconenginev2-availablesizesargument.html">AvailableSizesArgument</a>
pointer that should be filled with icon sizes. Engines that work in
terms of a scalable, vectorial format normally return an empty
list.</td>
</tr>
<tr>
<td class="topAlign"><tt>QIconEngineV2.IconNameHook</tt></td>
<td class="topAlign"><tt>2</tt></td>
<td class="topAlign">Allows to query the name used to create the
icon, for example when instantiating an icon using <a href="qicon.html#fromTheme">QIcon.fromTheme</a>().</td>
</tr>
</table>
<p>This enum was introduced or modified in Qt 4.5.</p>
<p><b>See also</b> <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>().</p>
<hr /><h2>Method Documentation</h2><h3 class="fn"><a name="QIconEngineV2" />QIconEngineV2.__init__ (<i>self</i>)</h3><h3 class="fn"><a name="QIconEngineV2-2" />QIconEngineV2.__init__ (<i>self</i>, <a href="qiconenginev2.html">QIconEngineV2</a>)</h3><h3 class="fn"><a name="availableSizes" />list-of-QSize QIconEngineV2.availableSizes (<i>self</i>, <a href="qicon.html#Mode-enum">QIcon.Mode</a> <i>mode</i> = QIcon.Normal, <a href="qicon.html#State-enum">QIcon.State</a> <i>state</i> = QIcon.Off)</h3><p>Returns sizes of all images that are contained in the engine for
the specific <i>mode</i> and <i>state</i>.</p>
<p><b>Note:</b> This is a helper method and the actual work is done
by <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
method, hence this method depends on icon engine support and may
not work with all icon engines.</p>
<p>This function was introduced in Qt 4.5.</p>
<h3 class="fn"><a name="clone" /><a href="qiconenginev2.html">QIconEngineV2</a> QIconEngineV2.clone (<i>self</i>)</h3><p>Returns a clone of this icon engine.</p>
<h3 class="fn"><a name="iconName" />QString QIconEngineV2.iconName (<i>self</i>)</h3><p>Returns the name used to create the engine, if available.</p>
<p><b>Note:</b> This is a helper method and the actual work is done
by <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
method, hence this method depends on icon engine support and may
not work with all icon engines.</p>
<p>This function was introduced in Qt 4.7.</p>
<h3 class="fn"><a name="key" />QString QIconEngineV2.key (<i>self</i>)</h3><p>Returns a key that identifies this icon engine.</p>
<h3 class="fn"><a name="read" />bool QIconEngineV2.read (<i>self</i>, <a href="qdatastream.html">QDataStream</a> <i>in</i>)</h3><p>Reads icon engine contents from the <a href="qdatastream.html">QDataStream</a> <i>in</i>. Returns true if the
contents were read; otherwise returns false.</p>
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default
implementation always return false.</p>
<h3 class="fn"><a name="write" />bool QIconEngineV2.write (<i>self</i>, <a href="qdatastream.html">QDataStream</a> <i>out</i>)</h3><p>Writes the contents of this engine to the <a href="qdatastream.html">QDataStream</a> <i>out</i>. Returns true if the
contents were written; otherwise returns false.</p>
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default
implementation always return false.</p>
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt 4.10.3 for X11</td><td align="center" width="50%">Copyright © <a href="http://www.riverbankcomputing.com">Riverbank Computing Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2012</td><td align="right" width="25%">Qt 4.8.5</td></tr></table></div></address></body></html>
