<!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"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.General.IconTheme</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-General-IconTheme.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-General-IconTheme.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.General.IconTheme</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Enums
</a></li><li><a href="#g:5">Constructors
</a></li><li><a href="#g:6">Methods
</a></li><li><a href="#g:7">Signals
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Looking up icons by name
</p><ul><li> Module available since Gtk+ version 2.4
</li></ul></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:IconTheme">IconTheme</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:IconThemeClass">IconThemeClass</a> o </li><li class="src short"><a href="#v:castToIconTheme">castToIconTheme</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></li><li class="src short"><a href="#v:toIconTheme">toIconTheme</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> o => o -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:IconInfo">IconInfo</a> </li><li class="src short"><span class="keyword">data</span> <a href="#t:IconLookupFlags">IconLookupFlags</a> <ul class="subs"><li>= <a href="#v:IconLookupNoSvg">IconLookupNoSvg</a> </li><li>| <a href="#v:IconLookupForceSvg">IconLookupForceSvg</a> </li><li>| <a href="#v:IconLookupUseBuiltin">IconLookupUseBuiltin</a> </li><li>| <a href="#v:IconLookupGenericFallback">IconLookupGenericFallback</a> </li><li>| <a href="#v:IconLookupForceSize">IconLookupForceSize</a> </li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:IconThemeError">IconThemeError</a> <ul class="subs"><li>= <a href="#v:IconThemeNotFound">IconThemeNotFound</a> </li><li>| <a href="#v:IconThemeFailed">IconThemeFailed</a> </li></ul></li><li class="src short"><a href="#v:iconThemeNew">iconThemeNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></li><li class="src short"><a href="#v:iconInfoNewForPixbuf">iconInfoNewForPixbuf</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> iconTheme => iconTheme -> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></li><li class="src short"><a href="#v:iconThemeGetDefault">iconThemeGetDefault</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></li><li class="src short"><a href="#v:iconThemeGetForScreen">iconThemeGetForScreen</a> :: <a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></li><li class="src short"><a href="#v:iconThemeSetScreen">iconThemeSetScreen</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeSetSearchPath">iconThemeSetSearchPath</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeGetSearchPath">iconThemeGetSearchPath</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> ([<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>], <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>)</li><li class="src short"><a href="#v:iconThemeAppendSearchPath">iconThemeAppendSearchPath</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemePrependSearchPath">iconThemePrependSearchPath</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeSetCustomTheme">iconThemeSetCustomTheme</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeHasIcon">iconThemeHasIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:iconThemeLookupIcon">iconThemeLookupIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</li><li class="src short"><a href="#v:iconThemeChooseIcon">iconThemeChooseIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</li><li class="src short"><a href="#v:iconThemeLookupByGIcon">iconThemeLookupByGIcon</a> :: (<a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self, <a href="/usr/share/doc/ghc/html/libraries/gio-0.12.0/System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon) => self -> icon -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</li><li class="src short"><a href="#v:iconThemeLoadIcon">iconThemeLoadIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</li><li class="src short"><a href="#v:iconThemeListContexts">iconThemeListContexts</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:iconThemeListIcons">iconThemeListIcons</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:iconThemeGetIconSizes">iconThemeGetIconSizes</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>]</li><li class="src short"><a href="#v:iconThemeGetExampleIconName">iconThemeGetExampleIconName</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:iconThemeRescanIfNeeded">iconThemeRescanIfNeeded</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:iconThemeAddBuiltinIcon">iconThemeAddBuiltinIcon</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a> -> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeErrorQuark">iconThemeErrorQuark</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:Quark">Quark</a></li><li class="src short"><a href="#v:iconInfoCopy">iconInfoCopy</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></li><li class="src short"><a href="#v:iconInfoGetAttachPoints">iconInfoGetAttachPoints</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="Graphics-UI-Gtk-Gdk-Drawable.html#t:Point">Point</a>])</li><li class="src short"><a href="#v:iconInfoGetBaseSize">iconInfoGetBaseSize</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:iconInfoGetBuiltinPixbuf">iconInfoGetBuiltinPixbuf</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</li><li class="src short"><a href="#v:iconInfoGetDisplayName">iconInfoGetDisplayName</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:iconInfoGetEmbeddedRect">iconInfoGetEmbeddedRect</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Events.html#t:Rectangle">Rectangle</a>)</li><li class="src short"><a href="#v:iconInfoGetFilename">iconInfoGetFilename</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><a href="#v:iconInfoLoadIcon">iconInfoLoadIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></li><li class="src short"><a href="#v:iconInfoSetRawCoordinates">iconInfoSetRawCoordinates</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:iconThemeChanged">iconThemeChanged</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)</li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p><code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> provides a facility for looking up icons by name and size. The main reason for using a
name rather than simply providing a filename is to allow different icons to be used depending on
what icon theme is selecetd by the user. The operation of icon themes on Linux and Unix follows the
Icon Theme Specification. There is a default icon theme, named hicolor where applications should
install their icons, but more additional application themes can be installed as operating system
vendors and users choose.
</p><p>Named icons are similar to the Themeable Stock Images facility, and the distinction between the
two may be a bit confusing. A few things to keep in mind:
</p><ul><li> Stock images usually are used in conjunction with Stock Items, such as ''StockOk'' or
''StockOpen''. Named icons are easier to set up and therefore are more useful for new icons
that an application wants to add, such as application icons or window icons.
</li><li> Stock images can only be loaded at the symbolic sizes defined by the <code>IconSize</code> enumeration, or
by custom sizes defined by <code>iconSizeRegister</code>, while named icons are more flexible and any
pixel size can be specified.
</li><li> Because stock images are closely tied to stock items, and thus to actions in the user interface,
stock images may come in multiple variants for different widget states or writing directions.
</li></ul><p>A good rule of thumb is that if there is a stock image for what you want to use, use it, otherwise
use a named icon. It turns out that internally stock images are generally defined in terms of one or
more named icons. (An example of the more than one case is icons that depend on writing direction;
''StockGoForward'' uses the two themed icons <code>gtkStockGoForwardLtr</code> and
<code>gtkStockGoForwardRtl</code>.)
</p><p>In many cases, named themes are used indirectly, via <code><a href="Graphics-UI-Gtk-Display-Image.html#t:Image">Image</a></code> or stock items, rather than directly,
but looking up icons directly is also simple. The <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> object acts as a database of all the
icons in the current theme. You can create new <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> objects, but its much more efficient to
use the standard icon theme for the <code><a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a></code> so that the icon information is shared with other
people looking up icons. In the case where the default screen is being used, looking up an icon can
be as simple as:
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----IconTheme
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IconTheme" class="def">IconTheme</a> <a href="src/Graphics-UI-Gtk-Types.html#IconTheme" class="link">Source</a></p><div class="subs instances"><p id="control.i:IconTheme" class="caption collapser" onclick="toggleSection('i:IconTheme')">Instances</p><div id="section.i:IconTheme" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:IconThemeClass" class="def">IconThemeClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#IconThemeClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:IconThemeClass" class="caption collapser" onclick="toggleSection('i:IconThemeClass')">Instances</p><div id="section.i:IconThemeClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToIconTheme" class="def">castToIconTheme</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a><a href="src/Graphics-UI-Gtk-Types.html#castToIconTheme" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toIconTheme" class="def">toIconTheme</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> o => o -> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a><a href="src/Graphics-UI-Gtk-Types.html#toIconTheme" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IconInfo" class="def">IconInfo</a> <a href="src/Graphics-UI-Gtk-General-IconTheme.html#IconInfo" class="link">Source</a></p></div><h1 id="g:4">Enums
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IconLookupFlags" class="def">IconLookupFlags</a> <a href="src/Graphics-UI-Gtk-General-IconTheme.html#IconLookupFlags" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:IconLookupNoSvg" class="def">IconLookupNoSvg</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IconLookupForceSvg" class="def">IconLookupForceSvg</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IconLookupUseBuiltin" class="def">IconLookupUseBuiltin</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IconLookupGenericFallback" class="def">IconLookupGenericFallback</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IconLookupForceSize" class="def">IconLookupForceSize</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:IconLookupFlags" class="caption collapser" onclick="toggleSection('i:IconLookupFlags')">Instances</p><div id="section.i:IconLookupFlags" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Bounded">Bounded</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:IconThemeError" class="def">IconThemeError</a> <a href="src/Graphics-UI-Gtk-General-IconTheme.html#IconThemeError" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:IconThemeNotFound" class="def">IconThemeNotFound</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:IconThemeFailed" class="def">IconThemeFailed</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:IconThemeError" class="caption collapser" onclick="toggleSection('i:IconThemeError')">Instances</p><div id="section.i:IconThemeError" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Bounded">Bounded</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeError">IconThemeError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeError">IconThemeError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeError">IconThemeError</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeError">IconThemeError</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:5">Constructors
</h1><div class="top"><p class="src"><a name="v:iconThemeNew" class="def">iconThemeNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeNew" class="link">Source</a></p><div class="doc"><p>Creates a new icon theme object. Icon theme objects are used to lookup up
an icon by name in a particular icon theme. Usually, you'll want to use
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeGetDefault">iconThemeGetDefault</a></code> or <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeGetForScreen">iconThemeGetForScreen</a></code> rather than creating a new
icon theme object for scratch.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoNewForPixbuf" class="def">iconInfoNewForPixbuf</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> iconTheme => iconTheme -> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoNewForPixbuf" class="link">Source</a></p></div><h1 id="g:6">Methods
</h1><div class="top"><p class="src"><a name="v:iconThemeGetDefault" class="def">iconThemeGetDefault</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeGetDefault" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc"><p>returns A unique <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> associated with the default
screen. This icon theme is associated with the screen and
can be used as long as the screen is open.
</p></td></tr></table></div><div class="doc"><p>Gets the icon theme for the default screen. See <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeGetForScreen">iconThemeGetForScreen</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeGetForScreen" class="def">iconThemeGetForScreen</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeGetForScreen" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a></td><td class="doc"><p><code>screen</code> - a <code><a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></td><td class="doc"><p>returns A unique <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> associated with the given
screen.
</p></td></tr></table></div><div class="doc"><p>Gets the icon theme object associated with <code>screen</code>; if this function has
not previously been called for the given screen, a new icon theme object
will be created and associated with the screen. Icon theme objects are
fairly expensive to create, so using this function is usually a better
choice than calling than <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeNew">iconThemeNew</a></code> and setting the screen yourself; by
using this function a single icon theme object will be shared between users.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeSetScreen" class="def">iconThemeSetScreen</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeSetScreen" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a></td><td class="doc"><p><code>screen</code> - a <code><a href="Graphics-UI-Gtk-Gdk-Screen.html#t:Screen">Screen</a></code>
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the screen for an icon theme; the screen is used to track the user's
currently configured icon theme, which might be different for different
screens.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeSetSearchPath" class="def">iconThemeSetSearchPath</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeSetSearchPath" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>]</td><td class="doc"><p><code>path</code> - list of directories that are searched for icon
themes
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>nElements</code> - number of elements in <code>path</code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the search path for the icon theme object. When looking for an icon
theme, Gtk+ will search for a subdirectory of one or more of the directories
in <code>path</code> with the same name as the icon theme. (Themes from multiple of the
path elements are combined to allow themes to be extended by adding icons in
the user's home directory.)
</p><p>In addition if an icon found isn't found either in the current icon theme
or the default icon theme, and an image file with the right name is found
directly in one of the elements of <code>path</code>, then that image will be used for
the icon name. (This is legacy feature, and new icons should be put into the
default icon theme, which is called DEFAULT_THEME_NAME, rather than directly
on the icon path.)
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeGetSearchPath" class="def">iconThemeGetSearchPath</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeGetSearchPath" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> ([<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a>], <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>)</td><td class="doc"><p><code>(path, nElements)</code>
<code>path</code> - location to store a list of icon theme path
directories.
</p></td></tr></table></div><div class="doc"><p>Gets the current search path. See <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeSetSearchPath">iconThemeSetSearchPath</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeAppendSearchPath" class="def">iconThemeAppendSearchPath</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeAppendSearchPath" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p><code>path</code> - directory name to append to the icon path
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Appends a directory to the search path. See <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeSetSearchPath">iconThemeSetSearchPath</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemePrependSearchPath" class="def">iconThemePrependSearchPath</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemePrependSearchPath" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p><code>path</code> - directory name to prepend to the icon path
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Prepends a directory to the search path. See <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeSetSearchPath">iconThemeSetSearchPath</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeSetCustomTheme" class="def">iconThemeSetCustomTheme</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeSetCustomTheme" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>themeName</code> name of icon theme to use instead of configured theme, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> to unset a previously set custom theme
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the name of the icon theme that the <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconTheme">IconTheme</a></code> object uses
overriding system configuration. This function cannot be called on the icon
theme objects returned from <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeGetDefault">iconThemeGetDefault</a></code> and
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeGetForScreen">iconThemeGetForScreen</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeHasIcon" class="def">iconThemeHasIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeHasIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>iconName</code> - the name of an icon
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if <code>iconTheme</code> includes an icon for
<code>iconName</code>.
</p></td></tr></table></div><div class="doc"><p>Checks whether an icon theme includes an icon for a particular name.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeLookupIcon" class="def">iconThemeLookupIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeLookupIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>iconName</code> - the name of the icon to lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>size</code> - desired icon size
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc"><p><code>flags</code> - flags modifying the behavior of the
icon lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</td><td class="doc"><p>returns a <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></code>
structure containing information about the icon, or
<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the icon wasn't found.
</p></td></tr></table></div><div class="doc"><p>Looks up a named icon and returns a structure containing information such
as the filename of the icon. The icon can then be rendered into a pixbuf
using <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>. (<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLoadIcon">iconThemeLoadIcon</a></code> combines these two steps if
all you need is the pixbuf.)
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeChooseIcon" class="def">iconThemeChooseIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeChooseIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc"><p><code>iconNames</code> terminated list of icon names to lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>size</code> - desired icon size
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc"><p><code>flags</code> - flags modifying the behavior of the
icon lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</td><td class="doc"><p>returns a <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></code>
structure containing information about the icon, or
<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the icon wasn't found.
</p></td></tr></table></div><div class="doc"><p>Looks up a named icon and returns a structure containing information such
as the filename of the icon. The icon can then be rendered into a pixbuf
using <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>. (<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLoadIcon">iconThemeLoadIcon</a></code> combines these two steps if
all you need is the pixbuf.)
</p><p>If <code>iconNames</code> contains more than one name, this function tries them all
in the given order before falling back to inherited icon themes.
</p><ul><li> Available since Gtk+ version 2.12
</li></ul></div></div><div class="top"><p class="src"><a name="v:iconThemeLookupByGIcon" class="def">iconThemeLookupByGIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeLookupByGIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self, <a href="/usr/share/doc/ghc/html/libraries/gio-0.12.0/System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> icon</td><td class="doc"><p><code>icon</code> - the <code><a href="/usr/share/doc/ghc/html/libraries/gio-0.12.0/System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> to look up
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>size</code> - desired icon size
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc"><p><code>flags</code> - flags modifying the behavior of the
icon lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a>)</td><td class="doc"><p>returns a <code><a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></code>
structure containing information about the icon, or
<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the icon wasn't found.
</p></td></tr></table></div><div class="doc"><p>Looks up an icon and returns a structure containing information such as
the filename of the icon. The icon can then be rendered into a pixbuf using
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>.
</p><ul><li> Available since Gtk+ version 2.14
</li></ul></div></div><div class="top"><p class="src"><a name="v:iconThemeLoadIcon" class="def">iconThemeLoadIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeLoadIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>iconName</code> - the name of the icon to lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>size</code> - the desired icon size. The resulting icon
may not be exactly this size; see <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>.
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconLookupFlags">IconLookupFlags</a></td><td class="doc"><p><code>flags</code> - flags modifying the behavior of the icon
lookup
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</td><td class="doc"><p>returns the rendered icon; this may be a newly
created icon or a new reference to an internal icon,
so you must not modify the icon.
<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if the icon isn't found.
</p></td></tr></table></div><div class="doc"><p>Looks up an icon in an icon theme, scales it to the given size and
renders it into a pixbuf. This is a convenience function; if more details
about the icon are needed, use <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLookupIcon">iconThemeLookupIcon</a></code> followed by
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>.
</p><p>Note that you probably want to listen for icon theme changes and update
the icon. This is usually done by connecting to the <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>::style-set
signal. If for some reason you do not want to update the icon when the icon
theme changes, you should consider using <code>pixbufCopy</code> to make a private copy
of the pixbuf returned by this function. Otherwise Gtk+ may need to keep the
old icon theme loaded, which would be a waste of memory.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeListContexts" class="def">iconThemeListContexts</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeListContexts" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc"><p>returns a String list
holding the names of all the contexts in the
theme.
</p></td></tr></table></div><div class="doc"><p>Gets the list of contexts available within the current hierarchy of icon
themes
</p><ul><li> Available since Gtk+ version 2.12
</li></ul></div></div><div class="top"><p class="src"><a name="v:iconThemeListIcons" class="def">iconThemeListIcons</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeListIcons" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>context</code> a string identifying a particular type of icon, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> to list all icons.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc"><p>returns a String list
holding the names of all the icons in the theme.
</p></td></tr></table></div><div class="doc"><p>Lists the icons in the current icon theme. Only a subset of the icons can
be listed by providing a context string. The set of values for the context
string is system dependent, but will typically include such values as
"Applications" and "MimeTypes".
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeGetIconSizes" class="def">iconThemeGetIconSizes</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeGetIconSizes" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>iconName</code> - the name of an icon
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a>]</td><td class="doc"><p>returns An newly allocated list describing the sizes at
which the icon is available.
</p></td></tr></table></div><div class="doc"><p>Returns an list of integers describing the sizes at which the icon is
available without scaling. A size of -1 means that the icon is available in
a scalable format. The list is zero-terminated.
</p><ul><li> Available since Gtk+ version 2.6
</li></ul></div></div><div class="top"><p class="src"><a name="v:iconThemeGetExampleIconName" class="def">iconThemeGetExampleIconName</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeGetExampleIconName" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</td><td class="doc"><p>returns the name of an example icon or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</p></td></tr></table></div><div class="doc"><p>Gets the name of an icon that is representative of the current theme (for
instance, to use when presenting a list of themes to the user.)
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeRescanIfNeeded" class="def">iconThemeRescanIfNeeded</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeRescanIfNeeded" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code>True</code> if the icon theme has changed and needed to be
reloaded.
</p></td></tr></table></div><div class="doc"><p>Checks to see if the icon theme has changed; if it has, any currently
cached information is discarded and will be reloaded next time <code>iconTheme</code>
is accessed.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeAddBuiltinIcon" class="def">iconThemeAddBuiltinIcon</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeAddBuiltinIcon" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>iconName</code> - the name of the icon to register
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>size</code> - the size at which to register the icon (different
images can be registered for the same icon name at different
sizes.)
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></td><td class="doc"><p><code>pixbuf</code> - <code><a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></code> that contains the image to use for
<code>iconName</code>.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Registers a built-in icon for icon theme lookups. The idea of built-in
icons is to allow an application or library that uses themed icons to
function requiring files to be present in the file system. For instance, the
default images for all of Gtk+'s stock icons are registered as built-icons.
</p><p>In general, if you use <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeAddBuiltinIcon">iconThemeAddBuiltinIcon</a></code> you should also install
the icon in the icon theme, so that the icon is generally available.
</p><p>This function will generally be used with pixbufs loaded via
<code>pixbufNewFromInline</code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconThemeErrorQuark" class="def">iconThemeErrorQuark</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:Quark">Quark</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeErrorQuark" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:iconInfoCopy" class="def">iconInfoCopy</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoCopy" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:iconInfoGetAttachPoints" class="def">iconInfoGetAttachPoints</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> [<a href="Graphics-UI-Gtk-Gdk-Drawable.html#t:Point">Point</a>])<a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetAttachPoints" class="link">Source</a></p><div class="doc"><p>Fetches the set of attach points for an icon. An attach point is a location in the icon that can be
used as anchor points for attaching emblems or overlays to the icon.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoGetBaseSize" class="def">iconInfoGetBaseSize</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetBaseSize" class="link">Source</a></p><div class="doc"><p>Gets the base size for the icon. The base size is a size for the icon that was specified by the icon
theme creator. This may be different than the actual size of image; an example of this is small
emblem icons that can be attached to a larger icon. These icons will be given the same base size as
the larger icons to which they are attached.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoGetBuiltinPixbuf" class="def">iconInfoGetBuiltinPixbuf</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetBuiltinPixbuf" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a>)</td><td class="doc"><p>returns the built-in image pixbuf, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>.
</p></td></tr></table></div><div class="doc"><p>Gets the built-in image for this icon, if any. To allow GTK+ to use built in icon images, you must
pass the ''IconLookupUseBuiltin'' to <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLookupIcon">iconThemeLookupIcon</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoGetDisplayName" class="def">iconInfoGetDisplayName</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetDisplayName" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</td><td class="doc"><p>returns the display name for the icon or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>, if the icon doesn't have a specified display name.
</p></td></tr></table></div><div class="doc"><p>Gets the display name for an icon. A display name is a string to be used in place of the icon name
in a user visible context like a list of icons.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoGetEmbeddedRect" class="def">iconInfoGetEmbeddedRect</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetEmbeddedRect" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Events.html#t:Rectangle">Rectangle</a>)</td><td class="doc"><p><code>rectangle</code> <code><a href="Graphics-UI-Gtk-Gdk-Events.html#t:Rectangle">Rectangle</a></code> in which to store embedded
rectangle coordinates.
</p></td></tr></table></div><div class="doc"><p>Gets the coordinates of a rectangle within the icon that can be used for display of information such
as a preview of the contents of a text file. See <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoSetRawCoordinates">iconInfoSetRawCoordinates</a></code> for further
information about the coordinate system.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoGetFilename" class="def">iconInfoGetFilename</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoGetFilename" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</td><td class="doc"><p>returns the filename for the icon,
or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> if <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoGetBuiltinPixbuf">iconInfoGetBuiltinPixbuf</a></code> should be used instead.
</p></td></tr></table></div><div class="doc"><p>Gets the filename for the icon. If the ''IconLookupUseBuiltin'' flag was passed to
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLookupIcon">iconThemeLookupIcon</a></code>, there may be no filename if a builtin icon is returned; in this case,
you should use <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoGetBuiltinPixbuf">iconInfoGetBuiltinPixbuf</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoLoadIcon" class="def">iconInfoLoadIcon</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoLoadIcon" class="link">Source</a></p><div class="doc"><p>Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. This is
a convenience function; if more details about the icon are needed, use <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconThemeLookupIcon">iconThemeLookupIcon</a></code>
followed by <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>.
</p><p>Note that you probably want to listen for icon theme changes and update the icon. This is usually
done by connecting to the <code>styleSet</code> signal. If for some reason you do not want to update
the icon when the icon theme changes, you should consider using <code>pixbufCopy</code> to make a private
copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme
loaded, which would be a waste of memory.
</p></div></div><div class="top"><p class="src"><a name="v:iconInfoSetRawCoordinates" class="def">iconInfoSetRawCoordinates</a><a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconInfoSetRawCoordinates" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconInfo">IconInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p><code>rawCoordinates</code> whether the coordinates of
embedded rectangles and attached points should be returned in their original
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets whether the coordinates returned by <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoGetEmbeddedRect">iconInfoGetEmbeddedRect</a></code> and
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoGetAttachPoints">iconInfoGetAttachPoints</a></code> should be returned in their original form as specified in the icon
theme, instead of scaled appropriately for the pixbuf returned by <code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoLoadIcon">iconInfoLoadIcon</a></code>.
</p><p>Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap
for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to
the final size of the icon. You can determine if the icon is an SVG icon by using
<code><a href="Graphics-UI-Gtk-General-IconTheme.html#v:iconInfoGetFilename">iconInfoGetFilename</a></code>, and seeing if it is non-<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> and ends in '.svg'.
</p><p>This function is provided primarily to allow compatibility wrappers for older API's, and is not
expected to be useful for applications.
</p></div></div><h1 id="g:7">Signals
</h1><div class="top"><p class="src"><a name="v:iconThemeChanged" class="def">iconThemeChanged</a> :: <a href="Graphics-UI-Gtk-General-IconTheme.html#t:IconThemeClass">IconThemeClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Signals.html#t:Signal">Signal</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a>)<a href="src/Graphics-UI-Gtk-General-IconTheme.html#iconThemeChanged" class="link">Source</a></p><div class="doc"><p>Emitted when the current icon theme is switched or Gtk+ detects that a
change has occurred in the contents of the current icon theme.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
