<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="AsIcon">
<refmeta>
<refentrytitle role="top_of_page" id="AsIcon.top_of_page">AsIcon</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>APPSTREAM Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsIcon</refname>
<refpurpose>Describes an icon of an application.</refpurpose>
</refnamediv>

<refsect1 id="AsIcon.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsIconKind"><returnvalue>AsIconKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-kind-from-string">as_icon_kind_from_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-icon-kind-to-string">as_icon_kind_to_string</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsIcon"><returnvalue>AsIcon</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-icon-new">as_icon_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="AsIconKind"><returnvalue>AsIconKind</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-get-kind">as_icon_get_kind</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-kind">as_icon_set_kind</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-icon-get-name">as_icon_get_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-name">as_icon_set_name</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-icon-get-url">as_icon_get_url</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-url">as_icon_set_url</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="as-icon-get-filename">as_icon_get_filename</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-filename">as_icon_set_filename</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint"><returnvalue>guint</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-get-width">as_icon_get_width</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-width">as_icon_set_width</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="guint"><returnvalue>guint</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-get-height">as_icon_get_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-icon-set-height">as_icon_set_height</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsIcon.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="name" colwidth="150px"/>
<colspec colname="description"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="AS-TYPE-ICON:CAPS">AS_TYPE_ICON</link></entry></row>
<row><entry role="datatype_keyword">struct</entry><entry role="function_name"><link linkend="AsIconClass">AsIconClass</link></entry></row>
<row><entry role="datatype_keyword">enum</entry><entry role="function_name"><link linkend="AsIconKind">AsIconKind</link></entry></row>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="AsIcon-struct">AsIcon</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsIcon.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> AsIcon
</screen>
</refsect1>

<refsect1 id="AsIcon.includes"><title>Includes</title><synopsis>#include &lt;appstream.h&gt;
</synopsis></refsect1>

<refsect1 id="AsIcon.description" role="desc">
<title role="desc.title">Description</title>

</refsect1>
<refsect1 id="AsIcon.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-icon-kind-from-string" role="function">
<title>as_icon_kind_from_string&#160;()</title>
<indexterm zone="as-icon-kind-from-string"><primary>as_icon_kind_from_string</primary></indexterm>
<programlisting language="C"><link linkend="AsIconKind"><returnvalue>AsIconKind</returnvalue></link>
as_icon_kind_from_string (<parameter>const <link linkend="gchar"><type>gchar</type></link> *kind_str</parameter>);</programlisting>
<para>Converts the text representation to an enumerated value.</para>
<refsect3 id="as-icon-kind-from-string.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>kind_str</para></entry>
<entry role="parameter_description"><para>the string.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-kind-from-string.returns" role="returns">
<title>Returns</title>
<para> a <link linkend="AsIconKind"><type>AsIconKind</type></link> or <link linkend="AS-ICON-KIND-UNKNOWN:CAPS"><literal>AS_ICON_KIND_UNKNOWN</literal></link> for unknown</para>
</refsect3></refsect2>
<refsect2 id="as-icon-kind-to-string" role="function">
<title>as_icon_kind_to_string&#160;()</title>
<indexterm zone="as-icon-kind-to-string"><primary>as_icon_kind_to_string</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_icon_kind_to_string (<parameter><link linkend="AsIconKind"><type>AsIconKind</type></link> kind</parameter>);</programlisting>
<para>Converts the enumerated value to an text representation.</para>
<refsect3 id="as-icon-kind-to-string.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsIconKind"><literal>AsIconKind</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-kind-to-string.returns" role="returns">
<title>Returns</title>
<para> string version of <parameter>kind</parameter>
</para>
</refsect3></refsect2>
<refsect2 id="as-icon-new" role="function">
<title>as_icon_new&#160;()</title>
<indexterm zone="as-icon-new"><primary>as_icon_new</primary></indexterm>
<programlisting language="C"><link linkend="AsIcon"><returnvalue>AsIcon</returnvalue></link>&#160;*
as_icon_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsIcon"><type>AsIcon</type></link>.</para>
<refsect3 id="as-icon-new.returns" role="returns">
<title>Returns</title>
<para> a <link linkend="AsIcon"><type>AsIcon</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-icon-get-kind" role="function">
<title>as_icon_get_kind&#160;()</title>
<indexterm zone="as-icon-get-kind"><primary>as_icon_get_kind</primary></indexterm>
<programlisting language="C"><link linkend="AsIconKind"><returnvalue>AsIconKind</returnvalue></link>
as_icon_get_kind (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<para>Gets the icon kind.</para>
<refsect3 id="as-icon-get-kind.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-kind.returns" role="returns">
<title>Returns</title>
<para> the <link linkend="AsIconKind"><type>AsIconKind</type></link></para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-kind" role="function">
<title>as_icon_set_kind&#160;()</title>
<indexterm zone="as-icon-set-kind"><primary>as_icon_set_kind</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_kind (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                  <parameter><link linkend="AsIconKind"><type>AsIconKind</type></link> kind</parameter>);</programlisting>
<para>Sets the icon kind.</para>
<refsect3 id="as-icon-set-kind.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>kind</para></entry>
<entry role="parameter_description"><para>the <link linkend="AsIconKind"><type>AsIconKind</type></link>, e.g. <link linkend="AS-ICON-KIND-CACHED:CAPS"><literal>AS_ICON_KIND_CACHED</literal></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-icon-get-name" role="function">
<title>as_icon_get_name&#160;()</title>
<indexterm zone="as-icon-get-name"><primary>as_icon_get_name</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_icon_get_name (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<refsect3 id="as-icon-get-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-name.returns" role="returns">
<title>Returns</title>
<para> 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.</para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-name" role="function">
<title>as_icon_set_name&#160;()</title>
<indexterm zone="as-icon-set-name"><primary>as_icon_set_name</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_name (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                  <parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>);</programlisting>
<para>Sets the stock name or basename to use for the icon.</para>
<refsect3 id="as-icon-set-name.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>name</para></entry>
<entry role="parameter_description"><para>the icon stock name, e.g. "gwenview"</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-icon-get-url" role="function">
<title>as_icon_get_url&#160;()</title>
<indexterm zone="as-icon-get-url"><primary>as_icon_get_url</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_icon_get_url (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<para>Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
This property is only set for icons of type <link linkend="AS-ICON-KIND-REMOTE:CAPS"><literal>AS_ICON_KIND_REMOTE</literal></link></para>
<refsect3 id="as-icon-get-url.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-url.returns" role="returns">
<title>Returns</title>
<para> the URL</para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-url" role="function">
<title>as_icon_set_url&#160;()</title>
<indexterm zone="as-icon-set-url"><primary>as_icon_set_url</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_url (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                 <parameter>const <link linkend="gchar"><type>gchar</type></link> *url</parameter>);</programlisting>
<para>Sets the icon URL.</para>
<refsect3 id="as-icon-set-url.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>url</para></entry>
<entry role="parameter_description"><para>the new icon URL.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-icon-get-filename" role="function">
<title>as_icon_get_filename&#160;()</title>
<indexterm zone="as-icon-get-filename"><primary>as_icon_get_filename</primary></indexterm>
<programlisting language="C">const <link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
as_icon_get_filename (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<refsect3 id="as-icon-get-filename.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-filename.returns" role="returns">
<title>Returns</title>
<para> The absolute path for the icon on disk.
This is only set for icons of kind <link linkend="AS-ICON-KIND-LOCAL:CAPS"><literal>AS_ICON_KIND_LOCAL</literal></link> or
<link linkend="AS-ICON-KIND-CACHED:CAPS"><literal>AS_ICON_KIND_CACHED</literal></link>.</para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-filename" role="function">
<title>as_icon_set_filename&#160;()</title>
<indexterm zone="as-icon-set-filename"><primary>as_icon_set_filename</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_filename (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                      <parameter>const <link linkend="gchar"><type>gchar</type></link> *filename</parameter>);</programlisting>
<para>Sets the icon absolute filename.</para>
<refsect3 id="as-icon-set-filename.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>filename</para></entry>
<entry role="parameter_description"><para>the new icon URL.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-icon-get-width" role="function">
<title>as_icon_get_width&#160;()</title>
<indexterm zone="as-icon-get-width"><primary>as_icon_get_width</primary></indexterm>
<programlisting language="C"><link linkend="guint"><returnvalue>guint</returnvalue></link>
as_icon_get_width (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<refsect3 id="as-icon-get-width.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-width.returns" role="returns">
<title>Returns</title>
<para> The icon width in pixels, or 0 if unknown.</para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-width" role="function">
<title>as_icon_set_width&#160;()</title>
<indexterm zone="as-icon-set-width"><primary>as_icon_set_width</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_width (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                   <parameter><link linkend="guint"><type>guint</type></link> width</parameter>);</programlisting>
<para>Sets the icon width.</para>
<refsect3 id="as-icon-set-width.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>width</para></entry>
<entry role="parameter_description"><para>the width in pixels.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="as-icon-get-height" role="function">
<title>as_icon_get_height&#160;()</title>
<indexterm zone="as-icon-get-height"><primary>as_icon_get_height</primary></indexterm>
<programlisting language="C"><link linkend="guint"><returnvalue>guint</returnvalue></link>
as_icon_get_height (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>);</programlisting>
<refsect3 id="as-icon-get-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="as-icon-get-height.returns" role="returns">
<title>Returns</title>
<para> The icon height in pixels, or 0 if unknown.</para>
</refsect3></refsect2>
<refsect2 id="as-icon-set-height" role="function">
<title>as_icon_set_height&#160;()</title>
<indexterm zone="as-icon-set-height"><primary>as_icon_set_height</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_icon_set_height (<parameter><link linkend="AsIcon"><type>AsIcon</type></link> *icon</parameter>,
                    <parameter><link linkend="guint"><type>guint</type></link> height</parameter>);</programlisting>
<para>Sets the icon height.</para>
<refsect3 id="as-icon-set-height.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>icon</para></entry>
<entry role="parameter_description"><para>a <link linkend="AsIcon"><type>AsIcon</type></link> instance.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>height</para></entry>
<entry role="parameter_description"><para>the height in pixels.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="AsIcon.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="AS-TYPE-ICON:CAPS" role="macro">
<title>AS_TYPE_ICON</title>
<indexterm zone="AS-TYPE-ICON:CAPS"><primary>AS_TYPE_ICON</primary></indexterm>
<programlisting language="C">#define AS_TYPE_ICON (as_icon_get_type ())
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="AsIconClass" role="struct">
<title>struct AsIconClass</title>
<indexterm zone="AsIconClass"><primary>AsIconClass</primary></indexterm>
<programlisting language="C">struct AsIconClass {
	GObjectClass		parent_class;
};
</programlisting>
<para>
</para>
</refsect2>
<refsect2 id="AsIconKind" role="enum">
<title>enum AsIconKind</title>
<indexterm zone="AsIconKind"><primary>AsIconKind</primary></indexterm>
<para>The icon type.</para>
<refsect3 id="AsIconKind.members" role="enum_members">
<title>Members</title>
<informaltable role="enum_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="enum_members_name" colwidth="300px"/>
<colspec colname="enum_members_description"/>
<colspec colname="enum_members_annotations" colwidth="200px"/>
<tbody>
<row role="constant"><entry role="enum_member_name"><para id="AS-ICON-KIND-UNKNOWN:CAPS">AS_ICON_KIND_UNKNOWN</para></entry>
<entry role="enum_member_description"><para>Unknown icon kind</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ICON-KIND-CACHED:CAPS">AS_ICON_KIND_CACHED</para></entry>
<entry role="enum_member_description"><para>Icon in the internal caches</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ICON-KIND-STOCK:CAPS">AS_ICON_KIND_STOCK</para></entry>
<entry role="enum_member_description"><para>Stock icon name</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ICON-KIND-LOCAL:CAPS">AS_ICON_KIND_LOCAL</para></entry>
<entry role="enum_member_description"><para>Local icon name</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
<row role="constant"><entry role="enum_member_name"><para id="AS-ICON-KIND-REMOTE:CAPS">AS_ICON_KIND_REMOTE</para></entry>
<entry role="enum_member_description"><para>Remote icon URL</para>
</entry>
<entry role="enum_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="AsIcon-struct" role="struct">
<title>AsIcon</title>
<indexterm zone="AsIcon-struct"><primary>AsIcon</primary></indexterm>
<programlisting language="C">typedef struct _AsIcon AsIcon;</programlisting>
<para>
</para>
</refsect2>

</refsect1>

</refentry>
