| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>GEmblem: GIO Reference Manual</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> |
| <link rel="home" href="index.html" title="GIO Reference Manual"> |
| <link rel="up" href="icons.html" title="Icons"> |
| <link rel="prev" href="GEmblemedIcon.html" title="GEmblemedIcon"> |
| <link rel="next" href="failable_initialization.html" title="Failable Initialization"> |
| <meta name="generator" content="GTK-Doc V1.25.1 (XML mode)"> |
| <link rel="stylesheet" href="style.css" type="text/css"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> |
| <td width="100%" align="left" class="shortcuts"> |
| <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> |
| <a href="#GEmblem.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> |
| <a href="#GEmblem.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> |
| <a href="#GEmblem.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> |
| <a href="#GEmblem.properties" class="shortcut">Properties</a></span> |
| </td> |
| <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> |
| <td><a accesskey="u" href="icons.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> |
| <td><a accesskey="p" href="GEmblemedIcon.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> |
| <td><a accesskey="n" href="failable_initialization.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> |
| </tr></table> |
| <div class="refentry"> |
| <a name="GEmblem"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="GEmblem.top_of_page"></a>GEmblem</span></h2> |
| <p>GEmblem — An object for emblems</p> |
| </td> |
| <td class="gallery_image" valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsect1"> |
| <a name="GEmblem.functions"></a><h2>Functions</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="functions_return"> |
| <col class="functions_name"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GEmblem.html" title="GEmblem"><span class="returnvalue">GEmblem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GEmblem.html#g-emblem-new" title="g_emblem_new ()">g_emblem_new</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GEmblem.html" title="GEmblem"><span class="returnvalue">GEmblem</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GEmblem.html#g-emblem-new-with-origin" title="g_emblem_new_with_origin ()">g_emblem_new_with_origin</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> * |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GEmblem.html#g-emblem-get-icon" title="g_emblem_get_icon ()">g_emblem_get_icon</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| <tr> |
| <td class="function_type"> |
| <a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin"><span class="returnvalue">GEmblemOrigin</span></a> |
| </td> |
| <td class="function_name"> |
| <a class="link" href="GEmblem.html#g-emblem-get-origin" title="g_emblem_get_origin ()">g_emblem_get_origin</a> <span class="c_punctuation">()</span> |
| </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.properties"></a><h2>Properties</h2> |
| <div class="informaltable"><table class="informaltable" border="0"> |
| <colgroup> |
| <col width="150px" class="properties_type"> |
| <col width="300px" class="properties_name"> |
| <col width="200px" class="properties_flags"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="property_type"> |
| <a href="../gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</td> |
| <td class="property_name"><a class="link" href="GEmblem.html#GEmblem--icon" title="The “icon” property">icon</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| <tr> |
| <td class="property_type"><a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin"><span class="type">GEmblemOrigin</span></a></td> |
| <td class="property_name"><a class="link" href="GEmblem.html#GEmblem--origin" title="The “origin” property">origin</a></td> |
| <td class="property_flags">Read / Write / Construct Only</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.other"></a><h2>Types and Values</h2> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="name"> |
| <col class="description"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="datatype_keyword"> </td> |
| <td class="function_name"><a class="link" href="GEmblem.html#GEmblem-struct" title="GEmblem">GEmblem</a></td> |
| </tr> |
| <tr> |
| <td class="datatype_keyword">enum</td> |
| <td class="function_name"><a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin">GEmblemOrigin</a></td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| <pre class="screen"> <a href="../gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> |
| <span class="lineart">╰──</span> GEmblem |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.implemented-interfaces"></a><h2>Implemented Interfaces</h2> |
| <p> |
| GEmblem implements |
| <a class="link" href="GIcon.html" title="GIcon">GIcon</a>.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.includes"></a><h2>Includes</h2> |
| <pre class="synopsis">#include <gio/gio.h> |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.description"></a><h2>Description</h2> |
| <p><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> is an implementation of <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> that supports |
| having an emblem, which is an icon with additional properties. |
| It can than be added to a <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</span></a>.</p> |
| <p>Currently, only metainformation about the emblem's origin is |
| supported. More may be added in the future.</p> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.functions_details"></a><h2>Functions</h2> |
| <div class="refsect2"> |
| <a name="g-emblem-new"></a><h3>g_emblem_new ()</h3> |
| <pre class="programlisting"><a class="link" href="GEmblem.html" title="GEmblem"><span class="returnvalue">GEmblem</span></a> * |
| g_emblem_new (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>);</pre> |
| <p>Creates a new emblem for <em class="parameter"><code>icon</code></em> |
| .</p> |
| <div class="refsect3"> |
| <a name="g-emblem-new.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>icon</p></td> |
| <td class="parameter_description"><p>a GIcon containing the icon.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-emblem-new.returns"></a><h4>Returns</h4> |
| <p> a new <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-18.html#api-index-2.18">2.18</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-emblem-new-with-origin"></a><h3>g_emblem_new_with_origin ()</h3> |
| <pre class="programlisting"><a class="link" href="GEmblem.html" title="GEmblem"><span class="returnvalue">GEmblem</span></a> * |
| g_emblem_new_with_origin (<em class="parameter"><code><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a> *icon</code></em>, |
| <em class="parameter"><code><a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin"><span class="type">GEmblemOrigin</span></a> origin</code></em>);</pre> |
| <p>Creates a new emblem for <em class="parameter"><code>icon</code></em> |
| .</p> |
| <div class="refsect3"> |
| <a name="g-emblem-new-with-origin.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="parameter_name"><p>icon</p></td> |
| <td class="parameter_description"><p>a GIcon containing the icon.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="parameter_name"><p>origin</p></td> |
| <td class="parameter_description"><p>a GEmblemOrigin enum defining the emblem's origin</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-emblem-new-with-origin.returns"></a><h4>Returns</h4> |
| <p> a new <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>.</p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-18.html#api-index-2.18">2.18</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-emblem-get-icon"></a><h3>g_emblem_get_icon ()</h3> |
| <pre class="programlisting"><a class="link" href="GIcon.html" title="GIcon"><span class="returnvalue">GIcon</span></a> * |
| g_emblem_get_icon (<em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);</pre> |
| <p>Gives back the icon from <em class="parameter"><code>emblem</code></em> |
| .</p> |
| <div class="refsect3"> |
| <a name="g-emblem-get-icon.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>emblem</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> from which the icon should be extracted.</p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-emblem-get-icon.returns"></a><h4>Returns</h4> |
| <p> a <a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>. The returned object belongs to |
| the emblem and should not be modified or freed. </p> |
| <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-18.html#api-index-2.18">2.18</a></p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="g-emblem-get-origin"></a><h3>g_emblem_get_origin ()</h3> |
| <pre class="programlisting"><a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin"><span class="returnvalue">GEmblemOrigin</span></a> |
| g_emblem_get_origin (<em class="parameter"><code><a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a> *emblem</code></em>);</pre> |
| <p>Gets the origin of the emblem.</p> |
| <div class="refsect3"> |
| <a name="g-emblem-get-origin.parameters"></a><h4>Parameters</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="150px" class="parameters_name"> |
| <col class="parameters_description"> |
| <col width="200px" class="parameters_annotations"> |
| </colgroup> |
| <tbody><tr> |
| <td class="parameter_name"><p>emblem</p></td> |
| <td class="parameter_description"><p>a <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a></p></td> |
| <td class="parameter_annotations"> </td> |
| </tr></tbody> |
| </table></div> |
| </div> |
| <div class="refsect3"> |
| <a name="g-emblem-get-origin.returns"></a><h4>Returns</h4> |
| <p> the origin of the emblem. </p> |
| <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-18.html#api-index-2.18">2.18</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.other_details"></a><h2>Types and Values</h2> |
| <div class="refsect2"> |
| <a name="GEmblem-struct"></a><h3>GEmblem</h3> |
| <pre class="programlisting">typedef struct _GEmblem GEmblem;</pre> |
| <p>An object for Emblems</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GEmblemOrigin"></a><h3>enum GEmblemOrigin</h3> |
| <p>GEmblemOrigin is used to add information about the origin of the emblem |
| to <a class="link" href="GEmblem.html" title="GEmblem"><span class="type">GEmblem</span></a>.</p> |
| <div class="refsect3"> |
| <a name="GEmblemOrigin.members"></a><h4>Members</h4> |
| <div class="informaltable"><table class="informaltable" width="100%" border="0"> |
| <colgroup> |
| <col width="300px" class="enum_members_name"> |
| <col class="enum_members_description"> |
| <col width="200px" class="enum_members_annotations"> |
| </colgroup> |
| <tbody> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-EMBLEM-ORIGIN-UNKNOWN:CAPS"></a>G_EMBLEM_ORIGIN_UNKNOWN</p></td> |
| <td class="enum_member_description"> |
| <p>Emblem of unknown origin</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-EMBLEM-ORIGIN-DEVICE:CAPS"></a>G_EMBLEM_ORIGIN_DEVICE</p></td> |
| <td class="enum_member_description"> |
| <p>Emblem adds device-specific information</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-EMBLEM-ORIGIN-LIVEMETADATA:CAPS"></a>G_EMBLEM_ORIGIN_LIVEMETADATA</p></td> |
| <td class="enum_member_description"> |
| <p>Emblem depicts live metadata, such as "readonly"</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| <tr> |
| <td class="enum_member_name"><p><a name="G-EMBLEM-ORIGIN-TAG:CAPS"></a>G_EMBLEM_ORIGIN_TAG</p></td> |
| <td class="enum_member_description"> |
| <p>Emblem comes from a user-defined tag, e.g. set by nautilus (in the future)</p> |
| </td> |
| <td class="enum_member_annotations"> </td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <p class="since">Since: <a class="link" href="api-index-2-18.html#api-index-2.18">2.18</a></p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GEmblem--icon"></a><h3>The <code class="literal">“icon”</code> property</h3> |
| <pre class="programlisting"> “icon” <a href="../gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *</pre> |
| <p>The actual icon of the emblem.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GEmblem--origin"></a><h3>The <code class="literal">“origin”</code> property</h3> |
| <pre class="programlisting"> “origin” <a class="link" href="GEmblem.html#GEmblemOrigin" title="enum GEmblemOrigin"><span class="type">GEmblemOrigin</span></a></pre> |
| <p>Tells which origin the emblem is derived from.</p> |
| <p>Flags: Read / Write / Construct Only</p> |
| <p>Default value: G_EMBLEM_ORIGIN_UNKNOWN</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="GEmblem.see-also"></a><h2>See Also</h2> |
| <p><a class="link" href="GIcon.html" title="GIcon"><span class="type">GIcon</span></a>, <a class="link" href="GEmblemedIcon.html" title="GEmblemedIcon"><span class="type">GEmblemedIcon</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></p> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr>Generated by GTK-Doc V1.25.1</div> |
| </body> |
| </html> |
