diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile.in | 2 | ||||
| -rw-r--r-- | docs/reference/Makefile.in | 2 | ||||
| -rw-r--r-- | docs/reference/html/annotation-glossary.html | 2 | ||||
| -rw-r--r-- | docs/reference/html/api-index-deprecated.html | 2 | ||||
| -rw-r--r-- | docs/reference/html/api-index-full.html | 14 | ||||
| -rw-r--r-- | docs/reference/html/ch01.html | 4 | ||||
| -rw-r--r-- | docs/reference/html/index.html | 4 | ||||
| -rw-r--r-- | docs/reference/html/index.sgml | 3 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator-app-indicator.html | 98 | ||||
| -rw-r--r-- | docs/reference/html/libappindicator.devhelp2 | 3 | ||||
| -rw-r--r-- | docs/reference/html/object-tree.html | 2 | ||||
| -rw-r--r-- | docs/reference/libappindicator-docs.sgml | 2 | ||||
| -rw-r--r-- | docs/reference/libappindicator-sections.txt | 2 | ||||
| -rw-r--r-- | docs/reference/tmpl/app-indicator.sgml | 23 | ||||
| -rw-r--r-- | docs/reference/version.xml | 2 | ||||
| -rw-r--r-- | docs/reference/xml/api-index-full.xml | 3 | ||||
| -rw-r--r-- | docs/reference/xml/app-indicator.xml | 65 |
17 files changed, 212 insertions, 21 deletions
diff --git a/docs/Makefile.in b/docs/Makefile.in index 427dfb9..fed9b92 100644 --- a/docs/Makefile.in +++ b/docs/Makefile.in @@ -174,6 +174,8 @@ MANIFEST_TOOL = @MANIFEST_TOOL@ MKDIR_P = @MKDIR_P@ MONO_DEPENDENCY_CFLAGS = @MONO_DEPENDENCY_CFLAGS@ MONO_DEPENDENCY_LIBS = @MONO_DEPENDENCY_LIBS@ +MONO_NUNIT_CFLAGS = @MONO_NUNIT_CFLAGS@ +MONO_NUNIT_LIBS = @MONO_NUNIT_LIBS@ NM = @NM@ NMEDIT = @NMEDIT@ NUNIT_CFLAGS = @NUNIT_CFLAGS@ diff --git a/docs/reference/Makefile.in b/docs/reference/Makefile.in index c7f0aba..a95d9ac 100644 --- a/docs/reference/Makefile.in +++ b/docs/reference/Makefile.in @@ -144,6 +144,8 @@ MANIFEST_TOOL = @MANIFEST_TOOL@ MKDIR_P = @MKDIR_P@ MONO_DEPENDENCY_CFLAGS = @MONO_DEPENDENCY_CFLAGS@ MONO_DEPENDENCY_LIBS = @MONO_DEPENDENCY_LIBS@ +MONO_NUNIT_CFLAGS = @MONO_NUNIT_CFLAGS@ +MONO_NUNIT_LIBS = @MONO_NUNIT_LIBS@ NM = @NM@ NMEDIT = @NMEDIT@ NUNIT_CFLAGS = @NUNIT_CFLAGS@ diff --git a/docs/reference/html/annotation-glossary.html b/docs/reference/html/annotation-glossary.html index 21deae6..cc7c522 100644 --- a/docs/reference/html/annotation-glossary.html +++ b/docs/reference/html/annotation-glossary.html @@ -3,7 +3,7 @@ <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"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <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"> diff --git a/docs/reference/html/api-index-deprecated.html b/docs/reference/html/api-index-deprecated.html index 6378506..ce7d666 100644 --- a/docs/reference/html/api-index-deprecated.html +++ b/docs/reference/html/api-index-deprecated.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Deprecated API Index</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <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"> diff --git a/docs/reference/html/api-index-full.html b/docs/reference/html/api-index-full.html index f948556..8e656d3 100644 --- a/docs/reference/html/api-index-full.html +++ b/docs/reference/html/api-index-full.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>API Index</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="up" href="index.html" title="libappindicator Reference Manual"> <link rel="prev" href="object-tree.html" title="Object Hierarchy"> @@ -115,6 +115,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#AppIndicator--title" title='The "title" property'>AppIndicator:title</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#AppIndicatorCategory" title="enum AppIndicatorCategory">AppIndicatorCategory</a>, enum in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> </dt> <dd></dd> @@ -195,6 +199,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-get-title" title="app_indicator_get_title ()">app_indicator_get_title</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-type" title="app_indicator_get_type ()">app_indicator_get_type</a>, function in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">AppIndicator</a> </dt> <dd></dd> @@ -247,6 +255,10 @@ </dt> <dd></dd> <dt> +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-title" title="app_indicator_set_title ()">app_indicator_set_title</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-SIGNAL-CONNECTION-CHANGED:CAPS" title="APP_INDICATOR_SIGNAL_CONNECTION_CHANGED">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</a>, macro in <a class="link" href="libappindicator-app-indicator.html" title="AppIndicator">app-indicator</a> </dt> <dd></dd> diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html index 1b565c8..b9420d3 100644 --- a/docs/reference/html/ch01.html +++ b/docs/reference/html/ch01.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Base Classes for Applications</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="up" href="index.html" title="libappindicator Reference Manual"> <link rel="prev" href="index.html" title="libappindicator Reference Manual"> @@ -21,7 +21,7 @@ </tr></table> <div class="chapter"> <div class="titlepage"><div><div><h2 class="title"> -<a name="idp2827248"></a>Base Classes for Applications</h2></div></div></div> +<a name="idp4399600"></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 d2de696..c288fd2 100644 --- a/docs/reference/html/index.html +++ b/docs/reference/html/index.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>libappindicator Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="next" href="ch01.html" title="Base Classes for Applications"> <meta name="generator" content="GTK-Doc V1.18 (XML mode)"> @@ -15,7 +15,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libappindicator Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for libappindicator 0.4.1 + for libappindicator 0.4.90 </p></div> </div> <hr> diff --git a/docs/reference/html/index.sgml b/docs/reference/html/index.sgml index 0dd5e0b..b9672cd 100644 --- a/docs/reference/html/index.sgml +++ b/docs/reference/html/index.sgml @@ -46,6 +46,7 @@ <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"> <ANCHOR id="app-indicator-set-secondary-activate-target" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-secondary-activate-target"> +<ANCHOR id="app-indicator-set-title" href="libappindicator/libappindicator-app-indicator.html#app-indicator-set-title"> <ANCHOR id="app-indicator-get-id" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-id"> <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"> @@ -59,6 +60,7 @@ <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-get-secondary-activate-target" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-secondary-activate-target"> +<ANCHOR id="app-indicator-get-title" href="libappindicator/libappindicator-app-indicator.html#app-indicator-get-title"> <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"> @@ -74,6 +76,7 @@ <ANCHOR id="AppIndicator--label-guide" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--label-guide"> <ANCHOR id="AppIndicator--ordering-index" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--ordering-index"> <ANCHOR id="AppIndicator--status" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--status"> +<ANCHOR id="AppIndicator--title" href="libappindicator/libappindicator-app-indicator.html#AppIndicator--title"> <ANCHOR id="libappindicator-app-indicator.signal-details" href="libappindicator/libappindicator-app-indicator.html#libappindicator-app-indicator.signal-details"> <ANCHOR id="AppIndicator-connection-changed" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-connection-changed"> <ANCHOR id="AppIndicator-new-attention-icon" href="libappindicator/libappindicator-app-indicator.html#AppIndicator-new-attention-icon"> diff --git a/docs/reference/html/libappindicator-app-indicator.html b/docs/reference/html/libappindicator-app-indicator.html index 1be48b8..e03d727 100644 --- a/docs/reference/html/libappindicator-app-indicator.html +++ b/docs/reference/html/libappindicator-app-indicator.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>AppIndicator</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="up" href="ch01.html" title="Base Classes for Applications"> <link rel="prev" href="ch01.html" title="Base Classes for Applications"> @@ -98,10 +98,12 @@ struct <a class="link" href="libappindicator-app-indicator.html#App <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> *label</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> *guide</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-ordering-index" title="app_indicator_set_ordering_index ()">app_indicator_set_ordering_index</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/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ordering_index</code></em>); + <em class="parameter"><code><span class="type">guint32</span> ordering_index</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-secondary-activate-target" title="app_indicator_set_secondary_activate_target ()">app_indicator_set_secondary_activate_target</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/GtkWidget.html"><span class="type">GtkWidget</span></a> *menuitem</code></em>); +<span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-set-title" title="app_indicator_set_title ()">app_indicator_set_title</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> *title</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-id" title="app_indicator_get_id ()">app_indicator_get_id</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#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>); @@ -114,9 +116,10 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.htm <a href="http://library.gnome.org/devel/gtk/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> (<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/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-ordering-index" title="app_indicator_get_ordering_index ()">app_indicator_get_ordering_index</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); +<span class="returnvalue">guint32</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-ordering-index" title="app_indicator_get_ordering_index ()">app_indicator_get_ordering_index</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/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="libappindicator-app-indicator.html#app-indicator-get-secondary-activate-target" title="app_indicator_get_secondary_activate_target ()">app_indicator_get_secondary_activate_target</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-title" title="app_indicator_get_title ()">app_indicator_get_title</a> (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>); <span class="returnvalue">void</span> <a class="link" href="libappindicator-app-indicator.html#app-indicator-build-menu-from-desktop" title="app_indicator_build_menu_from_desktop ()">app_indicator_build_menu_from_desktop</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> *desktop_file</code></em>, @@ -146,6 +149,7 @@ const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.htm "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--label-guide" title='The "label-guide" property'>label-guide</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--ordering-index" title='The "ordering-index" property'>ordering-index</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write "<a class="link" href="libappindicator-app-indicator.html#AppIndicator--status" title='The "status" property'>status</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--title" title='The "title" property'>title</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write </pre> </div> <div class="refsect1"> @@ -431,8 +435,15 @@ Private Fields <a name="AppIndicator-struct"></a><h3>AppIndicator</h3> <pre class="programlisting">typedef struct _AppIndicator AppIndicator;</pre> <p> -Whether the indicator is shown or requests attention. Defaults to -'Passive'. +A application indicator represents the values that are needed to show a +unique status in the panel for an application. In general, applications +should try to fit in the other indicators that are available on the +panel before using this. But, sometimes it is necissary. +</p> +<p> + Private fields +<em class="parameter"><code>parent</code></em>: Parent object. +<em class="parameter"><code>priv</code></em>: Internal data. </p> </div> <hr> @@ -874,7 +885,7 @@ as either <em class="parameter"><code>label</code></em> or <em class="parameter" <div class="refsect2"> <a name="app-indicator-set-ordering-index"></a><h3>app_indicator_set_ordering_index ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_ordering_index (<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/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> ordering_index</code></em>);</pre> + <em class="parameter"><code><span class="type">guint32</span> ordering_index</code></em>);</pre> <p> Sets the ordering index for the app indicator which effects the placement of it on the panel. For almost all app indicator @@ -934,6 +945,40 @@ Setting <em class="parameter"><code>menuitem</code></em> to <a href="http://libr </div> <hr> <div class="refsect2"> +<a name="app-indicator-set-title"></a><h3>app_indicator_set_title ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> app_indicator_set_title (<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> *title</code></em>);</pre> +<p> +Sets the title of the application indicator, or how it should be referred +in a human readable form. This string should be UTF-8 and localized as it +expected that users will set it. +</p> +<p> +In the Unity desktop the most prominent place that this is show will be +in the HUD. HUD listings for this application indicator will start with +the title as the first part of the line for the menu items. +</p> +<p> +Setting <em class="parameter"><code>title</code></em> to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> removes the title. +</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> +</td> +</tr> +<tr> +<td><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td> +<td>Title of the app indicator. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="app-indicator-get-id"></a><h3>app_indicator_get_id ()</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_id (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>);</pre> <p> @@ -1169,7 +1214,7 @@ Wrapper function for property <a class="link" href="libappindicator-app-indicato <hr> <div class="refsect2"> <a name="app-indicator-get-ordering-index"></a><h3>app_indicator_get_ordering_index ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> app_indicator_get_ordering_index (<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"><span class="returnvalue">guint32</span> app_indicator_get_ordering_index (<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--ordering-index" title='The "ordering-index" property'><span class="type">"ordering-index"</span></a>. </p> @@ -1212,6 +1257,28 @@ Gets the menuitem being called on secondary-activate event. </div> <hr> <div class="refsect2"> +<a name="app-indicator-get-title"></a><h3>app_indicator_get_title ()</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_title (<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 title of the application indicator. See the function +<a class="link" href="libappindicator-app-indicator.html#app-indicator-set-title" title="app_indicator_set_title ()"><code class="function">app_indicator_set_title()</code></a> for information on the title. +</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 title.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> <a name="app-indicator-build-menu-from-desktop"></a><h3>app_indicator_build_menu_from_desktop ()</h3> <pre class="programlisting"><span class="returnvalue">void</span> app_indicator_build_menu_from_desktop (<em class="parameter"><code><a class="link" href="libappindicator-app-indicator.html#AppIndicator"><span class="type">AppIndicator</span></a> *self</code></em>, @@ -1377,7 +1444,22 @@ in case you do, this is the way. <div class="refsect2"> <a name="AppIndicator--status"></a><h3>The <code class="literal">"status"</code> property</h3> <pre class="programlisting"> "status" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> -<p>Whether the indicator is shown or requests attention. Defaults to 'Passive'.</p> +<p> +Whether the indicator is shown or requests attention. Defaults to +'Passive'. +</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="AppIndicator--title"></a><h3>The <code class="literal">"title"</code> property</h3> +<pre class="programlisting"> "title" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre> +<p> +Provides a way to refer to this application indicator in a human +readable form. This is used in the Unity desktop in the HUD as +the first part of the menu entries to distinguish them from the +focused application's entries. +</p> <p>Default value: NULL</p> </div> </div> diff --git a/docs/reference/html/libappindicator.devhelp2 b/docs/reference/html/libappindicator.devhelp2 index be74185..7ee941e 100644 --- a/docs/reference/html/libappindicator.devhelp2 +++ b/docs/reference/html/libappindicator.devhelp2 @@ -42,6 +42,7 @@ <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"/> <keyword type="function" name="app_indicator_set_secondary_activate_target ()" link="libappindicator-app-indicator.html#app-indicator-set-secondary-activate-target"/> + <keyword type="function" name="app_indicator_set_title ()" link="libappindicator-app-indicator.html#app-indicator-set-title"/> <keyword type="function" name="app_indicator_get_id ()" link="libappindicator-app-indicator.html#app-indicator-get-id"/> <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"/> @@ -55,6 +56,7 @@ <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_get_secondary_activate_target ()" link="libappindicator-app-indicator.html#app-indicator-get-secondary-activate-target"/> + <keyword type="function" name="app_indicator_get_title ()" link="libappindicator-app-indicator.html#app-indicator-get-title"/> <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"/> @@ -69,6 +71,7 @@ <keyword type="property" name="The "label-guide" property" link="libappindicator-app-indicator.html#AppIndicator--label-guide"/> <keyword type="property" name="The "ordering-index" property" link="libappindicator-app-indicator.html#AppIndicator--ordering-index"/> <keyword type="property" name="The "status" property" link="libappindicator-app-indicator.html#AppIndicator--status"/> + <keyword type="property" name="The "title" property" link="libappindicator-app-indicator.html#AppIndicator--title"/> <keyword type="signal" name="The "connection-changed" signal" link="libappindicator-app-indicator.html#AppIndicator-connection-changed"/> <keyword type="signal" name="The "new-attention-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-attention-icon"/> <keyword type="signal" name="The "new-icon" signal" link="libappindicator-app-indicator.html#AppIndicator-new-icon"/> diff --git a/docs/reference/html/object-tree.html b/docs/reference/html/object-tree.html index c25d405..04f7beb 100644 --- a/docs/reference/html/object-tree.html +++ b/docs/reference/html/object-tree.html @@ -3,7 +3,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Object Hierarchy</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="index.html" title="libappindicator Reference Manual"> <link rel="up" href="index.html" title="libappindicator Reference Manual"> <link rel="prev" href="libappindicator-app-indicator.html" title="AppIndicator"> diff --git a/docs/reference/libappindicator-docs.sgml b/docs/reference/libappindicator-docs.sgml index d90c202..f837248 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.4.1 + for libappindicator 0.4.90 </releaseinfo> </bookinfo> diff --git a/docs/reference/libappindicator-sections.txt b/docs/reference/libappindicator-sections.txt index 6f09364..d9e1196 100644 --- a/docs/reference/libappindicator-sections.txt +++ b/docs/reference/libappindicator-sections.txt @@ -32,6 +32,7 @@ app_indicator_set_icon_theme_path app_indicator_set_label app_indicator_set_ordering_index app_indicator_set_secondary_activate_target +app_indicator_set_title app_indicator_get_id app_indicator_get_category app_indicator_get_status @@ -45,6 +46,7 @@ app_indicator_get_label app_indicator_get_label_guide app_indicator_get_ordering_index app_indicator_get_secondary_activate_target +app_indicator_get_title app_indicator_build_menu_from_desktop </SECTION> diff --git a/docs/reference/tmpl/app-indicator.sgml b/docs/reference/tmpl/app-indicator.sgml index 1c19e66..8310801 100644 --- a/docs/reference/tmpl/app-indicator.sgml +++ b/docs/reference/tmpl/app-indicator.sgml @@ -271,6 +271,11 @@ AppIndicator </para> +<!-- ##### ARG AppIndicator:title ##### --> +<para> + +</para> + <!-- ##### STRUCT AppIndicatorClass ##### --> <para> @@ -419,6 +424,15 @@ AppIndicator @menuitem: +<!-- ##### FUNCTION app_indicator_set_title ##### --> +<para> + +</para> + +@self: +@title: + + <!-- ##### FUNCTION app_indicator_get_id ##### --> <para> @@ -536,6 +550,15 @@ AppIndicator @Returns: +<!-- ##### FUNCTION app_indicator_get_title ##### --> +<para> + +</para> + +@self: +@Returns: + + <!-- ##### FUNCTION app_indicator_build_menu_from_desktop ##### --> <para> diff --git a/docs/reference/version.xml b/docs/reference/version.xml index 267577d..d881a03 100644 --- a/docs/reference/version.xml +++ b/docs/reference/version.xml @@ -1 +1 @@ -0.4.1 +0.4.90 diff --git a/docs/reference/xml/api-index-full.xml b/docs/reference/xml/api-index-full.xml index d4079d2..4618f62 100644 --- a/docs/reference/xml/api-index-full.xml +++ b/docs/reference/xml/api-index-full.xml @@ -28,6 +28,7 @@ <indexentry><primaryie linkends="AppIndicator--label-guide"><link linkend="AppIndicator--label-guide">AppIndicator:label-guide</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="AppIndicator--ordering-index"><link linkend="AppIndicator--ordering-index">AppIndicator:ordering-index</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="AppIndicator--status"><link linkend="AppIndicator--status">AppIndicator:status</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="AppIndicator--title"><link linkend="AppIndicator--title">AppIndicator:title</link>, object property in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="AppIndicatorCategory"><link linkend="AppIndicatorCategory">AppIndicatorCategory</link>, enum in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> <indexentry><primaryie linkends="AppIndicatorClass"><link linkend="AppIndicatorClass">AppIndicatorClass</link>, struct in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="AppIndicatorPrivate"><link linkend="AppIndicatorPrivate">AppIndicatorPrivate</link>, struct in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> @@ -48,6 +49,7 @@ <indexentry><primaryie linkends="app-indicator-get-ordering-index"><link linkend="app-indicator-get-ordering-index">app_indicator_get_ordering_index</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="app-indicator-get-secondary-activate-target"><link linkend="app-indicator-get-secondary-activate-target">app_indicator_get_secondary_activate_target</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="app-indicator-get-status"><link linkend="app-indicator-get-status">app_indicator_get_status</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-get-title"><link linkend="app-indicator-get-title">app_indicator_get_title</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="app-indicator-get-type"><link linkend="app-indicator-get-type">app_indicator_get_type</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <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> @@ -61,6 +63,7 @@ <indexentry><primaryie linkends="app-indicator-set-ordering-index"><link linkend="app-indicator-set-ordering-index">app_indicator_set_ordering_index</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="app-indicator-set-secondary-activate-target"><link linkend="app-indicator-set-secondary-activate-target">app_indicator_set_secondary_activate_target</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="app-indicator-set-status"><link linkend="app-indicator-set-status">app_indicator_set_status</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> +<indexentry><primaryie linkends="app-indicator-set-title"><link linkend="app-indicator-set-title">app_indicator_set_title</link>, function in <link linkend="libappindicator-app-indicator">AppIndicator</link></primaryie></indexentry> <indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS"><link linkend="APP-INDICATOR-SIGNAL-CONNECTION-CHANGED:CAPS">APP_INDICATOR_SIGNAL_CONNECTION_CHANGED</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> <indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-ATTENTION-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> <indexentry><primaryie linkends="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS"><link linkend="APP-INDICATOR-SIGNAL-NEW-ICON:CAPS">APP_INDICATOR_SIGNAL_NEW_ICON</link>, macro in <link linkend="libappindicator-app-indicator">app-indicator</link></primaryie></indexentry> diff --git a/docs/reference/xml/app-indicator.xml b/docs/reference/xml/app-indicator.xml index 7eb3937..53ac45d 100644 --- a/docs/reference/xml/app-indicator.xml +++ b/docs/reference/xml/app-indicator.xml @@ -79,6 +79,8 @@ struct <link linkend="AppIndicatorClass">AppIndicatorClass</link>; <link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-secondary-activate-target">app_indicator_set_secondary_activate_target</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, <parameter><link linkend="GtkWidget"><type>GtkWidget</type></link> *menuitem</parameter>); +<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-set-title">app_indicator_set_title</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *title</parameter>); const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-id">app_indicator_get_id</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); <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>); @@ -94,6 +96,7 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <lin <link linkend="guint32"><returnvalue>guint32</returnvalue></link> <link linkend="app-indicator-get-ordering-index">app_indicator_get_ordering_index</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); <link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link> * <link linkend="app-indicator-get-secondary-activate-target">app_indicator_get_secondary_activate_target</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); +const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="app-indicator-get-title">app_indicator_get_title</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>); <link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="app-indicator-build-menu-from-desktop">app_indicator_build_menu_from_desktop</link> (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, <parameter>const <link linkend="gchar"><type>gchar</type></link> *desktop_file</parameter>, @@ -123,6 +126,7 @@ const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <lin "<link linkend="AppIndicator--label-guide">label-guide</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write "<link linkend="AppIndicator--ordering-index">ordering-index</link>" <link linkend="guint"><type>guint</type></link> : Read / Write "<link linkend="AppIndicator--status">status</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write + "<link linkend="AppIndicator--title">title</link>" <link linkend="gchar"><type>gchar</type></link>* : Read / Write </synopsis> </refsect1> <refsect1 id="libappindicator-app-indicator.signals" role="signal_proto"> @@ -365,8 +369,15 @@ Private Fields <indexterm zone="AppIndicator-struct"><primary>AppIndicator</primary></indexterm> <programlisting>typedef struct _AppIndicator AppIndicator;</programlisting> <para> -Whether the indicator is shown or requests attention. Defaults to -'Passive'. +A application indicator represents the values that are needed to show a +unique status in the panel for an application. In general, applications +should try to fit in the other indicators that are available on the +panel before using this. But, sometimes it is necissary. +</para> +<para> + Private fields +<parameter>parent</parameter>: Parent object. +<parameter>priv</parameter>: Internal data. </para></refsect2> <refsect2 id="AppIndicatorClass" role="struct"> <title>struct AppIndicatorClass</title> @@ -698,6 +709,29 @@ Setting <parameter>menuitem</parameter> to <link linkend="NULL:CAPS"><literal>NU <varlistentry><term><parameter>menuitem</parameter> :</term> <listitem><simpara>A <link linkend="GtkWidget"><type>GtkWidget</type></link> to be activated on secondary activation. <emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> +<refsect2 id="app-indicator-set-title" role="function"> +<title>app_indicator_set_title ()</title> +<indexterm zone="app-indicator-set-title"><primary>app_indicator_set_title</primary></indexterm> +<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> app_indicator_set_title (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>, + <parameter>const <link linkend="gchar"><type>gchar</type></link> *title</parameter>);</programlisting> +<para> +Sets the title of the application indicator, or how it should be referred +in a human readable form. This string should be UTF-8 and localized as it +expected that users will set it. +</para> +<para> +In the Unity desktop the most prominent place that this is show will be +in the HUD. HUD listings for this application indicator will start with +the title as the first part of the line for the menu items. +</para> +<para> +Setting <parameter>title</parameter> to <link linkend="NULL:CAPS"><literal>NULL</literal></link> removes the title. +</para><variablelist role="params"> +<varlistentry><term><parameter>self</parameter> :</term> +<listitem><simpara>The <link linkend="AppIndicator"><type>AppIndicator</type></link></simpara></listitem></varlistentry> +<varlistentry><term><parameter>title</parameter> :</term> +<listitem><simpara>Title of the app indicator. <emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></simpara></listitem></varlistentry> +</variablelist></refsect2> <refsect2 id="app-indicator-get-id" role="function"> <title>app_indicator_get_id ()</title> <indexterm zone="app-indicator-get-id"><primary>app_indicator_get_id</primary></indexterm> @@ -844,6 +878,18 @@ Gets the menuitem being called on secondary-activate event. <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="GtkWidget"><type>GtkWidget</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if none has been set. <emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></simpara></listitem></varlistentry> </variablelist></refsect2> +<refsect2 id="app-indicator-get-title" role="function"> +<title>app_indicator_get_title ()</title> +<indexterm zone="app-indicator-get-title"><primary>app_indicator_get_title</primary></indexterm> +<programlisting>const <link linkend="gchar"><returnvalue>gchar</returnvalue></link> * app_indicator_get_title (<parameter><link linkend="AppIndicator"><type>AppIndicator</type></link> *self</parameter>);</programlisting> +<para> +Gets the title of the application indicator. See the function +<link linkend="app-indicator-set-title"><function>app_indicator_set_title()</function></link> for information on the title. +</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 title.</simpara></listitem></varlistentry> +</variablelist></refsect2> <refsect2 id="app-indicator-build-menu-from-desktop" role="function"> <title>app_indicator_build_menu_from_desktop ()</title> <indexterm zone="app-indicator-build-menu-from-desktop"><primary>app_indicator_build_menu_from_desktop</primary></indexterm> @@ -977,7 +1023,20 @@ in case you do, this is the way. <refsect2 id="AppIndicator--status" role="property"><title>The <literal>"status"</literal> property</title> <indexterm zone="AppIndicator--status"><primary>AppIndicator:status</primary></indexterm> <programlisting> "status" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> -<para>Whether the indicator is shown or requests attention. Defaults to 'Passive'.</para><para>Default value: NULL</para> +<para> +Whether the indicator is shown or requests attention. Defaults to +'Passive'. +</para><para>Default value: NULL</para> +</refsect2> +<refsect2 id="AppIndicator--title" role="property"><title>The <literal>"title"</literal> property</title> +<indexterm zone="AppIndicator--title"><primary>AppIndicator:title</primary></indexterm> +<programlisting> "title" <link linkend="gchar"><type>gchar</type></link>* : Read / Write</programlisting> +<para> +Provides a way to refer to this application indicator in a human +readable form. This is used in the Unity desktop in the HUD as +the first part of the menu entries to distinguish them from the +focused application's entries. +</para><para>Default value: NULL</para> </refsect2> </refsect1> |