docs/reference/pygio-emblem.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-gioemblem">
   6     <refnamediv>
   7         <refname>gio.Emblem</refname>
   8         <refpurpose>An object for emblems.</refpurpose>
   9     </refnamediv>
  10
  11     <refsect1>
  12         <title>Synopsis</title>
  13
  14     <classsynopsis language="python">
  15         <ooclass><classname>gio.Emblem</classname></ooclass>
  16         <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass>
  17         <ooclass><classname><link linkend="class-gioicon">gio.Icon</link></classname></ooclass>
  18
  19     <constructorsynopsis language="python">
  20         <methodname><link linkend="constructor-gioemblem">gio.Emblem</link></methodname>
  21         <methodparam><parameter role="keyword">icon</parameter></methodparam>
  22         <methodparam><parameter role="keyword">origin</parameter><initializer><literal>gio.EMBLEM_ORIGIN_UNKNOWN</literal></initializer></methodparam>
  23     </constructorsynopsis>
  24
  25     <methodsynopsis language="python">
  26         <methodname><link linkend="method-gioemblem--get-icon">get_icon</link></methodname>
  27         <methodparam></methodparam>
  28     </methodsynopsis>
  29     <methodsynopsis language="python">
  30         <methodname><link linkend="method-gioemblem--get-origin">get_origin</link></methodname>
  31         <methodparam></methodparam>
  32     </methodsynopsis>
  33
  34     </classsynopsis>
  35
  36 <programlisting>
  37 <emphasis role="bold">Functions</emphasis>
  38
  39 <methodsynopsis language="python">
  40     <methodname><link linkend="function-gio--emblem-new-with-origin">gio.emblem_new_with_origin</link></methodname>
  41     <methodparam><parameter role="keyword">icon</parameter></methodparam>
  42     <methodparam><parameter role="keyword">origin</parameter></methodparam>
  43 </methodsynopsis></programlisting>
  44
  45     </refsect1>
  46
  47     <refsect1>
  48         <title>Ancestry</title>
  49
  50 <synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  51   +-- <link linkend="class-gioemblem">gio.Emblem</link>
  52 </synopsis>
  53
  54     </refsect1>
  55
  56     <refsect1>
  57         <title>Implemented Interfaces</title>
  58         <para>
  59             <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
  60             implements
  61             <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
  62         </para>
  63     </refsect1>
  64
  65     <refsect1 id="properties-gioemblem">
  66         <title>gio.Emblem Properties</title>
  67
  68         <blockquote role="properties">
  69             <informaltable pgwide="1" frame="none">
  70                 <tgroup cols="3">
  71                     <colspec column="1" colwidth="1in"/>
  72                     <colspec column="2" colwidth="1in"/>
  73                     <colspec column="3" colwidth="4in"/>
  74                     <tbody>
  75                         <row valign="top">
  76                             <entry>"icon"</entry>
  77                             <entry>Read - Write - Construct Only</entry>
  78                             <entry>The actual icon of the emblem.</entry>
  79                         </row>
  80                         <row valign="top">
  81                             <entry>"origin"</entry>
  82                             <entry>Read - Write - Construct Only</entry>
  83                             <entry>Tells which origin the emblem is derived from.</entry>
  84                         </row>
  85                     </tbody>
  86                 </tgroup>
  87             </informaltable>
  88         </blockquote>
  89
  90     </refsect1>
  91
  92     <refsect1>
  93         <title>Description</title>
  94
  95         <para>
  96             The <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>
  97             class is an implementation of <classname><link linkend="class-gioicon">gio.Icon</link></classname>
  98             that supports having an emblem, which is an icon with additional properties.
  99             It can then be added to a
 100             <link linkend="class-gioemblemedicon"><classname>gio.EmblemedIcon</classname></link>.
 101         </para>
 102         <para>
 103             Currently, only metainformation about the emblem's origin is supported.
 104             More may be added in the future.
 105         </para>
 106     </refsect1>
 107
 108     <refsect1 id="constructor-gioemblem">
 109         <title>Constructor</title>
 110
 111         <programlisting><constructorsynopsis language="python">
 112             <methodname>gio.Emblem</methodname>
 113             <methodparam><parameter role="keyword">icon</parameter></methodparam>
 114             <methodparam><parameter role="keyword">origin</parameter><initializer><literal>gio.EMBLEM_ORIGIN_UNKNOWN</literal></initializer></methodparam>
 115         </constructorsynopsis></programlisting>
 116         <variablelist>
 117             <varlistentry>
 118                 <term><parameter>icon</parameter>&nbsp;:</term>
 119                 <listitem><simpara>a
 120                 <link linkend="class-gioicon"><classname>gio.Icon</classname></link> containing the icon.
 121                 </simpara></listitem>
 122             </varlistentry>
 123             <varlistentry>
 124                 <term><parameter>origin</parameter>&nbsp;:</term>
 125                 <listitem><simpara>
 126                 <link linkend="gio-emblem-origin-constants">origin</link> of the emblem.
 127                 </simpara></listitem>
 128             </varlistentry>
 129             <varlistentry>
 130                 <term><emphasis>Returns</emphasis>&nbsp;:</term>
 131                 <listitem><simpara>a new
 132                 <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
 133                 </simpara></listitem>
 134             </varlistentry>
 135         </variablelist>
 136
 137         <note>
 138           Parameter <parameter>origin</parameter> is available since PyGObject 2.20.
 139         </note>
 140
 141         <para>
 142             Creates a new <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link> for icon.
 143         </para>
 144
 145     </refsect1>
 146
 147     <refsect1>
 148         <title>Methods</title>
 149
 150         <refsect2 id="method-gioemblem--get-icon">
 151             <title>gio.Emblem.get_icon</title>
 152
 153             <programlisting><methodsynopsis language="python">
 154                 <methodname>get_icon</methodname>
 155                 <methodparam></methodparam>
 156             </methodsynopsis></programlisting>
 157
 158             <variablelist>
 159                 <varlistentry>
 160                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 161                     <listitem><simpara>a
 162                     <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.
 163                     </simpara></listitem>
 164                 </varlistentry>
 165             </variablelist>
 166
 167             <para>
 168                 The <methodname>get_icon</methodname>() method gives back the icon from emblem.
 169             </para>
 170         </refsect2>
 171
 172         <refsect2 id="method-gioemblem--get-origin">
 173             <title>gio.Emblem.get_origin</title>
 174
 175             <programlisting><methodsynopsis language="python">
 176                 <methodname>get_origin</methodname>
 177                 <methodparam></methodparam>
 178             </methodsynopsis></programlisting>
 179
 180             <variablelist>
 181                 <varlistentry>
 182                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 183                     <listitem><simpara>the origin of the emblem.
 184                     </simpara></listitem>
 185                 </varlistentry>
 186             </variablelist>
 187
 188             <para>
 189                 The <methodname>get_origin</methodname>() method gets the origin of the emblem.
 190             </para>
 191         </refsect2>
 192     </refsect1>
 193
 194     <refsect1>
 195         <title>Functions</title>
 196
 197         <refsect2 id="function-gio--emblem-new-with-origin">
 198             <title>gio.emblem_new_with_origin</title>
 199
 200             <programlisting><methodsynopsis language="python">
 201                 <methodname>emblem_new_with_origin</methodname>
 202                 <methodparam><parameter role="keyword">icon</parameter></methodparam>
 203                 <methodparam><parameter role="keyword">origin</parameter></methodparam>
 204             </methodsynopsis></programlisting>
 205
 206             <variablelist>
 207                 <varlistentry>
 208                     <term><parameter>origin</parameter>&nbsp;:</term>
 209                     <listitem><simpara>a <xref linkend="gio-emblem-origin-constants" endterm="gio-emblem-origin-constants-title"></xref>
 210                     defining the emblem's origin.
 211                     </simpara></listitem>
 212                 </varlistentry>
 213                 <varlistentry>
 214                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
 215                     <listitem><simpara>A <link linkend="class-gioemblem"><classname>gio.Emblem</classname></link>.
 216                     </simpara></listitem>
 217                 </varlistentry>
 218             </variablelist>
 219
 220             <note>
 221               While this method is not deprecated, with 2.20 and up it is recommended
 222               to use the constructor instead.
 223             </note>
 224
 225
 226             <para>
 227                 The <methodname>emblem_new_with_origin</methodname>() function creates
 228                 a new emblem for icon.
 229             </para>
 230         </refsect2>
 231     </refsect1>
 232 </refentry>