docs/reference/pygio-loadableicon.xml

   1 <?xml version="1.0" standalone="no"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3     "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="class-gioloadableicon">
   6     <refnamediv>
   7         <refname>gio.LoadableIcon</refname>
   8         <refpurpose>Interface for icons.</refpurpose>
   9     </refnamediv>
  10
  11     <refsect1>
  12         <title>Synopsis</title>
  13
  14     <classsynopsis language="python">
  15         <ooclass><classname>gio.LoadableIcon</classname></ooclass>
  16         <ooclass><classname><link linkend="class-gobjectginterface">gobject.GInterface</link></classname></ooclass>
  17
  18     <methodsynopsis language="python">
  19         <methodname><link linkend="method-gioloadableicon--load">load</link></methodname>
  20         <methodparam><parameter role="keyword">size</parameter><initializer>0</initializer></methodparam>
  21         <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
  22     </methodsynopsis>
  23     <methodsynopsis language="python">
  24         <methodname><link linkend="method-gioloadableicon--load-async">load_async</link></methodname>
  25         <methodparam><parameter role="keyword">callback</parameter></methodparam>
  26         <methodparam><parameter role="keyword">size</parameter><initializer>0</initializer></methodparam>
  27         <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
  28         <methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
  29     </methodsynopsis>
  30     <methodsynopsis language="python">
  31         <methodname><link linkend="method-gioloadableicon--load-finish">load_finish</link></methodname>
  32         <methodparam><parameter role="keyword">res</parameter></methodparam>
  33     </methodsynopsis>
  34
  35     </classsynopsis>
  36
  37     </refsect1>
  38
  39     <refsect1>
  40         <title>Ancestry</title>
  41
  42 <synopsis>+-- <link linkend="class-gobjectginterface">gobject.GInterface</link>
  43   +-- <link linkend="class-gioloadableicon">gio.LoadableIcon</link>
  44 </synopsis>
  45
  46     </refsect1>
  47
  48     <refsect1>
  49         <title>Prerequisites</title>
  50         <para>
  51             <link linkend="class-gioloadableicon"><classname>gio.LoadableIcon</classname></link> requires
  52             <link linkend="class-gioicon"><classname>gio.Icon</classname></link>. and
  53             <link linkend="class-gobject"><classname>gobject.GObject</classname></link>
  54         </para>
  55     </refsect1>
  56
  57     <refsect1>
  58         <title>Known Implementation</title>
  59         <para>
  60             <link linkend="class-gioloadableicon"><classname>gio.LoadableIcon</classname></link> is implemented by
  61             <link linkend="class-giofileicon"><classname>gio.FileIcon</classname></link>
  62         </para>
  63     </refsect1>
  64
  65     <refsect1>
  66         <title>Description</title>
  67
  68         <para>
  69             <link linkend="class-gioloadableicon"><classname>gio.LoadableIcon</classname></link>
  70             extends the <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
  71             interface and adds the ability to load icons from streams.
  72         </para>
  73     </refsect1>
  74
  75     <refsect1>
  76         <title>Methods</title>
  77
  78         <refsect2 id="method-gioloadableicon--load">
  79             <title>gio.LoadableIcon.load</title>
  80
  81             <programlisting><methodsynopsis language="python">
  82                 <methodname>load</methodname>
  83                 <methodparam><parameter role="keyword">size</parameter><initializer>0</initializer></methodparam>
  84                 <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
  85             </methodsynopsis></programlisting>
  86
  87             <variablelist>
  88                 <varlistentry>
  89                     <term><parameter>size</parameter>&nbsp;:</term>
  90                     <listitem><simpara>an integer
  91                     </simpara></listitem>
  92                 </varlistentry>
  93                 <varlistentry>
  94                     <term><parameter>cancellable</parameter>&nbsp;:</term>
  95                     <listitem><simpara>optional
  96                     <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
  97                     object, <literal>None</literal> to ignore.
  98                     </simpara></listitem>
  99                 </varlistentry>
 100                 <varlistentry>
 101                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 102                     <listitem><simpara>a 2 tuple containing a
 103                     <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
 104                     to read the icon from and a string containing the icon type.
 105                     </simpara></listitem>
 106                 </varlistentry>
 107             </variablelist>
 108
 109             <para>
 110                 The <methodname>load</methodname>() method loads a loadable icon.
 111                 For the asynchronous version of this function, see
 112                 <methodname><link linkend="method-gioloadableicon--load-async">gio.LoadableIcon.load_async</link></methodname>().
 113             </para>
 114         </refsect2>
 115
 116         <refsect2 id="method-gioloadableicon--load-async">
 117             <title>gio.LoadableIcon.load_async</title>
 118
 119             <programlisting><methodsynopsis language="python">
 120                 <methodname>load_async</methodname>
 121                 <methodparam><parameter role="keyword">callback</parameter></methodparam>
 122                 <methodparam><parameter role="keyword">size</parameter><initializer>0</initializer></methodparam>
 123                 <methodparam><parameter role="keyword">cancellable</parameter><initializer><literal>None</literal></initializer></methodparam>
 124                 <methodparam><parameter role="keyword">user_data</parameter><initializer><literal>None</literal></initializer></methodparam>
 125             </methodsynopsis></programlisting>
 126
 127             <variablelist>
 128                 <varlistentry>
 129                     <term><parameter>callback</parameter>&nbsp;:</term>
 130                     <listitem><simpara>a GAsyncReadyCallback to call when the request is satisfied.
 131                     </simpara></listitem>
 132                 </varlistentry>
 133                 <varlistentry>
 134                     <term><parameter>size</parameter>&nbsp;:</term>
 135                     <listitem><simpara>an integer
 136                     </simpara></listitem>
 137                 </varlistentry>
 138                 <varlistentry>
 139                     <term><parameter>cancellable</parameter>&nbsp;:</term>
 140                     <listitem><simpara>optional
 141                     <link linkend="class-giocancellable"><classname>gio.Cancellable</classname></link>
 142                     object, <literal>None</literal> to ignore.
 143                     </simpara></listitem>
 144                 </varlistentry>
 145                 <varlistentry>
 146                     <term><parameter>user_data</parameter>&nbsp;:</term>
 147                     <listitem><simpara>the data to pass to callback function.
 148                     </simpara></listitem>
 149                 </varlistentry>
 150             </variablelist>
 151
 152             <para>
 153                 The <methodname>load_async</methodname>() method loads an icon asynchronously.
 154             </para>
 155             <para>
 156                 For more details, see
 157                 <methodname><link linkend="method-gioloadableicon--load">gio.LoadableIcon.load</link></methodname>()
 158                 which is the synchronous version of this call.
 159             </para>
 160             <para>
 161                 When the operation is finished, callback will be called. You can then call
 162                 <methodname><link linkend="method-gioloadableicon--load-finish">gio.LoadableIcon.load_finish</link></methodname>()
 163                 to get the result of the operation.
 164             </para>
 165         </refsect2>
 166
 167         <refsect2 id="method-gioloadableicon--load-finish">
 168             <title>gio.LoadableIcon.load_finish</title>
 169
 170             <programlisting><methodsynopsis language="python">
 171                 <methodname>load_finish</methodname>
 172                 <methodparam><parameter role="keyword">res</parameter></methodparam>
 173             </methodsynopsis></programlisting>
 174
 175             <variablelist>
 176                 <varlistentry>
 177                     <term><parameter>res</parameter>&nbsp;:</term>
 178                     <listitem><simpara>a
 179                     <link linkend="class-gioasyncresult"><classname>gio.AsyncResult</classname></link>.
 180                     </simpara></listitem>
 181                 </varlistentry>
 182                 <varlistentry>
 183                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 184                     <listitem><simpara>a 2 tuple containing a
 185                     <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
 186                     to read the icon from and a string containing the icon type.
 187                     </simpara></listitem>
 188                 </varlistentry>
 189             </variablelist>
 190
 191             <para>
 192                 The <methodname>load_finish</methodname>() method finishes an asynchronous
 193                 icon load started in
 194                 <methodname><link linkend="method-gioloadableicon--load-async">gio.LoadableIcon.load_async</link></methodname>().
 195             </para>
 196         </refsect2>
 197     </refsect1>
 198 </refentry>