<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AsIcon: AppStream Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="AppStream Library Reference Manual">
<link rel="up" href="ch01.html" title="AppStream API Reference">
<link rel="prev" href="appstream-as-enums.html" title="as-enums">
<link rel="next" href="appstream-AsProvided.html" title="AsProvided">
<meta name="generator" content="GTK-Doc V1.25 (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="#appstream-AsIcon.description" class="shortcut">Description</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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="appstream-as-enums.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="appstream-AsProvided.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="appstream-AsIcon"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="appstream-AsIcon.top_of_page"></a>AsIcon</span></h2>
<p>AsIcon — Describes an icon of an application.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="appstream-AsIcon.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="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="returnvalue">AsIconKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-kind-from-string" title="as_icon_kind_from_string ()">as_icon_kind_from_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-kind-to-string" title="as_icon_kind_to_string ()">as_icon_kind_to_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="returnvalue">AsIcon</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-new" title="as_icon_new ()">as_icon_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="returnvalue">AsIconKind</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-kind" title="as_icon_get_kind ()">as_icon_get_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-kind" title="as_icon_set_kind ()">as_icon_set_kind</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-name" title="as_icon_get_name ()">as_icon_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-name" title="as_icon_set_name ()">as_icon_set_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-url" title="as_icon_get_url ()">as_icon_get_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-url" title="as_icon_set_url ()">as_icon_set_url</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-filename" title="as_icon_get_filename ()">as_icon_get_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-filename" title="as_icon_set_filename ()">as_icon_set_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-width" title="as_icon_get_width ()">as_icon_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-width" title="as_icon_set_width ()">as_icon_set_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-height" title="as_icon_get_height ()">as_icon_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-height" title="as_icon_set_height ()">as_icon_set_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-get-scale" title="as_icon_get_scale ()">as_icon_get_scale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="appstream-AsIcon.html#as-icon-set-scale" title="as_icon_set_scale ()">as_icon_set_scale</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsIcon.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="appstream-AsIcon.html#AS-TYPE-ICON:CAPS" title="AS_TYPE_ICON">AS_TYPE_ICON</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="appstream-AsIcon.html#AsIconClass" title="struct AsIconClass">AsIconClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind">AsIconKind</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon">AsIcon</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="appstream-AsIcon.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <appstream.h>
</pre>
</div>
<div class="refsect1">
<a name="appstream-AsIcon.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="appstream-AsIcon.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-icon-kind-from-string"></a><h3>as_icon_kind_from_string ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="returnvalue">AsIconKind</span></a>
as_icon_kind_from_string (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *kind_str</code></em>);</pre>
<p>Converts the text representation to an enumerated value.</p>
<div class="refsect3">
<a name="as-icon-kind-from-string.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>kind_str</p></td>
<td class="parameter_description"><p>the string.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-kind-from-string.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="type">AsIconKind</span></a> or <a class="link" href="appstream-AsIcon.html#AS-ICON-KIND-UNKNOWN:CAPS"><code class="literal">AS_ICON_KIND_UNKNOWN</code></a> for unknown</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-kind-to-string"></a><h3>as_icon_kind_to_string ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_icon_kind_to_string (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="type">AsIconKind</span></a> kind</code></em>);</pre>
<p>Converts the enumerated value to an text representation.</p>
<div class="refsect3">
<a name="as-icon-kind-to-string.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>kind</p></td>
<td class="parameter_description"><p>the <a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><code class="literal">AsIconKind</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-kind-to-string.returns"></a><h4>Returns</h4>
<p> string version of <em class="parameter"><code>kind</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-new"></a><h3>as_icon_new ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="returnvalue">AsIcon</span></a> *
as_icon_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a>.</p>
<div class="refsect3">
<a name="as-icon-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-kind"></a><h3>as_icon_get_kind ()</h3>
<pre class="programlisting"><a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="returnvalue">AsIconKind</span></a>
as_icon_get_kind (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<p>Gets the icon kind.</p>
<div class="refsect3">
<a name="as-icon-get-kind.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-kind.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="type">AsIconKind</span></a></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-kind"></a><h3>as_icon_set_kind ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_kind (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="type">AsIconKind</span></a> kind</code></em>);</pre>
<p>Sets the icon kind.</p>
<div class="refsect3">
<a name="as-icon-set-kind.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>kind</p></td>
<td class="parameter_description"><p>the <a class="link" href="appstream-AsIcon.html#AsIconKind" title="enum AsIconKind"><span class="type">AsIconKind</span></a>, e.g. <a class="link" href="appstream-AsIcon.html#AS-ICON-KIND-CACHED:CAPS"><code class="literal">AS_ICON_KIND_CACHED</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-name"></a><h3>as_icon_get_name ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_icon_get_name (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<div class="refsect3">
<a name="as-icon-get-name.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-name.returns"></a><h4>Returns</h4>
<p> the stock name of the icon. In case the icon is not of kind
"stock", the basename of the icon filename or URL is returned.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-name"></a><h3>as_icon_set_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_name (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>Sets the stock name or basename to use for the icon.</p>
<div class="refsect3">
<a name="as-icon-set-name.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>the icon stock name, e.g. "gwenview"</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-url"></a><h3>as_icon_get_url ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_icon_get_url (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<p>Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
This property is only set for icons of type <a class="link" href="appstream-AsIcon.html#AS-ICON-KIND-REMOTE:CAPS"><code class="literal">AS_ICON_KIND_REMOTE</code></a></p>
<div class="refsect3">
<a name="as-icon-get-url.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-url.returns"></a><h4>Returns</h4>
<p> the URL</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-url"></a><h3>as_icon_set_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_url (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre>
<p>Sets the icon URL.</p>
<div class="refsect3">
<a name="as-icon-set-url.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>url</p></td>
<td class="parameter_description"><p>the new icon URL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-filename"></a><h3>as_icon_get_filename ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
as_icon_get_filename (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<div class="refsect3">
<a name="as-icon-get-filename.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-filename.returns"></a><h4>Returns</h4>
<p> The absolute path for the icon on disk.
This is only set for icons of kind <a class="link" href="appstream-AsIcon.html#AS-ICON-KIND-LOCAL:CAPS"><code class="literal">AS_ICON_KIND_LOCAL</code></a> or
<a class="link" href="appstream-AsIcon.html#AS-ICON-KIND-CACHED:CAPS"><code class="literal">AS_ICON_KIND_CACHED</code></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-filename"></a><h3>as_icon_set_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_filename (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>Sets the icon absolute filename.</p>
<div class="refsect3">
<a name="as-icon-set-filename.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the new icon URL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-width"></a><h3>as_icon_get_width ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
as_icon_get_width (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<div class="refsect3">
<a name="as-icon-get-width.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-width.returns"></a><h4>Returns</h4>
<p> The icon width in pixels, or 0 if unknown.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-width"></a><h3>as_icon_set_width ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_width (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> width</code></em>);</pre>
<p>Sets the icon width.</p>
<div class="refsect3">
<a name="as-icon-set-width.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>the width in pixels.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-height"></a><h3>as_icon_get_height ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
as_icon_get_height (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<div class="refsect3">
<a name="as-icon-get-height.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-height.returns"></a><h4>Returns</h4>
<p> The icon height in pixels, or 0 if unknown.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-height"></a><h3>as_icon_set_height ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_height (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> height</code></em>);</pre>
<p>Sets the icon height.</p>
<div class="refsect3">
<a name="as-icon-set-height.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>the height in pixels.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-get-scale"></a><h3>as_icon_get_scale ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
as_icon_get_scale (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>);</pre>
<div class="refsect3">
<a name="as-icon-get-scale.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="as-icon-get-scale.returns"></a><h4>Returns</h4>
<p> The icon scaling factor.</p>
</div>
<p class="since">Since: 0.11.0</p>
</div>
<hr>
<div class="refsect2">
<a name="as-icon-set-scale"></a><h3>as_icon_set_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_icon_set_scale (<em class="parameter"><code><a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> *icon</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> scale</code></em>);</pre>
<p>Sets the icon scaling factor used for HiDPI displays.</p>
<div class="refsect3">
<a name="as-icon-set-scale.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 <a class="link" href="appstream-AsIcon.html#AsIcon" title="AsIcon"><span class="type">AsIcon</span></a> instance.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>scale</p></td>
<td class="parameter_description"><p>the icon scaling factor.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 0.11.0</p>
</div>
</div>
<div class="refsect1">
<a name="appstream-AsIcon.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AS-TYPE-ICON:CAPS"></a><h3>AS_TYPE_ICON</h3>
<pre class="programlisting">#define AS_TYPE_ICON (as_icon_get_type ())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsIconClass"></a><h3>struct AsIconClass</h3>
<pre class="programlisting">struct AsIconClass {
GObjectClass parent_class;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="AsIconKind"></a><h3>enum AsIconKind</h3>
<p>The icon type.</p>
<div class="refsect3">
<a name="AsIconKind.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="AS-ICON-KIND-UNKNOWN:CAPS"></a>AS_ICON_KIND_UNKNOWN</p></td>
<td class="enum_member_description">
<p>Unknown icon kind</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-ICON-KIND-CACHED:CAPS"></a>AS_ICON_KIND_CACHED</p></td>
<td class="enum_member_description">
<p>Icon in the internal caches</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-ICON-KIND-STOCK:CAPS"></a>AS_ICON_KIND_STOCK</p></td>
<td class="enum_member_description">
<p>Stock icon name</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-ICON-KIND-LOCAL:CAPS"></a>AS_ICON_KIND_LOCAL</p></td>
<td class="enum_member_description">
<p>Local icon name</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="AS-ICON-KIND-REMOTE:CAPS"></a>AS_ICON_KIND_REMOTE</p></td>
<td class="enum_member_description">
<p>Remote icon URL</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="AsIcon"></a><h3>AsIcon</h3>
<pre class="programlisting">typedef struct _AsIcon AsIcon;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
