/usr/share/doc/libghc-gio-doc/html/System-GIO-Icons-Icon.html is in libghc-gio-doc 0.12.4-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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>System.GIO.Icons.Icon</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_System-GIO-Icons-Icon.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-GIO-Icons-Icon.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">gio-0.12.4: Binding to the GIO.</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>alpha</td></tr><tr><th>Maintainer</th><td>gtk2hs-devel@lists.sourceforge.net</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">System.GIO.Icons.Icon</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Details
</a></li><li><a href="#g:2">Types
</a></li><li><a href="#g:3">Methods
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </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">newtype</span> <a href="#t:Icon">Icon</a> = <a href="#v:Icon">Icon</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Foreign-ForeignPtr-Safe.html#t:ForeignPtr">ForeignPtr</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a>)</li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/libghc-glib-doc/html/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:IconClass">IconClass</a> o </li><li class="src short"><a href="#v:iconEqual">iconEqual</a> :: (<a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon1, <a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon2) => icon1 -> icon2 -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:iconToString">iconToString</a> :: <a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon => icon -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:iconNewForString">iconNewForString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></li></ul></div><div id="interface"><h1 id="g:1">Details
</h1><div class="doc"><p><code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> is a very minimal interface for icons. It provides functions for checking the equality of two
icons, hashing of icons and serializing an icon to and from strings.
</p><p><code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> does not provide the actual pixmap for the icon as this is out of GIO's scope, however
implementations of <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> may contain the name of an icon (see <code><a href="System-GIO-Icons-ThemedIcon.html#t:ThemedIcon">ThemedIcon</a></code>), or the path to an icon
(see GLoadableIcon).
</p><p>To obtain a hash of a <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code>, see <code>iconHash</code>.
</p><p>To check if two <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code>s are equal, see <code><a href="System-GIO-Icons-Icon.html#v:iconEqual">iconEqual</a></code>.
</p><p>For serializing a <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code>, use <code><a href="System-GIO-Icons-Icon.html#v:iconToString">iconToString</a></code>.
</p><p>If your application or library provides one or more <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> implementations you need to ensure that
each GType is registered with the type system prior to calling <code><a href="System-GIO-Icons-Icon.html#v:iconNewForString">iconNewForString</a></code>.
</p></div><h1 id="g:2">Types
</h1><div class="top"><p class="src"><span class="keyword">newtype</span> <a name="t:Icon" class="def">Icon</a> <a href="src/System-GIO-Types.html#Icon" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Icon" class="def">Icon</a> (<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Foreign-ForeignPtr-Safe.html#t:ForeignPtr">ForeignPtr</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a>)</td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:Icon" class="caption collapser" onclick="toggleSection('i:Icon')">Instances</p><div id="section.i:Icon" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Ord.html#t:Ord">Ord</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/libghc-glib-doc/html/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</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/libghc-glib-doc/html/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:IconClass" class="def">IconClass</a> o <a href="src/System-GIO-Types.html#IconClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:IconClass" class="caption collapser" onclick="toggleSection('i:IconClass')">Instances</p><div id="section.i:IconClass" class="show"><table><tr><td class="src"><a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Methods
</h1><div class="top"><p class="src"><a name="v:iconEqual" class="def">iconEqual</a><a href="src/System-GIO-Icons-Icon.html#iconEqual" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon1, <a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon2)</td><td class="doc empty"> </td></tr><tr><td class="src">=> icon1</td><td class="doc empty"> </td></tr><tr><td class="src">-> icon2</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>returns <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#v:True">True</a></code> if icon1 is equal to icon2. <code><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/Data-Bool.html#v:False">False</a></code> otherwise.
</p></td></tr></table></div><div class="doc"><p>Checks if two icons are equal.
</p></div></div><div class="top"><p class="src"><a name="v:iconToString" class="def">iconToString</a> :: <a href="System-GIO-Icons-Icon.html#t:IconClass">IconClass</a> icon => icon -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/System-GIO-Icons-Icon.html#iconToString" class="link">Source</a></p><div class="doc"><p>Generates a textual representation of icon that can be used for serialization such as when passing
icon to a different process or saving it to persistent storage. Use <code><a href="System-GIO-Icons-Icon.html#v:iconNewForString">iconNewForString</a></code> to get
icon back from the returned string.
</p><p>The encoding of the returned string is proprietary to <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> except in the following two cases
</p><ul><li> If icon is a <code><a href="System-GIO-Icons-FileIcon.html#t:FileIcon">FileIcon</a></code>, the returned string is a native path (such as <em>path</em>to/my icon.png)
without escaping if the <code><a href="System-GIO-File-File.html#t:File">File</a></code> for icon is a native file. If the file is not native, the returned
string is the result of <code>fileGetUri</code>.
</li><li> If icon is a <code><a href="System-GIO-Icons-ThemedIcon.html#t:ThemedIcon">ThemedIcon</a></code> with exactly one name, the encoding is simply the name (such as
network-server).
</li></ul></div></div><div class="top"><p class="src"><a name="v:iconNewForString" class="def">iconNewForString</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.0.2/Data-ByteString.html#t:ByteString">ByteString</a> -> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.6.0.1/System-IO.html#t:IO">IO</a> <a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a><a href="src/System-GIO-Icons-Icon.html#iconNewForString" class="link">Source</a></p><div class="doc"><p>Generate a <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> instance from str. This function can fail if str is not valid - see
<code><a href="System-GIO-Icons-Icon.html#v:iconToString">iconToString</a></code> for discussion.
</p><p>If your application or library provides one or more <code><a href="System-GIO-Icons-Icon.html#t:Icon">Icon</a></code> implementations you need to ensure that
each GType is registered with the type system prior to calling <code><a href="System-GIO-Icons-Icon.html#v:iconNewForString">iconNewForString</a></code>.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.13.2</p></div></body></html>
|