<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qiconengine.cpp -->
<title>Qt 4.8: QIconEngineV2 Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QIconEngineV2</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QIconEngineV2 Class Reference</h1>
<!-- $$$QIconEngineV2-brief -->
<p>The QIconEngineV2 class provides an abstract base class for <a href="qicon.html">QIcon</a> renderers. <a href="#details">More...</a></p>
<!-- @@@QIconEngineV2 -->
<pre class="cpp"> <span class="preprocessor">#include <QIconEngineV2></span></pre><p><b>Inherits: </b><a href="qiconengine.html">QIconEngine</a>.</p>
<p>This class was introduced in Qt 4.3.</p>
<ul>
<li><a href="qiconenginev2-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> class </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2-availablesizesargument.html">AvailableSizesArgument</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#IconEngineHook-enum">IconEngineHook</a></b> { AvailableSizesHook, IconNameHook }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QList<QSize> </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#availableSizes">availableSizes</a></b> ( QIcon::Mode <i>mode</i> = QIcon::Normal, QIcon::State <i>state</i> = QIcon::Off )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QIconEngineV2 * </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#clone">clone</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#iconName">iconName</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#key">key</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#read">read</a></b> ( QDataStream & <i>in</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#virtual_hook">virtual_hook</a></b> ( int <i>id</i>, void * <i>data</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qiconenginev2.html#write">write</a></b> ( QDataStream & <i>out</i> ) const</td></tr>
</table>
<ul>
<li class="fn">5 public functions inherited from <a href="qiconengine.html#public-functions">QIconEngine</a></li>
</ul>
<a name="details"></a>
<!-- $$$QIconEngineV2-description -->
<div class="descr">
<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>
</div>
<p><b>See also </b><a href="qiconenginepluginv2.html">QIconEnginePluginV2</a>.</p>
<!-- @@@QIconEngineV2 -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$IconEngineHook$$$AvailableSizesHook$$$IconNameHook -->
<h3 class="fn"><a name="IconEngineHook-enum"></a>enum QIconEngineV2::<span class="name">IconEngineHook</span></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 valign="top" class="odd"><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>
<!-- @@@IconEngineHook -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$availableSizes[overload1]$$$availableSizesQIcon::ModeQIcon::State -->
<h3 class="fn"><a name="availableSizes"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qsize.html">QSize</a></span>> QIconEngineV2::<span class="name">availableSizes</span> ( <span class="type"><a href="qicon.html#Mode-enum">QIcon::Mode</a></span> <i>mode</i> = QIcon::Normal, <span class="type"><a href="qicon.html#State-enum">QIcon::State</a></span> <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>
<!-- @@@availableSizes -->
<!-- $$$clone[overload1]$$$clone -->
<h3 class="fn"><a name="clone"></a><span class="type">QIconEngineV2</span> * QIconEngineV2::<span class="name">clone</span> () const<tt> [virtual]</tt></h3>
<p>Returns a clone of this icon engine.</p>
<!-- @@@clone -->
<!-- $$$iconName[overload1]$$$iconName -->
<h3 class="fn"><a name="iconName"></a><span class="type"><a href="qstring.html">QString</a></span> QIconEngineV2::<span class="name">iconName</span> ()</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>
<!-- @@@iconName -->
<!-- $$$key[overload1]$$$key -->
<h3 class="fn"><a name="key"></a><span class="type"><a href="qstring.html">QString</a></span> QIconEngineV2::<span class="name">key</span> () const<tt> [virtual]</tt></h3>
<p>Returns a key that identifies this icon engine.</p>
<!-- @@@key -->
<!-- $$$read[overload1]$$$readQDataStream& -->
<h3 class="fn"><a name="read"></a><span class="type">bool</span> QIconEngineV2::<span class="name">read</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>in</i> )<tt> [virtual]</tt></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>
<!-- @@@read -->
<!-- $$$virtual_hook[overload1]$$$virtual_hookintvoid* -->
<h3 class="fn"><a name="virtual_hook"></a><span class="type">void</span> QIconEngineV2::<span class="name">virtual_hook</span> ( <span class="type">int</span> <i>id</i>, <span class="type">void</span> * <i>data</i> )<tt> [virtual]</tt></h3>
<p>Additional method to allow extending <a href="qiconenginev2.html">QIconEngineV2</a> without adding new virtual methods (and without breaking binary compatibility). The actual action and format of <i>data</i> depends on <i>id</i> argument which is in fact a constant from <a href="qiconenginev2.html#IconEngineHook-enum">IconEngineHook</a> enum.</p>
<p>This function was introduced in Qt 4.5.</p>
<p><b>See also </b><a href="qiconenginev2.html#IconEngineHook-enum">IconEngineHook</a>.</p>
<!-- @@@virtual_hook -->
<!-- $$$write[overload1]$$$writeQDataStream& -->
<h3 class="fn"><a name="write"></a><span class="type">bool</span> QIconEngineV2::<span class="name">write</span> ( <span class="type"><a href="qdatastream.html">QDataStream</a></span> & <i>out</i> ) const<tt> [virtual]</tt></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>
<!-- @@@write -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
