~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/qiconengineplugin.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam Conrad
  • Date: 2005-08-24 04:09:09 UTC
  • Revision ID: james.westby@ubuntu.com-20050824040909-xmxe9jfr4a0w5671
Tags: upstream-4.0.0
ImportĀ upstreamĀ versionĀ 4.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html
 
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<!-- /tmp/qt-4.0.0-espenr-1119621036935/qt-x11-opensource-desktop-4.0.0/src/gui/image/qiconengineplugin.cpp -->
 
6
<head>
 
7
    <title>Qt 4.0: QIconEnginePlugin Class Reference</title>
 
8
    <style>h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
 
9
a:link { color: #004faf; text-decoration: none }
 
10
a:visited { color: #672967; text-decoration: none }
 
11
td.postheader { font-family: sans-serif }
 
12
tr.address { font-family: sans-serif }
 
13
body { background: #ffffff; color: black; }</style>
 
14
</head>
 
15
<body>
 
16
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
17
<tr>
 
18
<td align="left" valign="top" width="32"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></td>
 
19
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="annotated.html"><font color="#004faf">Annotated</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
 
20
<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QIconEnginePlugin Class Reference</h1>
 
21
<p>The QIconEnginePlugin class provides an abstract base for custom <a href="qiconengine.html">QIconEngine</a> plugins. <a href="#details">More...</a></p>
 
22
<pre>#include &lt;QIconEnginePlugin&gt;</pre><p>Part of the <a href="qtgui.html">QtGui</a> module.</p>
 
23
<p>Inherits <a href="qobject.html">QObject</a>.</p>
 
24
<ul>
 
25
<li><a href="qiconengineplugin-members.html">List of all members, including inherited members</a></li>
 
26
</ul>
 
27
<a name="public-functions"></a>
 
28
<h3>Public Functions</h3>
 
29
<ul>
 
30
<li><div class="fn"/><b><a href="qiconengineplugin.html#QIconEnginePlugin">QIconEnginePlugin</a></b> ( QObject * <i>parent</i> = 0 )</li>
 
31
<li><div class="fn"/><b><a href="qiconengineplugin.html#dtor.QIconEnginePlugin">~QIconEnginePlugin</a></b> ()</li>
 
32
<li><div class="fn"/>virtual QIconEngine * <b><a href="qiconengineplugin.html#create">create</a></b> ( const QString &amp; <i>filename</i> ) = 0</li>
 
33
<li><div class="fn"/>virtual QStringList <b><a href="qiconengineplugin.html#keys">keys</a></b> () const = 0</li>
 
34
</ul>
 
35
<ul>
 
36
<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
37
</ul>
 
38
<h3>Additional Inherited Members</h3>
 
39
<ul>
 
40
<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
 
41
<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
 
42
<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
 
43
<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
 
44
<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
 
45
</ul>
 
46
<a name="details"></a>
 
47
<hr />
 
48
<h2>Detailed Description</h2>
 
49
<p>The QIconEnginePlugin class provides an abstract base for custom <a href="qiconengine.html">QIconEngine</a> plugins.</p>
 
50
<p>The icon engine plugin is a simple plugin interface that makes it easy to create custom icon engines that can be loaded dynamically into applications through <a href="qicon.html">QIcon</a>. <a href="qicon.html">QIcon</a> uses the file or resource name's suffix to determine what icon engine to use.</p>
 
51
<p>Writing a icon engine plugin is achieved by subclassing this base class, reimplementing the pure virtual functions <a href="qiconengineplugin.html#keys">keys</a>() and <a href="qiconengineplugin.html#create">create</a>(), and exporting the class with the <a href="qpluginloader.html#Q_EXPORT_PLUGIN">Q_EXPORT_PLUGIN</a>() macro.</p>
 
52
<p>See also <a href="plugins-howto.html">How to Create Qt Plugins</a>.</p>
 
53
<hr />
 
54
<h2>Member Function Documentation</h2>
 
55
<h3 class="fn"><a name="QIconEnginePlugin"></a>QIconEnginePlugin::QIconEnginePlugin ( <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
 
56
<p>Constructs a icon engine plugin with the given <i>parent</i>. This is invoked automatically by the <a href="qpluginloader.html#Q_EXPORT_PLUGIN">Q_EXPORT_PLUGIN</a>() macro.</p>
 
57
<h3 class="fn"><a name="dtor.QIconEnginePlugin"></a>QIconEnginePlugin::~QIconEnginePlugin ()</h3>
 
58
<p>Destroys the icon engine plugin.</p>
 
59
<p>You never have to call this explicitly. Qt destroys a plugin automatically when it is no longer used.</p>
 
60
<h3 class="fn"><a name="create"></a><a href="qiconengine.html">QIconEngine</a> * QIconEnginePlugin::create ( const <a href="qstring.html">QString</a> &amp; <i>filename</i> )&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
61
<p>Creates and returns a <a href="qiconengine.html">QIconEngine</a> object for the icon with the given <i>filename</i>.</p>
 
62
<p>Reimplemented from <a href="qiconenginefactoryinterface.html#create">QIconEngineFactoryInterface</a>.</p>
 
63
<p>See also <a href="qiconengineplugin.html#keys">keys</a>().</p>
 
64
<h3 class="fn"><a name="keys"></a><a href="qstringlist.html">QStringList</a> QIconEnginePlugin::keys () const&nbsp;&nbsp;<tt> [pure virtual]</tt></h3>
 
65
<p>Returns a list of icon engine keys that this plugin supports. The keys correspond to the suffix of the file or resource name used when the plugin was created.</p>
 
66
<p>Reimplemented from <a href="qfactoryinterface.html#keys">QFactoryInterface</a>.</p>
 
67
<p>See also <a href="qiconengineplugin.html#create">create</a>().</p>
 
68
<p /><address><hr /><div align="center">
 
69
<table width="100%" cellspacing="0" border="0"><tr class="address">
 
70
<td width="30%">Copyright &copy; 2005 <a href="trolltech.html">Trolltech</a></td>
 
71
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
72
<td width="30%" align="right"><div align="right">Qt 4.0.0</div></td>
 
73
</tr></table></div></address></body>
 
74
</html>