← Back to branch summary

~ubuntu-branches/ubuntu/precise/python-qt4/precise-proposed

« back to all changes in this revision

Viewing changes to doc/html/qiconenginev2.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell, Jonathan Riddell
  • Date: 2010-11-08 16:13:33 UTC
  • mfrom: (1.5.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20101108161333-0nec4wu0nz3wpf9r
Tags: 4.8.1-0ubuntu1
[ Jonathan Riddell ]
* New upstream release
* Build against python-sip-dev 4.11.2
* Remove kubuntu_02_fix-scpk-and-flag-issue.diff merged upstream
* Install __init__.py into /usr/lib/python3.2/dist-packages/PyQt4,
  fixes Python 3 support
* Add QtDeclarative to python-qt4
* Add kubuntu_03_uiparser.diff from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/qiconenginev2.html
6
6
td.postheader { font-family: sans-serif }
7
7
tr.address { font-family: sans-serif }
8
8
body { background: #ffffff; color: black; }
9
 
</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">&#160;&#160;</td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <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>
10
 
<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 }</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&#160;<i>mode</i>&#160;=&#160;QIcon.Normal, QIcon.State&#160;<i>state</i>&#160;=&#160;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#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)</li><li><div class="fn" />bool <b><a href="qiconenginev2.html#write">write</a></b> (<i>self</i>, QDataStream)</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>
11
 
<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>
12
 
<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>
13
 
<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>
14
 
<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>
15
 
<p>See also <a href="qiconenginepluginv2.html">QIconEnginePluginV2</a>.</p>
16
 
<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>
17
 
<p><table border="1" cellpadding="2" cellspacing="1" class="valuelist" width="100%">
18
 
<tr><th width="25%">Constant</th><th width="15%">Value</th><th width="60%">Description</th></tr>
19
 
<tr><td valign="top"><tt>QIconEngineV2.AvailableSizesHook</tt></td><td align="center" valign="top"><tt>1</tt></td><td valign="top">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>
20
 
</table></p>
 
9
</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">&#160;&#160;</td><td class="postheader" valign="center"><a href="../pyqt4ref.html"><font color="#004faf">Home</font></a>&#160;&#183; <a href="classes.html"><font color="#004faf">All Classes</font></a>&#160;&#183; <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
 
10
<a href="qicon.html">QIcon</a> renderers. <a href="#details">More...</a></p>
 
11
 
 
12
<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&#160;<i>mode</i>&#160;=&#160;QIcon.Normal, QIcon.State&#160;<i>state</i>&#160;=&#160;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)</li><li><div class="fn" />bool <b><a href="qiconenginev2.html#write">write</a></b> (<i>self</i>, QDataStream)</li></ul><a name="details" /><hr /><h2>Detailed Description</h2><p>The QIconEngineV2 class provides an abstract base class for
 
13
<a href="qicon.html">QIcon</a> renderers.</p>
 
14
<p>An icon engine renders <a href="qicon.html">QIcon</a>s. With
 
15
icon engines, you can customize icons. Qt provides a default engine
 
16
that makes icons adhere to the current style by scaling the icons
 
17
and providing a disabled appearance.</p>
 
18
<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
 
19
used by Qt if a specific engine is not given when the icon is
 
20
created. See the QIconEngineV2 class description to learn how to
 
21
create icon engine plugins.</p>
 
22
<p>An icon engine provides the rendering functions for a <a href="qicon.html">QIcon</a>. Each icon has a corresponding icon engine
 
23
that is responsible for drawing the icon with a requested size,
 
24
mode and state.</p>
 
25
<p>QIconEngineV2 extends the API of <a href="qiconengine.html">QIconEngine</a> to allow streaming of the icon
 
26
engine contents, and should be used instead of <a href="qiconengine.html">QIconEngine</a> for implementing new icon
 
27
engines.</p>
 
28
<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
 
29
additional queries to icon engine without breaking binary
 
30
compatibility.</p>
 
31
<table class="valuelist">
 
32
<tr class="odd">
 
33
<td />
 
34
</tr>
 
35
<tr>
 
36
<th class="tblConst">Constant</th>
 
37
<th class="tblval">Value</th>
 
38
<th class="tbldscr">Description</th>
 
39
</tr>
 
40
<tr>
 
41
<td class="topAlign">
 
42
<tt>QIconEngineV2.AvailableSizesHook</tt></td>
 
43
<td class=" topAlign"><tt>1</tt></td>
 
44
<td class="topAlign">Allows to query the sizes of the contained
 
45
pixmaps for pixmap-based engines. The <i>data</i> argument of the
 
46
<a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
 
47
function is a <a href="qiconenginev2-availablesizesargument.html">AvailableSizesArgument</a>
 
48
pointer that should be filled with icon sizes. Engines that work in
 
49
terms of a scalable, vectorial format normally return an empty
 
50
list.</td>
 
51
</tr>
 
52
<tr>
 
53
<td class="topAlign"><tt>QIconEngineV2.IconNameHook</tt></td>
 
54
<td class=" topAlign"><tt>2</tt></td>
 
55
<td class="topAlign">Allows to query the name used to create the
 
56
icon, for example when instantiating an icon using <a href="qicon.html#fromTheme">QIcon.fromTheme</a>().</td>
 
57
</tr>
 
58
</table>
21
59
<p>This enum was introduced in Qt 4.5.</p>
22
60
<p>See also <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>().</p>
23
 
<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>&#160;<i>mode</i>&#160;=&#160;QIcon.Normal, <a href="qicon.html#State-enum">QIcon.State</a>&#160;<i>state</i>&#160;=&#160;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>
24
 
<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>
 
61
<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>&#160;<i>mode</i>&#160;=&#160;QIcon.Normal, <a href="qicon.html#State-enum">QIcon.State</a>&#160;<i>state</i>&#160;=&#160;QIcon.Off)</h3><p>Returns sizes of all images that are contained in the engine for
 
62
the specific <i>mode</i> and <i>state</i>.</p>
 
63
<p><b>Note:</b> This is a helper method and the actual work is done
 
64
by <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
 
65
method, hence this method depends on icon engine support and may
 
66
not work with all icon engines.</p>
25
67
<p>This function was introduced in Qt 4.5.</p>
26
 
<a name="//apple_ref/cpp/instm/QIconEngineV2/clone" />
 
68
 
 
69
 
27
70
<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>
28
 
<a name="//apple_ref/cpp/instm/QIconEngineV2/key" />
 
71
 
 
72
 
 
73
<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>
 
74
<p><b>Note:</b> This is a helper method and the actual work is done
 
75
by <a href="qiconenginev2.html#virtual_hook">virtual_hook</a>()
 
76
method, hence this method depends on icon engine support and may
 
77
not work with all icon engines.</p>
 
78
<p>This function was introduced in Qt 4.7.</p>
 
79
 
 
80
 
29
81
<h3 class="fn"><a name="key" />QString QIconEngineV2.key (<i>self</i>)</h3><p>Returns a key that identifies this icon engine.</p>
30
 
<a name="//apple_ref/cpp/instm/QIconEngineV2/read" />
31
 
<h3 class="fn"><a name="read" />bool QIconEngineV2.read (<i>self</i>, <a href="qdatastream.html">QDataStream</a>)</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>
32
 
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default implementation always return false.</p>
33
 
<a name="//apple_ref/cpp/instm/QIconEngineV2/virtual_hook" />
34
 
<h3 class="fn"><a name="write" />bool QIconEngineV2.write (<i>self</i>, <a href="qdatastream.html">QDataStream</a>)</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>
35
 
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default implementation always return false.</p>
36
 
<p /><address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.7.7 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt&#160;4.6.3</td></tr></table></div></address></body></html>
 
 
b'\\ No newline at end of file'
 
82
 
 
83
 
 
84
<h3 class="fn"><a name="read" />bool QIconEngineV2.read (<i>self</i>, <a href="qdatastream.html">QDataStream</a>)</h3><p>Reads icon engine contents from the <a href="qdatastream.html">QDataStream</a> <i>in</i>. Returns true if the
 
85
contents were read; otherwise returns false.</p>
 
86
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default
 
87
implementation always return false.</p>
 
88
 
 
89
 
 
90
<h3 class="fn"><a name="write" />bool QIconEngineV2.write (<i>self</i>, <a href="qdatastream.html">QDataStream</a>)</h3><p>Writes the contents of this engine to the <a href="qdatastream.html">QDataStream</a> <i>out</i>. Returns true if the
 
91
contents were written; otherwise returns false.</p>
 
92
<p><a href="qiconenginev2.html">QIconEngineV2</a>'s default
 
93
implementation always return false.</p>
 
94
<address><hr /><div align="center"><table border="0" cellspacing="0" width="100%"><tr class="address"><td align="left" width="25%">PyQt&#160;4.8.1 for X11</td><td align="center" width="50%">Copyright &#169; <a href="http://www.riverbankcomputing.com">Riverbank&#160;Computing&#160;Ltd</a> and <a href="http://www.qtsoftware.com">Nokia</a> 2010</td><td align="right" width="25%">Qt&#160;4.7.0</td></tr></table></div></address></body></html>
 
 
b'\\ No newline at end of file'