aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/xml
diff options
context:
space:
mode:
authorKen VanDine <ken.vandine@canonical.com>2011-02-24 22:15:21 -0500
committerKen VanDine <ken.vandine@canonical.com>2011-02-24 22:15:21 -0500
commit5f97e91d0017b93369d3ddc7e7354a8f285bf336 (patch)
tree0a340347ff7d0532e0e5862d5391eaaa7a92575e /docs/reference/xml
parent3c0119b757b0c9f449d944e4423ff7d8ec723eaf (diff)
parent22fbdf6340b9b4e233c033e20009d2c65d18c804 (diff)
downloadlibayatana-appindicator-5f97e91d0017b93369d3ddc7e7354a8f285bf336.tar.gz
libayatana-appindicator-5f97e91d0017b93369d3ddc7e7354a8f285bf336.tar.bz2
libayatana-appindicator-5f97e91d0017b93369d3ddc7e7354a8f285bf336.zip
releasing version 0.2.96-0ubuntu10.2.96-0ubuntu1
Diffstat (limited to 'docs/reference/xml')
-rw-r--r--docs/reference/xml/annotation-glossary.xml18
-rw-r--r--docs/reference/xml/api-index-deprecated.xml4
-rw-r--r--docs/reference/xml/api-index-full.xml6
-rw-r--r--docs/reference/xml/app-indicator.xml108
4 files changed, 128 insertions, 8 deletions
diff --git a/docs/reference/xml/annotation-glossary.xml b/docs/reference/xml/annotation-glossary.xml
new file mode 100644
index 0000000..f0417a4
--- /dev/null
+++ b/docs/reference/xml/annotation-glossary.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<!DOCTYPE glossary 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'">
+]>
+
+<glossary id="annotation-glossary">
+ <title>Annotation Glossary</title>
+<glossdiv><title>T</title>
+ <glossentry>
+ <glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm>
+ <glossdef>
+ <para>Don't free data after the code is done.</para>
+ </glossdef>
+ </glossentry>
+</glossdiv>
+</glossary>
diff --git a/docs/reference/xml/api-index-deprecated.xml b/docs/reference/xml/api-index-deprecated.xml
index 8ec0fe4..9e54922 100644
--- a/docs/reference/xml/api-index-deprecated.xml
+++ b/docs/reference/xml/api-index-deprecated.xml
@@ -5,4 +5,8 @@
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<indexdiv>
+<indexdiv><title>I</title>
+<indexentry><primaryie linkends="app-indicator-set-attention-icon"><link linkend="app-indicator-set-attention-icon">app_indicator_set_attention_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="app-indicator-set-icon"><link linkend="app-indicator-set-icon">app_indicator_set_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+</indexdiv>
</indexdiv>
diff --git a/docs/reference/xml/api-index-full.xml b/docs/reference/xml/api-index-full.xml
index a187a94..1ede231 100644
--- a/docs/reference/xml/api-index-full.xml
+++ b/docs/reference/xml/api-index-full.xml
@@ -15,10 +15,12 @@
<indexentry><primaryie linkends="AppIndicator-new-label"><link linkend="AppIndicator-new-label">AppIndicator::new-label</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator-new-status"><link linkend="AppIndicator-new-status">AppIndicator::new-status</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator-scroll-event"><link linkend="AppIndicator-scroll-event">AppIndicator::scroll-event</link>, object signal in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="AppIndicator--attention-icon-desc"><link linkend="AppIndicator--attention-icon-desc">AppIndicator:attention-icon-desc</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--attention-icon-name"><link linkend="AppIndicator--attention-icon-name">AppIndicator:attention-icon-name</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--category"><link linkend="AppIndicator--category">AppIndicator:category</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--connected"><link linkend="AppIndicator--connected">AppIndicator:connected</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--dbus-menu-server"><link linkend="AppIndicator--dbus-menu-server">AppIndicator:dbus-menu-server</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="AppIndicator--icon-desc"><link linkend="AppIndicator--icon-desc">AppIndicator:icon-desc</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--icon-name"><link linkend="AppIndicator--icon-name">AppIndicator:icon-name</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--icon-theme-path"><link linkend="AppIndicator--icon-theme-path">AppIndicator:icon-theme-path</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="AppIndicator--id"><link linkend="AppIndicator--id">AppIndicator:id</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
@@ -33,9 +35,11 @@
<indexentry><primaryie linkends="app-indicator-build-menu-from-desktop"><link linkend="app-indicator-build-menu-from-desktop">app_indicator_build_menu_from_desktop</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="APP-INDICATOR-CLASS:CAPS"><link linkend="APP-INDICATOR-CLASS:CAPS">APP_INDICATOR_CLASS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-attention-icon"><link linkend="app-indicator-get-attention-icon">app_indicator_get_attention_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="app-indicator-get-attention-icon-desc"><link linkend="app-indicator-get-attention-icon-desc">app_indicator_get_attention_icon_desc</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-category"><link linkend="app-indicator-get-category">app_indicator_get_category</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="APP-INDICATOR-GET-CLASS:CAPS"><link linkend="APP-INDICATOR-GET-CLASS:CAPS">APP_INDICATOR_GET_CLASS</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-icon"><link linkend="app-indicator-get-icon">app_indicator_get_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="app-indicator-get-icon-desc"><link linkend="app-indicator-get-icon-desc">app_indicator_get_icon_desc</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-icon-theme-path"><link linkend="app-indicator-get-icon-theme-path">app_indicator_get_icon_theme_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-id"><link linkend="app-indicator-get-id">app_indicator_get_id</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-get-label"><link linkend="app-indicator-get-label">app_indicator_get_label</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
@@ -47,7 +51,9 @@
<indexentry><primaryie linkends="app-indicator-new"><link linkend="app-indicator-new">app_indicator_new</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-new-with-path"><link linkend="app-indicator-new-with-path">app_indicator_new_with_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-set-attention-icon"><link linkend="app-indicator-set-attention-icon">app_indicator_set_attention_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="app-indicator-set-attention-icon-full"><link linkend="app-indicator-set-attention-icon-full">app_indicator_set_attention_icon_full</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-set-icon"><link linkend="app-indicator-set-icon">app_indicator_set_icon</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
+<indexentry><primaryie linkends="app-indicator-set-icon-full"><link linkend="app-indicator-set-icon-full">app_indicator_set_icon_full</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-set-icon-theme-path"><link linkend="app-indicator-set-icon-theme-path">app_indicator_set_icon_theme_path</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-set-label"><link linkend="app-indicator-set-label">app_indicator_set_label</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
<indexentry><primaryie linkends="app-indicator-set-menu"><link linkend="app-indicator-set-menu">app_indicator_set_menu</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry>
diff --git a/docs/reference/xml/app-indicator.xml b/docs/reference/xml/app-indicator.xml
index c83b31d..7070140 100644
--- a/docs/reference/xml/app-indicator.xml
+++ b/docs/reference/xml/app-indicator.xml
@@ -58,10 +58,17 @@ struct <link linkend="AppIndicatorClass">AppIndicatorClass</link>;
<parameter><link linkend="AppIndicatorStatus"><type>AppIndicatorStatus</type></link> status</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-attention-icon">app_indicator_set_attention_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>);
+<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-attention-icon-full">app_indicator_set_attention_icon_full</link>
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_desc</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-menu">app_indicator_set_menu</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter><link linkend="GtkMenu"><type>GtkMenu</type></link> *menu</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-icon">app_indicator_set_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>);
+<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-icon-full">app_indicator_set_icon_full</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_desc</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-icon-theme-path">app_indicator_set_icon_theme_path</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_theme_path</parameter>);
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-label">app_indicator_set_label</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
@@ -73,10 +80,14 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
<link linkend="AppIndicatorCategory"><returnvalue>AppIndicatorCategory</returnvalue></link> <link linkend="app-indicator-get-category">app_indicator_get_category</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
<link linkend="AppIndicatorStatus"><returnvalue>AppIndicatorStatus</returnvalue></link> <link linkend="app-indicator-get-status">app_indicator_get_status</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-icon">app_indicator_get_icon</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
+const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-icon-desc">app_indicator_get_icon_desc</link>
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-icon-theme-path">app_indicator_get_icon_theme_path</link>
(<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-attention-icon">app_indicator_get_attention_icon</link>
(<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
+const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-attention-icon-desc">app_indicator_get_attention_icon_desc</link>
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
<link linkend="GtkMenu"><returnvalue>GtkMenu</returnvalue></link> * <link linkend="app-indicator-get-menu">app_indicator_get_menu</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-label">app_indicator_get_label</link>
(<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);
@@ -99,11 +110,13 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> *
<refsect1 id="libappindicator-app-indicator.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
+ &quot;<link linkend="AppIndicator--attention-icon-desc">attention-icon-desc</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write
&quot;<link linkend="AppIndicator--attention-icon-name">attention-icon-name</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write
&quot;<link linkend="AppIndicator--category">category</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only
&quot;<link linkend="AppIndicator--connected">connected</link>&quot; <link linkend="gboolean"><type>gboolean</type></link> : Read
&quot;<link linkend="AppIndicator--dbus-menu-server">dbus-menu-server</link>&quot; <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>* : Read / Write
- &quot;<link linkend="AppIndicator--icon-name">icon-name</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct
+ &quot;<link linkend="AppIndicator--icon-desc">icon-desc</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write
+ &quot;<link linkend="AppIndicator--icon-name">icon-name</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write
&quot;<link linkend="AppIndicator--icon-theme-path">icon-theme-path</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct
&quot;<link linkend="AppIndicator--id">id</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only
&quot;<link linkend="AppIndicator--label">label</link>&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write
@@ -521,11 +534,28 @@ Wrapper function for property <link linkend="AppIndicator--status"><type>"status
<varlistentry><term><parameter>status</parameter>&#160;:</term>
<listitem><simpara>The status to set for this indicator</simpara></listitem></varlistentry>
</variablelist></refsect2>
-<refsect2 id="app-indicator-set-attention-icon" role="function">
+<refsect2 id="app-indicator-set-attention-icon" role="function" condition="deprecated:Use app_indicator_set_attention_icon_full() instead.">
<title>app_indicator_set_attention_icon ()</title>
-<indexterm zone="app-indicator-set-attention-icon"><primary>app_indicator_set_attention_icon</primary></indexterm>
+<indexterm zone="app-indicator-set-attention-icon" role="deprecated"><primary>app_indicator_set_attention_icon</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_attention_icon (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>);</programlisting>
+<warning><para><literal>app_indicator_set_attention_icon</literal> is deprecated and should not be used in newly-written code. Use <link linkend="app-indicator-set-attention-icon-full"><function>app_indicator_set_attention_icon_full()</function></link> instead.</para></warning>
+<para>
+Wrapper for <link linkend="app-indicator-set-attention-icon-full"><function>app_indicator_set_attention_icon_full()</function></link> with a NULL
+ description.
+</para><variablelist role="params">
+<varlistentry><term><parameter>self</parameter>&#160;:</term>
+<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>icon_name</parameter>&#160;:</term>
+<listitem><simpara>The name of the attention icon to set for this indicator</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2 id="app-indicator-set-attention-icon-full" role="function">
+<title>app_indicator_set_attention_icon_full ()</title>
+<indexterm zone="app-indicator-set-attention-icon-full"><primary>app_indicator_set_attention_icon_full</primary></indexterm>
+<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_attention_icon_full
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_desc</parameter>);</programlisting>
<para>
Wrapper function for property <link linkend="AppIndicator--attention-icon-name"><type>"attention-icon-name"</type></link>.
</para><variablelist role="params">
@@ -533,6 +563,8 @@ Wrapper function for property <link linkend="AppIndicator--attention-icon-name">
<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_name</parameter>&#160;:</term>
<listitem><simpara>The name of the attention icon to set for this indicator</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>icon_desc</parameter>&#160;:</term>
+<listitem><simpara>A textual description of the icon</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="app-indicator-set-menu" role="function">
<title>app_indicator_set_menu ()</title>
@@ -551,21 +583,42 @@ Sets the menu that should be shown when the Application Indicator
<varlistentry><term><parameter>menu</parameter>&#160;:</term>
<listitem><simpara>A <link linkend="GtkMenu"><type>GtkMenu</type></link> to set</simpara></listitem></varlistentry>
</variablelist></refsect2>
-<refsect2 id="app-indicator-set-icon" role="function">
+<refsect2 id="app-indicator-set-icon" role="function" condition="deprecated:Use app_indicator_set_icon_full()">
<title>app_indicator_set_icon ()</title>
-<indexterm zone="app-indicator-set-icon"><primary>app_indicator_set_icon</primary></indexterm>
+<indexterm zone="app-indicator-set-icon" role="deprecated"><primary>app_indicator_set_icon</primary></indexterm>
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_icon (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>);</programlisting>
+<warning><para><literal>app_indicator_set_icon</literal> is deprecated and should not be used in newly-written code. Use <link linkend="app-indicator-set-icon-full"><function>app_indicator_set_icon_full()</function></link></para></warning>
+<para>
+Wrapper function for <link linkend="app-indicator-set-icon-full"><function>app_indicator_set_icon_full()</function></link> with a NULL
+ description.
+</para><variablelist role="params">
+<varlistentry><term><parameter>self</parameter>&#160;:</term>
+<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>icon_name</parameter>&#160;:</term>
+<listitem><simpara>The icon name to set.</simpara></listitem></varlistentry>
+</variablelist></refsect2>
+<refsect2 id="app-indicator-set-icon-full" role="function">
+<title>app_indicator_set_icon_full ()</title>
+<indexterm zone="app-indicator-set-icon-full"><primary>app_indicator_set_icon_full</primary></indexterm>
+<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_icon_full (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_name</parameter>,
+ <parameter>const <link linkend="gchar"><type>gchar</type></link> *icon_desc</parameter>);</programlisting>
<para>
Sets the default icon to use when the status is active but
not set to attention. In most cases, this should be the
application icon for the program.
- Wrapper function for property <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link>.
+</para>
+<para>
+ Wrapper function for property <link linkend="AppIndicator--icon-name"><type>"icon-name"</type></link> and
+ <link linkend="AppIndicator-icon-description"><type>"icon-description"</type></link>.
</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&#160;:</term>
<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
<varlistentry><term><parameter>icon_name</parameter>&#160;:</term>
<listitem><simpara>The icon name to set.</simpara></listitem></varlistentry>
+<varlistentry><term><parameter>icon_desc</parameter>&#160;:</term>
+<listitem><simpara>A textual description of the icon for accessibility</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="app-indicator-set-icon-theme-path" role="function">
<title>app_indicator_set_icon_theme_path ()</title>
@@ -660,6 +713,18 @@ Wrapper function for property <link linkend="AppIndicator--icon-name"><type>"ico
<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The current icon name.</simpara></listitem></varlistentry>
</variablelist></refsect2>
+<refsect2 id="app-indicator-get-icon-desc" role="function">
+<title>app_indicator_get_icon_desc ()</title>
+<indexterm zone="app-indicator-get-icon-desc"><primary>app_indicator_get_icon_desc</primary></indexterm>
+<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_icon_desc
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting>
+<para>
+Wrapper function for property <link linkend="AppIndicator--icon-desc"><type>"icon-desc"</type></link>.
+</para><variablelist role="params">
+<varlistentry><term><parameter>self</parameter>&#160;:</term>
+<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The current icon description.</simpara></listitem></varlistentry>
+</variablelist></refsect2>
<refsect2 id="app-indicator-get-icon-theme-path" role="function">
<title>app_indicator_get_icon_theme_path ()</title>
<indexterm zone="app-indicator-get-icon-theme-path"><primary>app_indicator_get_icon_theme_path</primary></indexterm>
@@ -684,6 +749,18 @@ Wrapper function for property <link linkend="AppIndicator--attention-icon-name">
<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The current attention icon name.</simpara></listitem></varlistentry>
</variablelist></refsect2>
+<refsect2 id="app-indicator-get-attention-icon-desc" role="function">
+<title>app_indicator_get_attention_icon_desc ()</title>
+<indexterm zone="app-indicator-get-attention-icon-desc"><primary>app_indicator_get_attention_icon_desc</primary></indexterm>
+<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_attention_icon_desc
+ (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting>
+<para>
+Wrapper function for property <link linkend="AppIndicator--attention-icon-desc"><type>"attention-icon-desc"</type></link>.
+</para><variablelist role="params">
+<varlistentry><term><parameter>self</parameter>&#160;:</term>
+<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>The current attention icon description.</simpara></listitem></varlistentry>
+</variablelist></refsect2>
<refsect2 id="app-indicator-get-menu" role="function">
<title>app_indicator_get_menu ()</title>
<indexterm zone="app-indicator-get-menu"><primary>app_indicator_get_menu</primary></indexterm>
@@ -694,7 +771,7 @@ Gets the menu being used for this application indicator.
</para><variablelist role="params">
<varlistentry><term><parameter>self</parameter>&#160;:</term>
<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry>
-<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>A <link linkend="GtkMenu"><type>GtkMenu</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if one hasn't been set.</simpara></listitem></varlistentry>
+<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>A <link linkend="GtkMenu"><type>GtkMenu</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if one hasn't been set. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="app-indicator-get-label" role="function">
<title>app_indicator_get_label ()</title>
@@ -753,6 +830,14 @@ This function allows for building the Application Indicator menu
</refsect1>
<refsect1 id="libappindicator-app-indicator.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
+<refsect2 id="AppIndicator--attention-icon-desc" role="property"><title>The <literal>&quot;attention-icon-desc&quot;</literal> property</title>
+<indexterm zone="AppIndicator--attention-icon-desc"><primary>AppIndicator:attention-icon-desc</primary></indexterm>
+<programlisting> &quot;attention-icon-desc&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
+<para>
+If the indicator sets it's status to <link linkend="APP-INDICATOR-STATUS-ATTENTION:CAPS"><literal>APP_INDICATOR_STATUS_ATTENTION</literal></link>
+ then this textual description of the icon shown.
+</para><para>Default value: NULL</para>
+</refsect2>
<refsect2 id="AppIndicator--attention-icon-name" role="property"><title>The <literal>&quot;attention-icon-name&quot;</literal> property</title>
<indexterm zone="AppIndicator--attention-icon-name"><primary>AppIndicator:attention-icon-name</primary></indexterm>
<programlisting> &quot;attention-icon-name&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
@@ -784,9 +869,16 @@ Pretty simple, <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if we ha
A way to get the internal dbusmenu server if it is available.
This should only be used for testing.
</para></refsect2>
+<refsect2 id="AppIndicator--icon-desc" role="property"><title>The <literal>&quot;icon-desc&quot;</literal> property</title>
+<indexterm zone="AppIndicator--icon-desc"><primary>AppIndicator:icon-desc</primary></indexterm>
+<programlisting> &quot;icon-desc&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
+<para>
+The description of the regular icon that is shown for the indicator.
+</para><para>Default value: NULL</para>
+</refsect2>
<refsect2 id="AppIndicator--icon-name" role="property"><title>The <literal>&quot;icon-name&quot;</literal> property</title>
<indexterm zone="AppIndicator--icon-name"><primary>AppIndicator:icon-name</primary></indexterm>
-<programlisting> &quot;icon-name&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct</programlisting>
+<programlisting> &quot;icon-name&quot; <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting>
<para>
The name of the regular icon that is shown for the indicator.
</para><para>Default value: NULL</para>