← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/pykde4/oneiric-proposed

« back to all changes in this revision

Viewing changes to docs/html/kdeui/KIconLoader.html

  • Committer: Bazaar Package Importer
  • Author(s): Romain Perier
  • Date: 2011-07-11 12:42:17 UTC
  • Revision ID: james.westby@ubuntu.com-20110711124217-stfa5thgiyis668w
Tags: upstream-4.6.90
Import upstream version 4.6.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/kdeui/KIconLoader.html
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
 
4
 
 
5
<head>
 
6
  <title>KIconLoader</title>
 
7
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 
8
  <meta http-equiv="Content-Style-Type" content="text/css" />
 
9
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
 
10
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
 
11
</head>
 
12
<body>
 
13
<div id="container">
 
14
<div id="header">
 
15
  <div id="header_top">
 
16
    <div>
 
17
      <div>
 
18
        <img alt ="" src="../common/top-kde.jpg"/>
 
19
        KDE 4.7 PyKDE API Reference
 
20
      </div>
 
21
    </div>
 
22
  </div>
 
23
  <div id="header_bottom">
 
24
    <div id="location">
 
25
      <ul>
 
26
        <li>KDE's Python API</li>
 
27
      </ul>
 
28
    </div>
 
29
 
 
30
    <div id="menu">
 
31
      <ul>
 
32
        <li><a href="../modules.html">Overview</a></li>
 
33
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
 
34
<li><a href="http://kde.org/family/">Sitemap</a></li>
 
35
<li><a href="http://kde.org/contact/">Contact Us</a></li>
 
36
</ul>
 
37
    </div>
 
38
  </div>
 
39
</div>
 
40
 
 
41
<div id="body_wrapper">
 
42
<div id="body">
 
43
<div id="right">
 
44
<div class="content">
 
45
<div id="main">
 
46
<div class="clearer">&nbsp;</div>
 
47
 
 
48
<h1>KIconLoader Class Reference</h1>
 
49
<code>from PyKDE4.kdeui import *</code>
 
50
<p>
 
51
Inherits: QObject<br />
 
52
 
 
53
 
 
54
<h2>Detailed Description</h2>
 
55
 
 
56
<p>Iconloader for KDE.
 
57
</p>
 
58
<p>
 
59
KIconLoader will load the current icon theme and all its base themes.
 
60
Icons will be searched in any of these themes. Additionally, it caches
 
61
icons and applies effects according to the user's preferences.
 
62
</p>
 
63
<p>
 
64
In KDE, it is encouraged to load icons by "Group". An icon group is a
 
65
location on the screen where icons are being used. Standard groups are:
 
66
Desktop, Toolbar, MainToolbar, Small and Panel. Each group has some
 
67
centrally configured properties bound to it, including the icon size
 
68
and effects. This makes it possible to offer a consistent icon look in
 
69
all KDE applications.
 
70
</p>
 
71
<p>
 
72
The standard groups are defined below.
 
73
</p>
 
74
<p>
 
75
<li> KIconLoader.Desktop: Icons in the iconview of konqueror, kdesktop and similar apps. </li>
 
76
<li> KIconLoader.Toolbar: Icons in toolbars. </li>
 
77
<li> KIconLoader.MainToolbar: Icons in the main toolbars. </li>
 
78
<li> KIconLoader.Small: Various small (typical 16x16) places: titlebars, listviews </li>
 
79
and menu entries.
 
80
<li> KIconLoader.Panel: Icons in kicker's panel </li>
 
81
</p>
 
82
<p>
 
83
The icons are stored on disk in an icon theme or in a standalone
 
84
directory. The icon theme directories contain multiple sizes and/or
 
85
depths for the same icon. The iconloader will load the correct one based
 
86
on the icon group and the current theme. Icon themes are stored globally
 
87
in share/icons, or, application specific in share/apps/$appdir/icons.
 
88
</p>
 
89
<p>
 
90
The standalone directories contain just one version of an icon. The
 
91
directories that are searched are: $appdir/pics and $appdir/toolbar.
 
92
Icons in these directories can be loaded by using the special group
 
93
"User".
 
94
</p>
 
95
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
 
96
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Context">Context</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Any, Action, Application, Device, FileSystem, MimeType, Animation, Category, Emblem, Emote, International, Place, StatusIcon&nbsp;}</td></tr>
 
97
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Group">Group</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;NoGroup, Desktop, FirstGroup, Toolbar, MainToolbar, Small, Panel, Dialog, LastGroup, User&nbsp;}</td></tr>
 
98
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#MatchType">MatchType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;MatchExact, MatchBest&nbsp;}</td></tr>
 
99
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#States">States</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;DefaultState, ActiveState, DisabledState, LastState&nbsp;}</td></tr>
 
100
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#StdSizes">StdSizes</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;SizeSmall, SizeSmallMedium, SizeMedium, SizeLarge, SizeHuge, SizeEnormous&nbsp;}</td></tr>
 
101
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Type">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Fixed, Scalable, Threshold&nbsp;}</td></tr>
 
102
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
 
103
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#iconLoaderSettingsChanged">iconLoaderSettingsChanged</a> ()</td></tr>
 
104
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
 
105
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KIconLoader">__init__</a> (self, QString appname=QString(), <a href="../kdecore/KStandardDirs.html">KStandardDirs</a> dirs=0, QObject parent=0)</td></tr>
 
106
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KIconLoader">__init__</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData, QObject parent=0)</td></tr>
 
107
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addAppDir">addAppDir</a> (self, QString appname)</td></tr>
 
108
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#addExtraDesktopThemes">addExtraDesktopThemes</a> (self)</td></tr>
 
109
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#extraDesktopThemesAdded">extraDesktopThemesAdded</a> (self)</td></tr>
 
110
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KIconEffect.html">KIconEffect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#iconEffect">iconEffect</a> (self)</td></tr>
 
111
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#iconPath">iconPath</a> (self, QString name, int group_or_size, bool canReturnNull=0)</td></tr>
 
112
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#loadIcon">loadIcon</a> (self, QString name, <a href="../kdeui/KIconLoader.html#Group">KIconLoader.Group</a> group, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList(), QString path_store=0, bool canReturnNull=0)</td></tr>
 
113
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#loadMimeTypeIcon">loadMimeTypeIcon</a> (self, QString iconName, <a href="../kdeui/KIconLoader.html#Group">KIconLoader.Group</a> group, int size=0, int state=KIconLoader.DefaultState, QStringList overlays=QStringList(), QString path_store=0)</td></tr>
 
114
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#newIconLoader">newIconLoader</a> (self)</td></tr>
 
115
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#queryIconsByDir">queryIconsByDir</a> (self, QString iconsDir)</td></tr>
 
116
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#reconfigure">reconfigure</a> (self, QString _appname, <a href="../kdecore/KStandardDirs.html">KStandardDirs</a> _dirs)</td></tr>
 
117
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KIconTheme.html">KIconTheme</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#theme">theme</a> (self)</td></tr>
 
118
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
 
119
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KIconLoader.html">KIconLoader</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#global">global_</a> ()</td></tr>
 
120
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#unknown">unknown</a> ()</td></tr>
 
121
</table>
 
122
<hr><h2>Signal Documentation</h2><a class="anchor" name="iconLoaderSettingsChanged"></a>
 
123
<div class="memitem">
 
124
<div class="memproto">
 
125
<table class="memname"><tr>
 
126
<td class="memname"> iconLoaderSettingsChanged</td>
 
127
<td>(</td>
 
128
<td class="paramtype">&nbsp;</td>
 
129
<td class="paramname">)</td>
 
130
<td width="100%"> </td>
 
131
</tr>
 
132
</table>
 
133
</div>
 
134
<div class="memdoc"><p>Emitted by newIconLoader once the new settings have been loaded
 
135
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("iconLoaderSettingsChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KIconLoader"></a>
 
136
<div class="memitem">
 
137
<div class="memproto">
 
138
<table class="memname"><tr>
 
139
<td class="memname">__init__</td>
 
140
<td>(</td>
 
141
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
142
<td class="paramname"></td>
 
143
</tr><tr>
 
144
<td class="memname"></td>
 
145
<td></td>
 
146
<td class="paramtype">QString&nbsp;</td>
 
147
<td class="paramname"><em>appname=QString()</em>, </td>
 
148
</tr>
 
149
<tr>
 
150
<td class="memname"></td>
 
151
<td></td>
 
152
<td class="paramtype"><a href="../kdecore/KStandardDirs.html">KStandardDirs</a>&nbsp;</td>
 
153
<td class="paramname"><em>dirs=0</em>, </td>
 
154
</tr>
 
155
<tr>
 
156
<td class="memname"></td>
 
157
<td></td>
 
158
<td class="paramtype">QObject&nbsp;</td>
 
159
<td class="paramname"><em>parent=0</em></td>
 
160
</tr>
 
161
<tr>
 
162
<td></td>
 
163
<td>)</td>
 
164
<td></td>
 
165
<td></td>
 
166
<td width="100%"> </td>
 
167
</tr></table>
 
168
</div>
 
169
<div class="memdoc"><p>Constructs an iconloader.
 
170
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
171
<table border="0" cellspacing="2" cellpadding="0">
 
172
<tr><td></td><td valign="top"><em>appname</em>&nbsp;</td><td> Add the data directories of this application to the
 
173
icon search path for the "User" group. The default argument adds the
 
174
directories of the current application.
 
175
 
 
176
<tr><td></td><td valign="top"><em>dirs</em>&nbsp;</td><td> the KStandardDirs object to use. If null the global one is used
 
177
</td></tr>
 
178
</table></dl>
 
179
<p> Usually, you use the default iconloader, which can be accessed via
 
180
KIconLoader.global(), so you hardly ever have to create an
 
181
iconloader object yourself. That one is the current KComponentData's
 
182
(typically KApplication's) iconloader.
 
183
</p></div></div><a class="anchor" name="KIconLoader"></a>
 
184
<div class="memitem">
 
185
<div class="memproto">
 
186
<table class="memname"><tr>
 
187
<td class="memname">__init__</td>
 
188
<td>(</td>
 
189
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
190
<td class="paramname"></td>
 
191
</tr><tr>
 
192
<td class="memname"></td>
 
193
<td></td>
 
194
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a>&nbsp;</td>
 
195
<td class="paramname"><em>componentData</em>, </td>
 
196
</tr>
 
197
<tr>
 
198
<td class="memname"></td>
 
199
<td></td>
 
200
<td class="paramtype">QObject&nbsp;</td>
 
201
<td class="paramname"><em>parent=0</em></td>
 
202
</tr>
 
203
<tr>
 
204
<td></td>
 
205
<td>)</td>
 
206
<td></td>
 
207
<td></td>
 
208
<td width="100%"> </td>
 
209
</tr></table>
 
210
</div>
 
211
<div class="memdoc"><p>Constructs an iconloader.
 
212
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
213
<table border="0" cellspacing="2" cellpadding="0">
 
214
<tr><td></td><td valign="top"><em>componentData</em>&nbsp;</td><td> the KComponentData to use to create this icon loader.
 
215
</td></tr>
 
216
</table></dl>
 
217
<p> Usually, you use the default iconloader, which can be accessed via
 
218
KIconLoader.global(), so you hardly ever have to create an
 
219
iconloader object yourself. That one is the current KComponentData's
 
220
(typically KApplication's) iconloader.
 
221
</p></div></div><a class="anchor" name="addAppDir"></a>
 
222
<div class="memitem">
 
223
<div class="memproto">
 
224
<table class="memname"><tr>
 
225
<td class="memname"> addAppDir</td>
 
226
<td>(</td>
 
227
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
228
<td class="paramname"></td>
 
229
</tr><tr>
 
230
<td class="memname"></td>
 
231
<td></td>
 
232
<td class="paramtype">QString&nbsp;</td>
 
233
<td class="paramname"><em>appname</em></td>
 
234
</tr>
 
235
<tr>
 
236
<td></td>
 
237
<td>)</td>
 
238
<td></td>
 
239
<td></td>
 
240
<td width="100%"> </td>
 
241
</tr></table>
 
242
</div>
 
243
<div class="memdoc"><p>Adds <b>appname</b> to the list of application specific directories.
 
244
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
245
<table border="0" cellspacing="2" cellpadding="0">
 
246
<tr><td></td><td valign="top"><em>appname</em>&nbsp;</td><td> The application name.
 
247
</td></tr>
 
248
</table></dl>
 
249
<p>
 
250
</p></div></div><a class="anchor" name="addExtraDesktopThemes"></a>
 
251
<div class="memitem">
 
252
<div class="memproto">
 
253
<table class="memname"><tr>
 
254
<td class="memname"> addExtraDesktopThemes</td>
 
255
<td>(</td>
 
256
<td class="paramtype">&nbsp;</td>
 
257
<td class="paramname"><em>self</em>&nbsp;)</td>
 
258
<td width="100%"> </td>
 
259
</tr>
 
260
</table>
 
261
</div>
 
262
<div class="memdoc"><p>Adds all the default themes from other desktops at the end of
 
263
the list of icon themes.
 
264
</p></div></div><a class="anchor" name="extraDesktopThemesAdded"></a>
 
265
<div class="memitem">
 
266
<div class="memproto">
 
267
<table class="memname"><tr>
 
268
<td class="memname">bool extraDesktopThemesAdded</td>
 
269
<td>(</td>
 
270
<td class="paramtype">&nbsp;</td>
 
271
<td class="paramname"><em>self</em>&nbsp;)</td>
 
272
<td width="100%"> </td>
 
273
</tr>
 
274
</table>
 
275
</div>
 
276
<div class="memdoc"><p>Returns if the default icon themes of other desktops have been added
 
277
to the list of icon themes where icons are searched.
 
278
</p></div></div><a class="anchor" name="iconEffect"></a>
 
279
<div class="memitem">
 
280
<div class="memproto">
 
281
<table class="memname"><tr>
 
282
<td class="memname"><a href="../kdeui/KIconEffect.html">KIconEffect</a> iconEffect</td>
 
283
<td>(</td>
 
284
<td class="paramtype">&nbsp;</td>
 
285
<td class="paramname"><em>self</em>&nbsp;)</td>
 
286
<td width="100%"> </td>
 
287
</tr>
 
288
</table>
 
289
</div>
 
290
<div class="memdoc"><p>Returns a pointer to the KIconEffect object used by the icon loader.
 
291
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the KIconEffect.
 
292
</dd></dl>
 
293
</p></div></div><a class="anchor" name="iconPath"></a>
 
294
<div class="memitem">
 
295
<div class="memproto">
 
296
<table class="memname"><tr>
 
297
<td class="memname">QString iconPath</td>
 
298
<td>(</td>
 
299
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
300
<td class="paramname"></td>
 
301
</tr><tr>
 
302
<td class="memname"></td>
 
303
<td></td>
 
304
<td class="paramtype">QString&nbsp;</td>
 
305
<td class="paramname"><em>name</em>, </td>
 
306
</tr>
 
307
<tr>
 
308
<td class="memname"></td>
 
309
<td></td>
 
310
<td class="paramtype">int&nbsp;</td>
 
311
<td class="paramname"><em>group_or_size</em>, </td>
 
312
</tr>
 
313
<tr>
 
314
<td class="memname"></td>
 
315
<td></td>
 
316
<td class="paramtype">bool&nbsp;</td>
 
317
<td class="paramname"><em>canReturnNull=0</em></td>
 
318
</tr>
 
319
<tr>
 
320
<td></td>
 
321
<td>)</td>
 
322
<td></td>
 
323
<td></td>
 
324
<td width="100%"> </td>
 
325
</tr></table>
 
326
</div>
 
327
<div class="memdoc"><p>Returns the path of an icon.
 
328
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
329
<table border="0" cellspacing="2" cellpadding="0">
 
330
<tr><td></td><td valign="top"><em>name</em>&nbsp;</td><td> The name of the icon, without extension. If an absolute
 
331
path is supplied for this parameter, iconPath will return it
 
332
directly.
 
333
 
 
334
<tr><td></td><td valign="top"><em>group_or_size</em>&nbsp;</td><td> If positive, search icons whose size is
 
335
specified by the icon group <b>group_or_size.</b> If negative, search
 
336
icons whose size is - <b>group_or_size.</b>
 
337
See KIconLoader.Group and KIconLoader.StdSizes
 
338
 
 
339
<tr><td></td><td valign="top"><em>canReturnNull</em>&nbsp;</td><td> Can return a null string? If not, a path to the
 
340
"unknown" icon will be returned.
 
341
</td></tr> </table></dl>
 
342
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the path of an icon, can be null or the "unknown" icon when
 
343
not found, depending on <b>canReturnNull.</b>
 
344
</dd></dl>
 
345
</p></div></div><a class="anchor" name="loadIcon"></a>
 
346
<div class="memitem">
 
347
<div class="memproto">
 
348
<table class="memname"><tr>
 
349
<td class="memname">QPixmap loadIcon</td>
 
350
<td>(</td>
 
351
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
352
<td class="paramname"></td>
 
353
</tr><tr>
 
354
<td class="memname"></td>
 
355
<td></td>
 
356
<td class="paramtype">QString&nbsp;</td>
 
357
<td class="paramname"><em>name</em>, </td>
 
358
</tr>
 
359
<tr>
 
360
<td class="memname"></td>
 
361
<td></td>
 
362
<td class="paramtype"><a href="../kdeui/KIconLoader.html#Group">KIconLoader.Group</a>&nbsp;</td>
 
363
<td class="paramname"><em>group</em>, </td>
 
364
</tr>
 
365
<tr>
 
366
<td class="memname"></td>
 
367
<td></td>
 
368
<td class="paramtype">int&nbsp;</td>
 
369
<td class="paramname"><em>size=0</em>, </td>
 
370
</tr>
 
371
<tr>
 
372
<td class="memname"></td>
 
373
<td></td>
 
374
<td class="paramtype">int&nbsp;</td>
 
375
<td class="paramname"><em>state=KIconLoader.DefaultState</em>, </td>
 
376
</tr>
 
377
<tr>
 
378
<td class="memname"></td>
 
379
<td></td>
 
380
<td class="paramtype">QStringList&nbsp;</td>
 
381
<td class="paramname"><em>overlays=QStringList()</em>, </td>
 
382
</tr>
 
383
<tr>
 
384
<td class="memname"></td>
 
385
<td></td>
 
386
<td class="paramtype">QString&nbsp;</td>
 
387
<td class="paramname"><em>path_store=0</em>, </td>
 
388
</tr>
 
389
<tr>
 
390
<td class="memname"></td>
 
391
<td></td>
 
392
<td class="paramtype">bool&nbsp;</td>
 
393
<td class="paramname"><em>canReturnNull=0</em></td>
 
394
</tr>
 
395
<tr>
 
396
<td></td>
 
397
<td>)</td>
 
398
<td></td>
 
399
<td></td>
 
400
<td width="100%"> </td>
 
401
</tr></table>
 
402
</div>
 
403
<div class="memdoc"><p>Loads an icon. It will try very hard to find an icon which is
 
404
suitable. If no exact match is found, a close match is searched.
 
405
If neither an exact nor a close match is found, a null pixmap or
 
406
the "unknown" pixmap is returned, depending on the value of the
 
407
<b>canReturnNull</b> parameter.
 
408
</p>
 
409
<p>
 
410
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
411
<table border="0" cellspacing="2" cellpadding="0">
 
412
<tr><td></td><td valign="top"><em>name</em>&nbsp;</td><td> The name of the icon, without extension.
 
413
 
 
414
<tr><td></td><td valign="top"><em>group</em>&nbsp;</td><td> The icon group. This will specify the size of and effects to
 
415
be applied to the icon.
 
416
 
 
417
<tr><td></td><td valign="top"><em>size</em>&nbsp;</td><td> If nonzero, this overrides the size specified by <b>group.</b>
 
418
See KIconLoader.StdSizes.
 
419
 
 
420
<tr><td></td><td valign="top"><em>state</em>&nbsp;</td><td> The icon state: <b>DefaultState,</b> <b>ActiveState</b> or
 
421
<b>DisabledState.</b> Depending on the user's preferences, the iconloader
 
422
may apply a visual effect to hint about its state.
 
423
 
 
424
<tr><td></td><td valign="top"><em>overlays</em>&nbsp;</td><td> a list of emblem icons to overlay, by name. the emblem
 
425
prefix is applied automatically to each name, e.g.
 
426
"zip" becomes "emblem-zip"
 
427
 
 
428
<tr><td></td><td valign="top"><em>path_store</em>&nbsp;</td><td> If not null, the path of the icon is stored here,
 
429
if the icon was found. If the icon was not found <b>path_store</b>
 
430
is unaltered even if the "unknown" pixmap was returned.
 
431
 
 
432
<tr><td></td><td valign="top"><em>canReturnNull</em>&nbsp;</td><td> Can return a null pixmap? If false, the
 
433
"unknown" pixmap is returned when no appropriate icon has been
 
434
found. &lt;em&gt;Note:&lt;/em&gt; a null pixmap can still be returned in the
 
435
event of invalid parameters, such as empty names, negative sizes,
 
436
and etc.
 
437
</td></tr> </table></dl>
 
438
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the QPixmap. Can be null when not found, depending on
 
439
</dd></dl> <b>canReturnNull.</b>
 
440
</p></div></div><a class="anchor" name="loadMimeTypeIcon"></a>
 
441
<div class="memitem">
 
442
<div class="memproto">
 
443
<table class="memname"><tr>
 
444
<td class="memname">QPixmap loadMimeTypeIcon</td>
 
445
<td>(</td>
 
446
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
447
<td class="paramname"></td>
 
448
</tr><tr>
 
449
<td class="memname"></td>
 
450
<td></td>
 
451
<td class="paramtype">QString&nbsp;</td>
 
452
<td class="paramname"><em>iconName</em>, </td>
 
453
</tr>
 
454
<tr>
 
455
<td class="memname"></td>
 
456
<td></td>
 
457
<td class="paramtype"><a href="../kdeui/KIconLoader.html#Group">KIconLoader.Group</a>&nbsp;</td>
 
458
<td class="paramname"><em>group</em>, </td>
 
459
</tr>
 
460
<tr>
 
461
<td class="memname"></td>
 
462
<td></td>
 
463
<td class="paramtype">int&nbsp;</td>
 
464
<td class="paramname"><em>size=0</em>, </td>
 
465
</tr>
 
466
<tr>
 
467
<td class="memname"></td>
 
468
<td></td>
 
469
<td class="paramtype">int&nbsp;</td>
 
470
<td class="paramname"><em>state=KIconLoader.DefaultState</em>, </td>
 
471
</tr>
 
472
<tr>
 
473
<td class="memname"></td>
 
474
<td></td>
 
475
<td class="paramtype">QStringList&nbsp;</td>
 
476
<td class="paramname"><em>overlays=QStringList()</em>, </td>
 
477
</tr>
 
478
<tr>
 
479
<td class="memname"></td>
 
480
<td></td>
 
481
<td class="paramtype">QString&nbsp;</td>
 
482
<td class="paramname"><em>path_store=0</em></td>
 
483
</tr>
 
484
<tr>
 
485
<td></td>
 
486
<td>)</td>
 
487
<td></td>
 
488
<td></td>
 
489
<td width="100%"> </td>
 
490
</tr></table>
 
491
</div>
 
492
<div class="memdoc"><p>Loads an icon for a mimetype.
 
493
This is basically like loadIcon except that extra desktop themes are loaded if necessary.
 
494
</p>
 
495
<p>
 
496
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
497
<table border="0" cellspacing="2" cellpadding="0">
 
498
<tr><td></td><td valign="top"><em>iconName</em>&nbsp;</td><td> The name of the icon, without extension, usually from KMimeType.
 
499
 
 
500
<tr><td></td><td valign="top"><em>group</em>&nbsp;</td><td> The icon group. This will specify the size of and effects to
 
501
be applied to the icon.
 
502
 
 
503
<tr><td></td><td valign="top"><em>size</em>&nbsp;</td><td> If nonzero, this overrides the size specified by <b>group.</b>
 
504
See KIconLoader.StdSizes.
 
505
 
 
506
<tr><td></td><td valign="top"><em>state</em>&nbsp;</td><td> The icon state: <b>DefaultState,</b> <b>ActiveState</b> or
 
507
<b>DisabledState.</b> Depending on the user's preferences, the iconloader
 
508
may apply a visual effect to hint about its state.
 
509
 
 
510
<tr><td></td><td valign="top"><em>path_store</em>&nbsp;</td><td> If not null, the path of the icon is stored here.
 
511
 
 
512
<tr><td></td><td valign="top"><em>overlays</em>&nbsp;</td><td> a list of emblem icons to overlay, by name. the emblem
 
513
prefix is applied automatically to each name, e.g.
 
514
"zip" becomes "emblem-zip"
 
515
</td></tr> </table></dl>
 
516
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the QPixmap. Can not be null, the
 
517
"unknown" pixmap is returned when no appropriate icon has been found.
 
518
</dd></dl>
 
519
</p></div></div><a class="anchor" name="newIconLoader"></a>
 
520
<div class="memitem">
 
521
<div class="memproto">
 
522
<table class="memname"><tr>
 
523
<td class="memname"> newIconLoader</td>
 
524
<td>(</td>
 
525
<td class="paramtype">&nbsp;</td>
 
526
<td class="paramname"><em>self</em>&nbsp;)</td>
 
527
<td width="100%"> </td>
 
528
</tr>
 
529
</table>
 
530
</div>
 
531
<div class="memdoc"><p>Re-initialize the global icon loader
 
532
</p></div></div><a class="anchor" name="queryIconsByDir"></a>
 
533
<div class="memitem">
 
534
<div class="memproto">
 
535
<table class="memname"><tr>
 
536
<td class="memname">QStringList queryIconsByDir</td>
 
537
<td>(</td>
 
538
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
539
<td class="paramname"></td>
 
540
</tr><tr>
 
541
<td class="memname"></td>
 
542
<td></td>
 
543
<td class="paramtype">QString&nbsp;</td>
 
544
<td class="paramname"><em>iconsDir</em></td>
 
545
</tr>
 
546
<tr>
 
547
<td></td>
 
548
<td>)</td>
 
549
<td></td>
 
550
<td></td>
 
551
<td width="100%"> </td>
 
552
</tr></table>
 
553
</div>
 
554
<div class="memdoc"><p>Returns a list of all icons (*.png or *.xpm extension) in the
 
555
given directory.
 
556
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
557
<table border="0" cellspacing="2" cellpadding="0">
 
558
<tr><td></td><td valign="top"><em>iconsDir</em>&nbsp;</td><td> the directory to search in
 
559
</td></tr> </table></dl>
 
560
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> A QStringList containing the icon paths
 
561
</dd></dl>
 
562
</p></div></div><a class="anchor" name="reconfigure"></a>
 
563
<div class="memitem">
 
564
<div class="memproto">
 
565
<table class="memname"><tr>
 
566
<td class="memname"> reconfigure</td>
 
567
<td>(</td>
 
568
<td class="paramtype">&nbsp;<em>self</em>, </td>
 
569
<td class="paramname"></td>
 
570
</tr><tr>
 
571
<td class="memname"></td>
 
572
<td></td>
 
573
<td class="paramtype">QString&nbsp;</td>
 
574
<td class="paramname"><em>_appname</em>, </td>
 
575
</tr>
 
576
<tr>
 
577
<td class="memname"></td>
 
578
<td></td>
 
579
<td class="paramtype"><a href="../kdecore/KStandardDirs.html">KStandardDirs</a>&nbsp;</td>
 
580
<td class="paramname"><em>_dirs</em></td>
 
581
</tr>
 
582
<tr>
 
583
<td></td>
 
584
<td>)</td>
 
585
<td></td>
 
586
<td></td>
 
587
<td width="100%"> </td>
 
588
</tr></table>
 
589
</div>
 
590
<div class="memdoc"><p>Called by KComponentData.newIconLoader to reconfigure the icon loader.
 
591
</p><dl compact><dt><b>Parameters:</b></dt><dd>
 
592
<table border="0" cellspacing="2" cellpadding="0">
 
593
<tr><td></td><td valign="top"><em>_appname</em>&nbsp;</td><td> the new application name
 
594
 
 
595
<tr><td></td><td valign="top"><em>_dirs</em>&nbsp;</td><td> the new standard directories. If 0, the directories
 
596
from KGlobal will be taken.
 
597
</td></tr>
 
598
</table></dl>
 
599
<p>
 
600
</p></div></div><a class="anchor" name="theme"></a>
 
601
<div class="memitem">
 
602
<div class="memproto">
 
603
<table class="memname"><tr>
 
604
<td class="memname"><a href="../kdeui/KIconTheme.html">KIconTheme</a> theme</td>
 
605
<td>(</td>
 
606
<td class="paramtype">&nbsp;</td>
 
607
<td class="paramname"><em>self</em>&nbsp;)</td>
 
608
<td width="100%"> </td>
 
609
</tr>
 
610
</table>
 
611
</div>
 
612
<div class="memdoc"><p>Returns a pointer to the current theme. Can be used to query
 
613
available and default sizes for groups.
 
614
<dl class="note" compact><dt><b>Note:</b></dt><dd> The KIconTheme will change if reconfigure() is called and
 
615
therefore it's not recommended to store the pointer anywhere.
 
616
</dd></dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a pointer to the current theme. 0 if no theme set.
 
617
</dd></dl>
 
618
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="global"></a>
 
619
<div class="memitem">
 
620
<div class="memproto">
 
621
<table class="memname"><tr>
 
622
<td class="memname"><a href="../kdeui/KIconLoader.html">KIconLoader</a> global_</td>
 
623
<td>(</td>
 
624
<td class="paramtype">&nbsp;</td>
 
625
<td class="paramname">)</td>
 
626
<td width="100%"> </td>
 
627
</tr>
 
628
</table>
 
629
</div>
 
630
<div class="memdoc"><p>Returns the global icon loader initialized with the global KComponentData.
 
631
<dl class="return" compact><dt><b>Returns:</b></dt><dd> global icon loader
 
632
</dd></dl>
 
633
</p></div></div><a class="anchor" name="unknown"></a>
 
634
<div class="memitem">
 
635
<div class="memproto">
 
636
<table class="memname"><tr>
 
637
<td class="memname">QPixmap unknown</td>
 
638
<td>(</td>
 
639
<td class="paramtype">&nbsp;</td>
 
640
<td class="paramname">)</td>
 
641
<td width="100%"> </td>
 
642
</tr>
 
643
</table>
 
644
</div>
 
645
<div class="memdoc"><p>Returns the unknown icon. An icon that is used when no other icon
 
646
can be found.
 
647
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the unknown pixmap
 
648
</dd></dl>
 
649
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Context"></a>
 
650
<div class="memitem">
 
651
<div class="memproto">
 
652
<table class="memname">
 
653
<tr><td class="memname">Context</td>
 
654
</tr>
 
655
</table>
 
656
</div>
 
657
<div class="memdoc"><p>Defines the context of the icon.
 
658
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
659
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Any</em>&nbsp;</td><td><tr><td valign="top"><em>Action</em>&nbsp;</td><td><tr><td valign="top"><em>Application</em>&nbsp;</td><td><tr><td valign="top"><em>Device</em>&nbsp;</td><td><tr><td valign="top"><em>FileSystem</em>&nbsp;</td><td><tr><td valign="top"><em>MimeType</em>&nbsp;</td><td><tr><td valign="top"><em>Animation</em>&nbsp;</td><td><tr><td valign="top"><em>Category</em>&nbsp;</td><td><tr><td valign="top"><em>Emblem</em>&nbsp;</td><td><tr><td valign="top"><em>Emote</em>&nbsp;</td><td><tr><td valign="top"><em>International</em>&nbsp;</td><td><tr><td valign="top"><em>Place</em>&nbsp;</td><td><tr><td valign="top"><em>StatusIcon</em>&nbsp;</td><td></table>
 
660
</dl>
 
661
</div></div><p><a class="anchor" name="Group"></a>
 
662
<div class="memitem">
 
663
<div class="memproto">
 
664
<table class="memname">
 
665
<tr><td class="memname">Group</td>
 
666
</tr>
 
667
</table>
 
668
</div>
 
669
<div class="memdoc"><p>The group of the icon.
 
670
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
671
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoGroup</em>&nbsp;=&nbsp;-1</td><td><tr><td valign="top"><em>Desktop</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>FirstGroup</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>Toolbar</em>&nbsp;</td><td><tr><td valign="top"><em>MainToolbar</em>&nbsp;</td><td><tr><td valign="top"><em>Small</em>&nbsp;</td><td><tr><td valign="top"><em>Panel</em>&nbsp;</td><td><tr><td valign="top"><em>Dialog</em>&nbsp;</td><td><tr><td valign="top"><em>LastGroup</em>&nbsp;</td><td><tr><td valign="top"><em>User</em>&nbsp;</td><td></table>
 
672
</dl>
 
673
</div></div><p><a class="anchor" name="MatchType"></a>
 
674
<div class="memitem">
 
675
<div class="memproto">
 
676
<table class="memname">
 
677
<tr><td class="memname">MatchType</td>
 
678
</tr>
 
679
</table>
 
680
</div>
 
681
<div class="memdoc"><p>The type of a match.
 
682
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
683
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>MatchExact</em>&nbsp;</td><td><tr><td valign="top"><em>MatchBest</em>&nbsp;</td><td></table>
 
684
</dl>
 
685
</div></div><p><a class="anchor" name="States"></a>
 
686
<div class="memitem">
 
687
<div class="memproto">
 
688
<table class="memname">
 
689
<tr><td class="memname">States</td>
 
690
</tr>
 
691
</table>
 
692
</div>
 
693
<div class="memdoc"><p>Defines the possible states of an icon.
 
694
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
695
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>DefaultState</em>&nbsp;</td><td><tr><td valign="top"><em>ActiveState</em>&nbsp;</td><td><tr><td valign="top"><em>DisabledState</em>&nbsp;</td><td><tr><td valign="top"><em>LastState</em>&nbsp;</td><td></table>
 
696
</dl>
 
697
</div></div><p><a class="anchor" name="StdSizes"></a>
 
698
<div class="memitem">
 
699
<div class="memproto">
 
700
<table class="memname">
 
701
<tr><td class="memname">StdSizes</td>
 
702
</tr>
 
703
</table>
 
704
</div>
 
705
<div class="memdoc"><p>These are the standard sizes for icons.
 
706
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
707
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>SizeSmall</em>&nbsp;=&nbsp;16</td><td><tr><td valign="top"><em>SizeSmallMedium</em>&nbsp;=&nbsp;22</td><td><tr><td valign="top"><em>SizeMedium</em>&nbsp;=&nbsp;32</td><td><tr><td valign="top"><em>SizeLarge</em>&nbsp;=&nbsp;48</td><td><tr><td valign="top"><em>SizeHuge</em>&nbsp;=&nbsp;64</td><td><tr><td valign="top"><em>SizeEnormous</em>&nbsp;=&nbsp;128</td><td></table>
 
708
</dl>
 
709
</div></div><p><a class="anchor" name="Type"></a>
 
710
<div class="memitem">
 
711
<div class="memproto">
 
712
<table class="memname">
 
713
<tr><td class="memname">Type</td>
 
714
</tr>
 
715
</table>
 
716
</div>
 
717
<div class="memdoc"><p>The type of the icon.
 
718
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
 
719
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Fixed</em>&nbsp;</td><td><tr><td valign="top"><em>Scalable</em>&nbsp;</td><td><tr><td valign="top"><em>Threshold</em>&nbsp;</td><td></table>
 
720
</dl>
 
721
</div></div><p>
 
722
</div>
 
723
</div>
 
724
</div>
 
725
 
 
726
<div id="left">
 
727
 
 
728
<div class="menu_box">
 
729
<div class="nav_list">
 
730
<ul>
 
731
<li><a href="../allclasses.html">Full Index</a></li>
 
732
</ul>
 
733
</div>
 
734
 
 
735
<a name="cp-menu" /><div class="menutitle"><div>
 
736
  <h2 id="cp-menu-project">Modules</h2>
 
737
</div></div>
 
738
<div class="nav_list">
 
739
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
 
740
<li><a href="../dnssd/index.html">dnssd</a></li>
 
741
<li><a href="../kdecore/index.html">kdecore</a></li>
 
742
<li><a href="../kdeui/index.html">kdeui</a></li>
 
743
<li><a href="../khtml/index.html">khtml</a></li>
 
744
<li><a href="../kio/index.html">kio</a></li>
 
745
<li><a href="../knewstuff/index.html">knewstuff</a></li>
 
746
<li><a href="../kparts/index.html">kparts</a></li>
 
747
<li><a href="../kutils/index.html">kutils</a></li>
 
748
<li><a href="../nepomuk/index.html">nepomuk</a></li>
 
749
<li><a href="../phonon/index.html">phonon</a></li>
 
750
<li><a href="../plasma/index.html">plasma</a></li>
 
751
<li><a href="../polkitqt/index.html">polkitqt</a></li>
 
752
<li><a href="../solid/index.html">solid</a></li>
 
753
<li><a href="../soprano/index.html">soprano</a></li>
 
754
</ul></div></div>
 
755
 
 
756
</div>
 
757
 
 
758
</div>
 
759
  <div class="clearer"/>
 
760
</div>
 
761
 
 
762
<div id="end_body"></div>
 
763
</div>
 
764
<div id="footer"><div id="footer_text">
 
765
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
 
766
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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> |
 
767
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
 
768
    </div></div>
 
769
</body>
 
770
</html>