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