docs/reference/gio/html/GEmblemedIcon.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GEmblemedIcon</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="icons.html" title="Icons">
   9 <link rel="prev" href="GThemedIcon.html" title="GThemedIcon">
  10 <link rel="next" href="GEmblem.html" title="GEmblem">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GThemedIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="icons.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GEmblem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GEmblemedIcon.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GEmblemedIcon.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GEmblemedIcon.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GEmblemedIcon.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#GEmblemedIcon.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="GEmblemedIcon"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="GEmblemedIcon.top_of_page"></a>GEmblemedIcon</span></h2>
  40 <p>GEmblemedIcon — Icon with emblems</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="GEmblemedIcon.synopsis"></a><h2>Synopsis</h2>
  46 <pre class="synopsis">
  47 #include &lt;gio/gio.h&gt;
  48
  49 struct              <a class="link" href="GEmblemedIcon.html#GEmblemedIcon-struct" title="struct GEmblemedIcon">GEmblemedIcon</a>;
  50 <a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-new" title="g_emblemed_icon_new ()">g_emblemed_icon_new</a>                 (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>,
  51                                                          <em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);
  52 <a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-get-icon" title="g_emblemed_icon_get_icon ()">g_emblemed_icon_get_icon</a>            (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);
  53 <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-get-emblems" title="g_emblemed_icon_get_emblems ()">g_emblemed_icon_get_emblems</a>         (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);
  54 <span class="returnvalue">void</span>                <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-add-emblem" title="g_emblemed_icon_add_emblem ()">g_emblemed_icon_add_emblem</a>          (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>,
  55                                                          <em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);
  56 <span class="returnvalue">void</span>                <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-clear-emblems" title="g_emblemed_icon_clear_emblems ()">g_emblemed_icon_clear_emblems</a>       (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);
  57 </pre>
  58 </div>
  59 <div class="refsect1">
  60 <a name="GEmblemedIcon.object-hierarchy"></a><h2>Object Hierarchy</h2>
  61 <pre class="synopsis">
  62   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  63    +----GEmblemedIcon
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="GEmblemedIcon.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  68 <p>
  69 GEmblemedIcon implements
  70  <a class="link" href="GIcon.html" title="GIcon">GIcon</a>.</p>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GEmblemedIcon.properties"></a><h2>Properties</h2>
  74 <pre class="synopsis">
  75   "<a class="link" href="GEmblemedIcon.html#GEmblemedIcon--gicon" title='The "gicon" property'>gicon</a>"                    <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>*                : Read / Write / Construct Only
  76 </pre>
  77 </div>
  78 <div class="refsect1">
  79 <a name="GEmblemedIcon.description"></a><h2>Description</h2>
  80 <p>
  81 <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> is an implementation of <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> that supports
  82 adding an emblem to an icon. Adding multiple emblems to an
  83 icon is ensured via <a class="link" href="GEmblemedIcon.html#g-emblemed-icon-add-emblem" title="g_emblemed_icon_add_emblem ()"><code class="function">g_emblemed_icon_add_emblem()</code></a>.
  84 </p>
  85 <p>
  86 Note that <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> allows no control over the position
  87 of the emblems. See also <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> for more information.
  88 </p>
  89 </div>
  90 <div class="refsect1">
  91 <a name="GEmblemedIcon.details"></a><h2>Details</h2>
  92 <div class="refsect2">
  93 <a name="GEmblemedIcon-struct"></a><h3>struct GEmblemedIcon</h3>
  94 <pre class="programlisting">struct GEmblemedIcon;</pre>
  95 <p>
  96 An implementation of <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> for icons with emblems.
  97 </p>
  98 </div>
  99 <hr>
 100 <div class="refsect2">
 101 <a name="g-emblemed-icon-new"></a><h3>g_emblemed_icon_new ()</h3>
 102 <pre class="programlisting"><a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             g_emblemed_icon_new                 (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>,
 103                                                          <em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);</pre>
 104 <p>
 105 Creates a new emblemed icon for <em class="parameter"><code>icon</code></em> with the emblem <em class="parameter"><code>emblem</code></em>.
 106 </p>
 107 <div class="variablelist"><table border="0">
 108 <col align="left" valign="top">
 109 <tbody>
 110 <tr>
 111 <td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
 112 <td>a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>
 113 </td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term"><em class="parameter"><code>emblem</code></em> :</span></p></td>
 117 <td>a <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 118 </td>
 119 </tr>
 120 <tr>
 121 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 122 <td>a new <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Override the parsed C type with given type"><span class="acronym">type</span></acronym> GEmblemedIcon]</span>
 123 </td>
 124 </tr>
 125 </tbody>
 126 </table></div>
 127 <p class="since">Since 2.18</p>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="g-emblemed-icon-get-icon"></a><h3>g_emblemed_icon_get_icon ()</h3>
 132 <pre class="programlisting"><a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> *             g_emblemed_icon_get_icon            (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);</pre>
 133 <p>
 134 Gets the main icon for <em class="parameter"><code>emblemed</code></em>.
 135 </p>
 136 <div class="variablelist"><table border="0">
 137 <col align="left" valign="top">
 138 <tbody>
 139 <tr>
 140 <td><p><span class="term"><em class="parameter"><code>emblemed</code></em> :</span></p></td>
 141 <td>a <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a>
 142 </td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 146 <td>a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> that is owned by <em class="parameter"><code>emblemed</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 147 </td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 <p class="since">Since 2.18</p>
 152 </div>
 153 <hr>
 154 <div class="refsect2">
 155 <a name="g-emblemed-icon-get-emblems"></a><h3>g_emblemed_icon_get_emblems ()</h3>
 156 <pre class="programlisting"><a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             g_emblemed_icon_get_emblems         (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);</pre>
 157 <p>
 158 Gets the list of emblems for the <em class="parameter"><code>icon</code></em>.
 159 </p>
 160 <div class="variablelist"><table border="0">
 161 <col align="left" valign="top">
 162 <tbody>
 163 <tr>
 164 <td><p><span class="term"><em class="parameter"><code>emblemed</code></em> :</span></p></td>
 165 <td>a <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a>
 166 </td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 170 <td>a <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
 171 <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> s that is owned by <em class="parameter"><code>emblemed</code></em>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gio.Emblem][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 172 </td>
 173 </tr>
 174 </tbody>
 175 </table></div>
 176 <p class="since">Since 2.18</p>
 177 </div>
 178 <hr>
 179 <div class="refsect2">
 180 <a name="g-emblemed-icon-add-emblem"></a><h3>g_emblemed_icon_add_emblem ()</h3>
 181 <pre class="programlisting"><span class="returnvalue">void</span>                g_emblemed_icon_add_emblem          (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>,
 182                                                          <em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);</pre>
 183 <p>
 184 Adds <em class="parameter"><code>emblem</code></em> to the <a href="./../glib/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> s.
 185 </p>
 186 <div class="variablelist"><table border="0">
 187 <col align="left" valign="top">
 188 <tbody>
 189 <tr>
 190 <td><p><span class="term"><em class="parameter"><code>emblemed</code></em> :</span></p></td>
 191 <td>a <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a>
 192 </td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term"><em class="parameter"><code>emblem</code></em> :</span></p></td>
 196 <td>a <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>
 197 </td>
 198 </tr>
 199 </tbody>
 200 </table></div>
 201 <p class="since">Since 2.18</p>
 202 </div>
 203 <hr>
 204 <div class="refsect2">
 205 <a name="g-emblemed-icon-clear-emblems"></a><h3>g_emblemed_icon_clear_emblems ()</h3>
 206 <pre class="programlisting"><span class="returnvalue">void</span>                g_emblemed_icon_clear_emblems       (<em class="parameter"><code><a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a> *emblemed</code></em>);</pre>
 207 <p>
 208 Removes all the emblems from <em class="parameter"><code>icon</code></em>.
 209 </p>
 210 <div class="variablelist"><table border="0">
 211 <col align="left" valign="top">
 212 <tbody><tr>
 213 <td><p><span class="term"><em class="parameter"><code>emblemed</code></em> :</span></p></td>
 214 <td>a <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a>
 215 </td>
 216 </tr></tbody>
 217 </table></div>
 218 <p class="since">Since 2.28</p>
 219 </div>
 220 </div>
 221 <div class="refsect1">
 222 <a name="GEmblemedIcon.property-details"></a><h2>Property Details</h2>
 223 <div class="refsect2">
 224 <a name="GEmblemedIcon--gicon"></a><h3>The <code class="literal">"gicon"</code> property</h3>
 225 <pre class="programlisting">  "gicon"                    <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>*                : Read / Write / Construct Only</pre>
 226 <p>The GIcon to attach emblems to.</p>
 227 </div>
 228 </div>
 229 <div class="refsect1">
 230 <a name="GEmblemedIcon.see-also"></a><h2>See Also</h2>
 231 <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, <a class="link" href="GLoadableIcon.html" title="GLoadableIcon"><span class="type">GLoadableIcon</span></a>, <a class="link" href="GThemedIcon.html" title="GThemedIcon"><span class="type">GThemedIcon</span></a>, <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>
 232 </div>
 233 </div>
 234 <div class="footer">
 235 <hr>
 236           Generated by GTK-Doc V1.18</div>
 237 </body>
 238 </html>