diff options
| author | Ted Gould <ted@gould.cx> | 2011-02-24 16:01:21 -0600 |
|---|---|---|
| committer | Ted Gould <ted@gould.cx> | 2011-02-24 16:01:21 -0600 |
| commit | 7a1564e995770915a51c411a1856508db19206e9 (patch) | |
| tree | 08513a375dbcc01cd2ee27b6d833ce777c13131c /docs/reference | |
| parent | 596f48a0a0c29e683fb31bc837ff54b1b8ca7343 (diff) | |
| parent | d634d56953314f19911f4331b7e9a03f04f20b7f (diff) | |
| download | libayatana-appindicator-7a1564e995770915a51c411a1856508db19206e9.tar.gz libayatana-appindicator-7a1564e995770915a51c411a1856508db19206e9.tar.bz2 libayatana-appindicator-7a1564e995770915a51c411a1856508db19206e9.zip | |
Import upstream version 0.2.96
Diffstat (limited to 'docs/reference')
| -rw-r--r-- | docs/reference/html/annotation-glossary.html | 36 | ||||
| -rw-r--r-- | docs/reference/html/api-index-deprecated.html | 20 | ||||
| -rw-r--r-- | docs/reference/html/api-index-full.html | 24 | ||||
| -rw-r--r-- | docs/reference/html/ch01.html | 2 | ||||
| -rw-r--r-- | docs/reference/html/index.html | 1 | ||||
| -rw-r--r-- | docs/reference/html/index.sgml | 7 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator-app-indicator.html | 165 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator.devhelp | 7 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator.devhelp2 | 11 | ||||
| -rw-r--r-- | docs/reference/libappindicator-docs.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/libappindicator-sections.txt | 4 | ||||
| -rw-r--r-- | docs/reference/tmpl/app-indicator.sgml | 48 | ||||
| -rw-r--r-- | docs/reference/tmpl/libappindicator-unused.sgml | 36 | ||||
| -rw-r--r-- | docs/reference/version.xml | 2 | ||||
| -rw-r--r-- | docs/reference/xml/annotation-glossary.xml | 18 | ||||
| -rw-r--r-- | docs/reference/xml/api-index-deprecated.xml | 4 | ||||
| -rw-r--r-- | docs/reference/xml/api-index-full.xml | 6 | ||||
| -rw-r--r-- | docs/reference/xml/app-indicator.xml | 108 |
18 files changed, 474 insertions, 27 deletions
diff --git a/docs/reference/html/annotation-glossary.html b/docs/reference/html/annotation-glossary.html new file mode 100644 index 0000000..fca069b --- /dev/null +++ b/docs/reference/html/annotation-glossary.html @@ -0,0 +1,36 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Annotation Glossary</title> +<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<link rel="home" href="index.html" title="libappindicator Reference Manual"> +<link rel="up" href="index.html" title="libappindicator Reference Manual"> +<link rel="prev" href="api-index-deprecated.html" title="Deprecated API Index"> +<meta name="generator" content="GTK-Doc V1.16 (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="2"> +<tr valign="middle"> +<td><a accesskey="p" href="api-index-deprecated.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td> </td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> +<th width="100%" align="center">libappindicator Reference Manual</th> +<td> </td> +</tr> +<tr><td colspan="5" class="shortcuts"><a class="shortcut" href="#glsT">T</a></td></tr> +</table> +<div class="glossary"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="annotation-glossary"></a>Annotation Glossary</h2></div></div></div> +<a name="glsT"></a><h3 class="title">T</h3> +<dt> +<a name="annotation-glossterm-transfer%20none"></a>transfer none</dt> +<dd><p>Don't free data after the code is done.</p></dd> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.16</div> +</body> +</html>
\ No newline at end of file diff --git a/docs/reference/html/api-index-deprecated.html b/docs/reference/html/api-index-deprecated.html index 9f719b9..000de6f 100644 --- a/docs/reference/html/api-index-deprecated.html +++ b/docs/reference/html/api-index-deprecated.html @@ -7,21 +7,33 @@ <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="up" href="index.html" title="libappindicator Reference Manual"> <link rel="prev" href="api-index-full.html" title="API Index"> +<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> <meta name="generator" content="GTK-Doc V1.16 (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="2"><tr valign="middle"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> +<tr valign="middle"> <td><a accesskey="p" href="api-index-full.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> <td> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> <th width="100%" align="center">libappindicator Reference Manual</th> -<td> </td> -</tr></table> +<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"><a class="shortcut" href="#idxI">I</a></td></tr> +</table> <div class="index"> <div class="titlepage"><div><div><h2 class="title"> <a name="api-index-deprecated"></a>Deprecated API Index</h2></div></div></div> -<a name="idx"></a> +<a name="idx"></a><a name="idxI"></a><h3 class="title">I</h3> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon" title="app_indicator_set_attention_icon ()">app_indicator_set_attention_icon</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon" title="app_indicator_set_icon ()">app_indicator_set_icon</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> </div> <div class="footer"> <hr> diff --git a/docs/reference/html/api-index-full.html b/docs/reference/html/api-index-full.html index 69321b8..01647e6 100644 --- a/docs/reference/html/api-index-full.html +++ b/docs/reference/html/api-index-full.html @@ -63,6 +63,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-desc" title='The "attention-icon-desc" property'>AppIndicator:attention-icon-desc</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'>AppIndicator:attention-icon-name</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> @@ -79,6 +83,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-desc" title='The "icon-desc" property'>AppIndicator:icon-desc</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>AppIndicator:icon-name</a>, object property in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> @@ -135,6 +143,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-attention-icon-desc" title="app_indicator_get_attention_icon_desc ()">app_indicator_get_attention_icon_desc</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-category" title="app_indicator_get_category ()">app_indicator_get_category</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> @@ -147,6 +159,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-desc" title="app_indicator_get_icon_desc ()">app_indicator_get_icon_desc</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path" title="app_indicator_get_icon_theme_path ()">app_indicator_get_icon_theme_path</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> @@ -191,10 +207,18 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full" title="app_indicator_set_attention_icon_full ()">app_indicator_set_attention_icon_full</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon" title="app_indicator_set_icon ()">app_indicator_set_icon</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-full" title="app_indicator_set_icon_full ()">app_indicator_set_icon_full</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> +</dt> +<dd></dd> +<dt> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path" title="app_indicator_set_icon_theme_path ()">app_indicator_set_icon_theme_path</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html index 43af9ab..fc7fd09 100644 --- a/docs/reference/html/ch01.html +++ b/docs/reference/html/ch01.html @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="id539114"></a>Base Classes for Applications</h2></div></div></div> +<a name="id538329"></a>Base Classes for Applications</h2></div></div></div> <div class="toc"><dl><dt> <span class="refentrytitle"><a href="libappindicator-app-indicator.html">AppIndicator</a></span><span class="refpurpose"> — An object to put application information into the panel.</span> diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html index cd87fd4..ef6a0a0 100644 --- a/docs/reference/html/index.html +++ b/docs/reference/html/index.html @@ -29,6 +29,7 @@ <dt><span class="chapter"><a href="object-tree.html">Object Hierarchy</a></span></dt> <dt><span class="index"><a href="api-index-full.html">API Index</a></span></dt> <dt><span class="index"><a href="api-index-deprecated.html">Deprecated API Index</a></span></dt> +<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> </dl></div> </div> <div class="footer"> diff --git a/docs/reference/html/index.sgml b/docs/reference/html/index.sgml index a2dc5a5..0875f4f 100644 --- a/docs/reference/html/index.sgml +++ b/docs/reference/html/index.sgml @@ -38,8 +38,10 @@ <ANCHOR id="app-indicator-new-with-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-new-with-path"> <ANCHOR id="app-indicator-set-status" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-status"> <ANCHOR id="app-indicator-set-attention-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-attention-icon"> +<ANCHOR id="app-indicator-set-attention-icon-full" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-attention-icon-full"> <ANCHOR id="app-indicator-set-menu" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-menu"> <ANCHOR id="app-indicator-set-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-icon"> +<ANCHOR id="app-indicator-set-icon-full" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-icon-full"> <ANCHOR id="app-indicator-set-icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"> <ANCHOR id="app-indicator-set-label" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-label"> <ANCHOR id="app-indicator-set-ordering-index" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-ordering-index"> @@ -47,18 +49,22 @@ <ANCHOR id="app-indicator-get-category" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-category"> <ANCHOR id="app-indicator-get-status" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-status"> <ANCHOR id="app-indicator-get-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-icon"> +<ANCHOR id="app-indicator-get-icon-desc" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-icon-desc"> <ANCHOR id="app-indicator-get-icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"> <ANCHOR id="app-indicator-get-attention-icon" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-attention-icon"> +<ANCHOR id="app-indicator-get-attention-icon-desc" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-attention-icon-desc"> <ANCHOR id="app-indicator-get-menu" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-menu"> <ANCHOR id="app-indicator-get-label" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-label"> <ANCHOR id="app-indicator-get-label-guide" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-label-guide"> <ANCHOR id="app-indicator-get-ordering-index" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-ordering-index"> <ANCHOR id="app-indicator-build-menu-from-desktop" href="libappindicator/libappindicator-app-indicator.html#app-indicator-build-menu-from-desktop"> <ANCHOR id="libappindicator-app-indicator.property-details" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.property-details"> +<ANCHOR id="AppIndicator--attention-icon-desc" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--attention-icon-desc"> <ANCHOR id="AppIndicator--attention-icon-name" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--attention-icon-name"> <ANCHOR id="AppIndicator--category" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--category"> <ANCHOR id="AppIndicator--connected" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--connected"> <ANCHOR id="AppIndicator--dbus-menu-server" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--dbus-menu-server"> +<ANCHOR id="AppIndicator--icon-desc" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--icon-desc"> <ANCHOR id="AppIndicator--icon-name" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--icon-name"> <ANCHOR id="AppIndicator--icon-theme-path" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--icon-theme-path"> <ANCHOR id="AppIndicator--id" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--id"> @@ -74,3 +80,4 @@ <ANCHOR id="AppIndicator-new-label" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-label"> <ANCHOR id="AppIndicator-new-status" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-status"> <ANCHOR id="AppIndicator-scroll-event" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-scroll-event"> +<ANCHOR id="annotation-glossterm-transfer none" href="libappindicator/annotation-glossary.html#annotation-glossterm-transfer none"> diff --git a/docs/reference/html/libappindicator-app-indicator.html b/docs/reference/html/libappindicator-app-indicator.html index 93193b9..0b032b2 100644 --- a/docs/reference/html/libappindicator-app-indicator.html +++ b/docs/reference/html/libappindicator-app-indicator.html @@ -81,10 +81,17 @@ struct <a class="link" href="libappindicator-app-indicator.html#App <em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="type">AppIndicatorStatus</span></a> status</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon" title="app_indicator_set_attention_icon ()">app_indicator_set_attention_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full" title="app_indicator_set_attention_icon_full ()">app_indicator_set_attention_icon_full</a> + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_desc</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-menu" title="app_indicator_set_menu ()">app_indicator_set_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>); + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon" title="app_indicator_set_icon ()">app_indicator_set_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-full" title="app_indicator_set_icon_full ()">app_indicator_set_icon_full</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_desc</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path" title="app_indicator_set_icon_theme_path ()">app_indicator_set_icon_theme_path</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_theme_path</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-label" title="app_indicator_set_label ()">app_indicator_set_label</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, @@ -96,11 +103,15 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.htm <a class="link" href="libappindicator-app-indicator.html#AppIndicatorCategory" title="enum AppIndicatorCategory"><span class="returnvalue">AppIndicatorCategory</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-category" title="app_indicator_get_category ()">app_indicator_get_category</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); <a class="link" href="libappindicator-app-indicator.html#AppIndicatorStatus" title="enum AppIndicatorStatus"><span class="returnvalue">AppIndicatorStatus</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-status" title="app_indicator_get_status ()">app_indicator_get_status</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon" title="app_indicator_get_icon ()">app_indicator_get_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-desc" title="app_indicator_get_icon_desc ()">app_indicator_get_icon_desc</a> + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path" title="app_indicator_get_icon_theme_path ()">app_indicator_get_icon_theme_path</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-attention-icon" title="app_indicator_get_attention_icon ()">app_indicator_get_attention_icon</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); -<a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-menu" title="app_indicator_get_menu ()">app_indicator_get_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-attention-icon-desc" title="app_indicator_get_attention_icon_desc ()">app_indicator_get_attention_icon_desc</a> + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +<a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-menu" title="app_indicator_get_menu ()">app_indicator_get_menu</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label" title="app_indicator_get_label ()">app_indicator_get_label</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-label-guide" title="app_indicator_get_label_guide ()">app_indicator_get_label_guide</a> @@ -122,11 +133,13 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.htm <div class="refsect1"> <a name="libappindicator-app-indicator.properties"></a><h2>Properties</h2> <pre class="synopsis"> + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-desc" title='The "attention-icon-desc" property'>attention-icon-desc</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'>attention-icon-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--category" title='The "category" property'>category</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--connected" title='The "connected" property'>connected</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--dbus-menu-server" title='The "dbus-menu-server" property'>dbus-menu-server</a>" <a href="/usr/share/gtk-doc/html/libdbusmenu-glib/libdbusmenu-glib-DbusmenuServer.html#DbusmenuServer"><span class="type">DbusmenuServer</span></a>* : Read / Write - "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>icon-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-desc" title='The "icon-desc" property'>icon-desc</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write + "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'>icon-name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-theme-path" title='The "icon-theme-path" property'>icon-theme-path</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--id" title='The "id" property'>id</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct Only "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write @@ -512,7 +525,7 @@ The signals and external functions that make up the <a class="link" href="libapp </tr> <tr> <td><p><span class="term"><em class="structfield"><code><a name="AppIndicatorClass.fallback"></a>fallback</code></em> ()</span></p></td> -<td>Function that gets called to make a <a href="http://library.gnome.org/devel/gtk/2.22/GtkStatusIcon.html"><span class="type">GtkStatusIcon</span></a> when +<td>Function that gets called to make a <a href="http://library.gnome.org/devel/gtk/2.24/GtkStatusIcon.html"><span class="type">GtkStatusIcon</span></a> when there is no Application Indicator area available.</td> </tr> <tr> @@ -662,6 +675,35 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato <a name="app-indicator-set-attention-icon"></a><h3>app_indicator_set_attention_icon ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_attention_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> +<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Warning</h3> +<p><code class="literal">app_indicator_set_attention_icon</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full" title="app_indicator_set_attention_icon_full ()"><code class="function">app_indicator_set_attention_icon_full()</code></a> instead.</p> +</div> +<p> +Wrapper for <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full" title="app_indicator_set_attention_icon_full ()"><code class="function">app_indicator_set_attention_icon_full()</code></a> with a NULL + description. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The name of the attention icon to set for this indicator</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="app-indicator-set-attention-icon-full"></a><h3>app_indicator_set_attention_icon_full ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_attention_icon_full + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_desc</code></em>);</pre> <p> Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-name" title='The "attention-icon-name" property'><span class="type">"attention-icon-name"</span></a>. </p> @@ -676,6 +718,10 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato <td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> <td>The name of the attention icon to set for this indicator</td> </tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_desc</code></em> :</span></p></td> +<td>A textual description of the icon</td> +</tr> </tbody> </table></div> </div> @@ -683,7 +729,7 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato <div class="refsect2"> <a name="app-indicator-set-menu"></a><h3>app_indicator_set_menu ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, - <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre> + <em class="parameter"><code><a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="type">GtkMenu</span></a> *menu</code></em>);</pre> <p> Sets the menu that should be shown when the Application Indicator is clicked on in the panel. An application indicator will not @@ -701,7 +747,7 @@ Sets the menu that should be shown when the Application Indicator </tr> <tr> <td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td> -<td>A <a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="type">GtkMenu</span></a> to set</td> +<td>A <a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="type">GtkMenu</span></a> to set</td> </tr> </tbody> </table></div> @@ -711,11 +757,42 @@ Sets the menu that should be shown when the Application Indicator <a name="app-indicator-set-icon"></a><h3>app_indicator_set_icon ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_icon (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>);</pre> +<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"> +<h3 class="title">Warning</h3> +<p><code class="literal">app_indicator_set_icon</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-full" title="app_indicator_set_icon_full ()"><code class="function">app_indicator_set_icon_full()</code></a></p> +</div> +<p> +Wrapper function for <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-icon-full" title="app_indicator_set_icon_full ()"><code class="function">app_indicator_set_icon_full()</code></a> with a NULL + description. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> +<td>The icon name to set.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="app-indicator-set-icon-full"></a><h3>app_indicator_set_icon_full ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_icon_full (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_name</code></em>, + <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *icon_desc</code></em>);</pre> <p> 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 <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a>. +</p> +<p> + Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-name" title='The "icon-name" property'><span class="type">"icon-name"</span></a> and + <span class="type">"icon-description"</span>. </p> <div class="variablelist"><table border="0"> <col align="left" valign="top"> @@ -728,6 +805,10 @@ Sets the default icon to use when the status is active but <td><p><span class="term"><em class="parameter"><code>icon_name</code></em> :</span></p></td> <td>The icon name to set.</td> </tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>icon_desc</code></em> :</span></p></td> +<td>A textual description of the icon for accessibility</td> +</tr> </tbody> </table></div> </div> @@ -896,6 +977,28 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato </div> <hr> <div class="refsect2"> +<a name="app-indicator-get-icon-desc"></a><h3>app_indicator_get_icon_desc ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_icon_desc + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<p> +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--icon-desc" title='The "icon-desc" property'><span class="type">"icon-desc"</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The current icon description.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="app-indicator-get-icon-theme-path"></a><h3>app_indicator_get_icon_theme_path ()</h3> <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_icon_theme_path (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> @@ -940,8 +1043,30 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato </div> <hr> <div class="refsect2"> +<a name="app-indicator-get-attention-icon-desc"></a><h3>app_indicator_get_attention_icon_desc ()</h3> +<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * app_indicator_get_attention_icon_desc + (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<p> +Wrapper function for property <a class="link" href="libappindicator-app-indicator.html#AppIndicator--attention-icon-desc" title='The "attention-icon-desc" property'><span class="type">"attention-icon-desc"</span></a>. +</p> +<div class="variablelist"><table border="0"> +<col align="left" valign="top"> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td> +<td>The <a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> object to use</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>The current attention icon description.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="app-indicator-get-menu"></a><h3>app_indicator_get_menu ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * app_indicator_get_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> +<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="returnvalue">GtkMenu</span></a> * app_indicator_get_menu (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> Gets the menu being used for this application indicator. Wrapper function for property <span class="type">"menu"</span>. @@ -955,7 +1080,8 @@ Gets the menu being used for this application indicator. </tr> <tr> <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>A <a href="http://library.gnome.org/devel/gtk/2.22/GtkMenu.html"><span class="type">GtkMenu</span></a> object or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if one hasn't been set.</td> +<td>A <a href="http://library.gnome.org/devel/gtk/2.24/GtkMenu.html"><span class="type">GtkMenu</span></a> object or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if one hasn't been set. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span> +</td> </tr> </tbody> </table></div> @@ -1058,6 +1184,16 @@ This function allows for building the Application Indicator menu <div class="refsect1"> <a name="libappindicator-app-indicator.property-details"></a><h2>Property Details</h2> <div class="refsect2"> +<a name="AppIndicator--attention-icon-desc"></a><h3>The <code class="literal">"attention-icon-desc"</code> property</h3> +<pre class="programlisting"> "attention-icon-desc" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +If the indicator sets it's status to <a class="link" href="libappindicator-app-indicator.html#APP-INDICATOR-STATUS-ATTENTION:CAPS"><code class="literal">APP_INDICATOR_STATUS_ATTENTION</code></a> + then this textual description of the icon shown. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> <a name="AppIndicator--attention-icon-name"></a><h3>The <code class="literal">"attention-icon-name"</code> property</h3> <pre class="programlisting"> "attention-icon-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> @@ -1097,8 +1233,17 @@ A way to get the internal dbusmenu server if it is available. </div> <hr> <div class="refsect2"> +<a name="AppIndicator--icon-desc"></a><h3>The <code class="literal">"icon-desc"</code> property</h3> +<pre class="programlisting"> "icon-desc" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +The description of the regular icon that is shown for the indicator. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> <a name="AppIndicator--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3> -<pre class="programlisting"> "icon-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write / Construct</pre> +<pre class="programlisting"> "icon-name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> <p> The name of the regular icon that is shown for the indicator. </p> diff --git a/docs/reference/html/libappindicator.devhelp b/docs/reference/html/libappindicator.devhelp index a695026..fe5a1ef 100644 --- a/docs/reference/html/libappindicator.devhelp +++ b/docs/reference/html/libappindicator.devhelp @@ -8,6 +8,7 @@ <sub name="Object Hierarchy" link="object-tree.html"/> <sub name="API Index" link="api-index-full.html"/> <sub name="Deprecated API Index" link="api-index-deprecated.html"/> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> </chapters> <functions> <function name="APP_INDICATOR_TYPE" link="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS"/> @@ -33,8 +34,10 @@ <function name="app_indicator_new_with_path ()" link="libappindicator-app-indicator.html#app-indicator-new-with-path"/> <function name="app_indicator_set_status ()" link="libappindicator-app-indicator.html#app-indicator-set-status"/> <function name="app_indicator_set_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon"/> + <function name="app_indicator_set_attention_icon_full ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full"/> <function name="app_indicator_set_menu ()" link="libappindicator-app-indicator.html#app-indicator-set-menu"/> <function name="app_indicator_set_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-icon"/> + <function name="app_indicator_set_icon_full ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-full"/> <function name="app_indicator_set_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"/> <function name="app_indicator_set_label ()" link="libappindicator-app-indicator.html#app-indicator-set-label"/> <function name="app_indicator_set_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-set-ordering-index"/> @@ -42,17 +45,21 @@ <function name="app_indicator_get_category ()" link="libappindicator-app-indicator.html#app-indicator-get-category"/> <function name="app_indicator_get_status ()" link="libappindicator-app-indicator.html#app-indicator-get-status"/> <function name="app_indicator_get_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-icon"/> + <function name="app_indicator_get_icon_desc ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-desc"/> <function name="app_indicator_get_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"/> <function name="app_indicator_get_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon"/> + <function name="app_indicator_get_attention_icon_desc ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon-desc"/> <function name="app_indicator_get_menu ()" link="libappindicator-app-indicator.html#app-indicator-get-menu"/> <function name="app_indicator_get_label ()" link="libappindicator-app-indicator.html#app-indicator-get-label"/> <function name="app_indicator_get_label_guide ()" link="libappindicator-app-indicator.html#app-indicator-get-label-guide"/> <function name="app_indicator_get_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-get-ordering-index"/> <function name="app_indicator_build_menu_from_desktop ()" link="libappindicator-app-indicator.html#app-indicator-build-menu-from-desktop"/> + <function name="The "attention-icon-desc" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-desc"/> <function name="The "attention-icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-name"/> <function name="The "category" property" link="libappindicator-app-indicator.html#AppIndicator--category"/> <function name="The "connected" property" link="libappindicator-app-indicator.html#AppIndicator--connected"/> <function name="The "dbus-menu-server" property" link="libappindicator-app-indicator.html#AppIndicator--dbus-menu-server"/> + <function name="The "icon-desc" property" link="libappindicator-app-indicator.html#AppIndicator--icon-desc"/> <function name="The "icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--icon-name"/> <function name="The "icon-theme-path" property" link="libappindicator-app-indicator.html#AppIndicator--icon-theme-path"/> <function name="The "id" property" link="libappindicator-app-indicator.html#AppIndicator--id"/> diff --git a/docs/reference/html/libappindicator.devhelp2 b/docs/reference/html/libappindicator.devhelp2 index d6b0066..516ae2a 100644 --- a/docs/reference/html/libappindicator.devhelp2 +++ b/docs/reference/html/libappindicator.devhelp2 @@ -8,6 +8,7 @@ <sub name="Object Hierarchy" link="object-tree.html"/> <sub name="API Index" link="api-index-full.html"/> <sub name="Deprecated API Index" link="api-index-deprecated.html"/> + <sub name="Annotation Glossary" link="annotation-glossary.html"/> </chapters> <functions> <keyword type="macro" name="APP_INDICATOR_TYPE" link="libappindicator-app-indicator.html#APP-INDICATOR-TYPE:CAPS"/> @@ -32,9 +33,11 @@ <keyword type="function" name="app_indicator_new ()" link="libappindicator-app-indicator.html#app-indicator-new"/> <keyword type="function" name="app_indicator_new_with_path ()" link="libappindicator-app-indicator.html#app-indicator-new-with-path"/> <keyword type="function" name="app_indicator_set_status ()" link="libappindicator-app-indicator.html#app-indicator-set-status"/> - <keyword type="function" name="app_indicator_set_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon"/> + <keyword type="function" name="app_indicator_set_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon" deprecated="Use app_indicator_set_attention_icon_full() instead."/> + <keyword type="function" name="app_indicator_set_attention_icon_full ()" link="libappindicator-app-indicator.html#app-indicator-set-attention-icon-full"/> <keyword type="function" name="app_indicator_set_menu ()" link="libappindicator-app-indicator.html#app-indicator-set-menu"/> - <keyword type="function" name="app_indicator_set_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-icon"/> + <keyword type="function" name="app_indicator_set_icon ()" link="libappindicator-app-indicator.html#app-indicator-set-icon" deprecated="Use app_indicator_set_icon_full()"/> + <keyword type="function" name="app_indicator_set_icon_full ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-full"/> <keyword type="function" name="app_indicator_set_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-set-icon-theme-path"/> <keyword type="function" name="app_indicator_set_label ()" link="libappindicator-app-indicator.html#app-indicator-set-label"/> <keyword type="function" name="app_indicator_set_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-set-ordering-index"/> @@ -42,17 +45,21 @@ <keyword type="function" name="app_indicator_get_category ()" link="libappindicator-app-indicator.html#app-indicator-get-category"/> <keyword type="function" name="app_indicator_get_status ()" link="libappindicator-app-indicator.html#app-indicator-get-status"/> <keyword type="function" name="app_indicator_get_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-icon"/> + <keyword type="function" name="app_indicator_get_icon_desc ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-desc"/> <keyword type="function" name="app_indicator_get_icon_theme_path ()" link="libappindicator-app-indicator.html#app-indicator-get-icon-theme-path"/> <keyword type="function" name="app_indicator_get_attention_icon ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon"/> + <keyword type="function" name="app_indicator_get_attention_icon_desc ()" link="libappindicator-app-indicator.html#app-indicator-get-attention-icon-desc"/> <keyword type="function" name="app_indicator_get_menu ()" link="libappindicator-app-indicator.html#app-indicator-get-menu"/> <keyword type="function" name="app_indicator_get_label ()" link="libappindicator-app-indicator.html#app-indicator-get-label"/> <keyword type="function" name="app_indicator_get_label_guide ()" link="libappindicator-app-indicator.html#app-indicator-get-label-guide"/> <keyword type="function" name="app_indicator_get_ordering_index ()" link="libappindicator-app-indicator.html#app-indicator-get-ordering-index"/> <keyword type="function" name="app_indicator_build_menu_from_desktop ()" link="libappindicator-app-indicator.html#app-indicator-build-menu-from-desktop"/> + <keyword type="property" name="The "attention-icon-desc" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-desc"/> <keyword type="property" name="The "attention-icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--attention-icon-name"/> <keyword type="property" name="The "category" property" link="libappindicator-app-indicator.html#AppIndicator--category"/> <keyword type="property" name="The "connected" property" link="libappindicator-app-indicator.html#AppIndicator--connected"/> <keyword type="property" name="The "dbus-menu-server" property" link="libappindicator-app-indicator.html#AppIndicator--dbus-menu-server"/> + <keyword type="property" name="The "icon-desc" property" link="libappindicator-app-indicator.html#AppIndicator--icon-desc"/> <keyword type="property" name="The "icon-name" property" link="libappindicator-app-indicator.html#AppIndicator--icon-name"/> <keyword type="property" name="The "icon-theme-path" property" link="libappindicator-app-indicator.html#AppIndicator--icon-theme-path"/> <keyword type="property" name="The "id" property" link="libappindicator-app-indicator.html#AppIndicator--id"/> diff --git a/docs/reference/libappindicator-docs.sgml b/docs/reference/libappindicator-docs.sgml index 4a29d2b..a749a68 100644 --- a/docs/reference/libappindicator-docs.sgml +++ b/docs/reference/libappindicator-docs.sgml @@ -8,7 +8,7 @@ <bookinfo> <title>libappindicator Reference Manual</title> <releaseinfo> - for libappindicator 0.2.95 + for libappindicator 0.2.96 </releaseinfo> </bookinfo> diff --git a/docs/reference/libappindicator-sections.txt b/docs/reference/libappindicator-sections.txt index 536e355..da05f40 100644 --- a/docs/reference/libappindicator-sections.txt +++ b/docs/reference/libappindicator-sections.txt @@ -24,8 +24,10 @@ app_indicator_new app_indicator_new_with_path app_indicator_set_status app_indicator_set_attention_icon +app_indicator_set_attention_icon_full app_indicator_set_menu app_indicator_set_icon +app_indicator_set_icon_full app_indicator_set_icon_theme_path app_indicator_set_label app_indicator_set_ordering_index @@ -33,8 +35,10 @@ app_indicator_get_id app_indicator_get_category app_indicator_get_status app_indicator_get_icon +app_indicator_get_icon_desc app_indicator_get_icon_theme_path app_indicator_get_attention_icon +app_indicator_get_attention_icon_desc app_indicator_get_menu app_indicator_get_label app_indicator_get_label_guide diff --git a/docs/reference/tmpl/app-indicator.sgml b/docs/reference/tmpl/app-indicator.sgml index 1027d41..cebd2eb 100644 --- a/docs/reference/tmpl/app-indicator.sgml +++ b/docs/reference/tmpl/app-indicator.sgml @@ -204,6 +204,11 @@ AppIndicator @arg1: @arg2: +<!-- ##### ARG AppIndicator:attention-icon-desc ##### --> +<para> + +</para> + <!-- ##### ARG AppIndicator:attention-icon-name ##### --> <para> @@ -224,6 +229,11 @@ AppIndicator </para> +<!-- ##### ARG AppIndicator:icon-desc ##### --> +<para> + +</para> + <!-- ##### ARG AppIndicator:icon-name ##### --> <para> @@ -332,6 +342,16 @@ AppIndicator @icon_name: +<!-- ##### FUNCTION app_indicator_set_attention_icon_full ##### --> +<para> + +</para> + +@self: +@icon_name: +@icon_desc: + + <!-- ##### FUNCTION app_indicator_set_menu ##### --> <para> @@ -350,6 +370,16 @@ AppIndicator @icon_name: +<!-- ##### FUNCTION app_indicator_set_icon_full ##### --> +<para> + +</para> + +@self: +@icon_name: +@icon_desc: + + <!-- ##### FUNCTION app_indicator_set_icon_theme_path ##### --> <para> @@ -414,6 +444,15 @@ AppIndicator @Returns: +<!-- ##### FUNCTION app_indicator_get_icon_desc ##### --> +<para> + +</para> + +@self: +@Returns: + + <!-- ##### FUNCTION app_indicator_get_icon_theme_path ##### --> <para> @@ -432,6 +471,15 @@ AppIndicator @Returns: +<!-- ##### FUNCTION app_indicator_get_attention_icon_desc ##### --> +<para> + +</para> + +@self: +@Returns: + + <!-- ##### FUNCTION app_indicator_get_menu ##### --> <para> diff --git a/docs/reference/tmpl/libappindicator-unused.sgml b/docs/reference/tmpl/libappindicator-unused.sgml index 1428b51..789a03f 100644 --- a/docs/reference/tmpl/libappindicator-unused.sgml +++ b/docs/reference/tmpl/libappindicator-unused.sgml @@ -1,6 +1,42 @@ +<!-- ##### MACRO APP_INDICATOR_SIGNAL_NEW_ACCESSIBLE_DESC ##### --> +<para> + +</para> + + +<!-- ##### SIGNAL AppIndicator::new-accessible-desc ##### --> +<para> + +</para> + +@appindicator: the object which received the signal. +@arg1: + +<!-- ##### ARG AppIndicator:accessible-desc ##### --> +<para> + +</para> + + <!-- ##### ARG AppIndicator:icon-path ##### --> <para> </para> +<!-- ##### FUNCTION app_indicator_get_accessible_desc ##### --> +<para> + +</para> + +@self: +@Returns: + +<!-- ##### FUNCTION app_indicator_set_accessible_desc ##### --> +<para> + +</para> + +@self: +@accessible_desc: + diff --git a/docs/reference/version.xml b/docs/reference/version.xml index 7ed9fbf..27feebe 100644 --- a/docs/reference/version.xml +++ b/docs/reference/version.xml @@ -1 +1 @@ -0.2.95 +0.2.96 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> + "<link linkend="AppIndicator--attention-icon-desc">attention-icon-desc</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write "<link linkend="AppIndicator--attention-icon-name">attention-icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write "<link linkend="AppIndicator--category">category</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only "<link linkend="AppIndicator--connected">connected</link>" <link linkend="gboolean"><type>gboolean</type></link> : Read "<link linkend="AppIndicator--dbus-menu-server">dbus-menu-server</link>" <link linkend="DbusmenuServer"><type>DbusmenuServer</type></link>* : Read / Write - "<link linkend="AppIndicator--icon-name">icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct + "<link linkend="AppIndicator--icon-desc">icon-desc</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--icon-name">icon-name</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write "<link linkend="AppIndicator--icon-theme-path">icon-theme-path</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct "<link linkend="AppIndicator--id">id</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct Only "<link linkend="AppIndicator--label">label</link>" <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> :</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> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</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> :</term> <listitem><simpara>The name of the attention icon to set for this indicator</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_desc</parameter> :</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> :</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> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_name</parameter> :</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> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> <varlistentry><term><parameter>icon_name</parameter> :</term> <listitem><simpara>The icon name to set.</simpara></listitem></varlistentry> +<varlistentry><term><parameter>icon_desc</parameter> :</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> :</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> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</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> :</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> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> +<varlistentry><term><emphasis>Returns</emphasis> :</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> :</term> <listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link> object to use</simpara></listitem></varlistentry> -<varlistentry><term><emphasis>Returns</emphasis> :</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> :</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>"attention-icon-desc"</literal> property</title> +<indexterm zone="AppIndicator--attention-icon-desc"><primary>AppIndicator:attention-icon-desc</primary></indexterm> +<programlisting> "attention-icon-desc" <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>"attention-icon-name"</literal> property</title> <indexterm zone="AppIndicator--attention-icon-name"><primary>AppIndicator:attention-icon-name</primary></indexterm> <programlisting> "attention-icon-name" <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>"icon-desc"</literal> property</title> +<indexterm zone="AppIndicator--icon-desc"><primary>AppIndicator:icon-desc</primary></indexterm> +<programlisting> "icon-desc" <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>"icon-name"</literal> property</title> <indexterm zone="AppIndicator--icon-name"><primary>AppIndicator:icon-name</primary></indexterm> -<programlisting> "icon-name" <link linkend="gchar"><type>gchar</type></link>* : Read / Write / Construct</programlisting> +<programlisting> "icon-name" <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> |