* New upstream release.

* Fix include with Dbusmenu 0.5.90 * Fix GTK3 include paths in pkgconfig file (LP: #869373) * Add title property (LP: #923971) * Don't specify pyglib-2.0-python2.6 in LDFLAGS * fix fallback icon of the GtkStatusIcon (LP: #820080)
author: Ted Gould <ted@gould.cx> 2012-02-03 14:41:17 -0600
committer: Ted Gould <ted@gould.cx> 2012-02-03 14:41:17 -0600
commit: 57f1cab18bd5cf92612988f66ce2fed7df9cfdf4 (patch)
tree: 9d2e8fff9c4df70c102b3bfe22c0cc15848222ad /docs/reference/html/libappindicator-app-indicator.html
parent: 6516e720bded3ad85f051ebb8d6db926596a2ca6 (diff)
parent: 7256c1864e94cf172a4c487a5f434e58f6f71666 (diff)
download: libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.tar.gz
libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.tar.bz2
libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.zip
1 files changed, 90 insertions, 8 deletions
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>
author	Ted Gould <ted@gould.cx>	2012-02-03 14:41:17 -0600
committer	Ted Gould <ted@gould.cx>	2012-02-03 14:41:17 -0600
commit	57f1cab18bd5cf92612988f66ce2fed7df9cfdf4 (patch)
tree	9d2e8fff9c4df70c102b3bfe22c0cc15848222ad /docs/reference/html/libappindicator-app-indicator.html
parent	6516e720bded3ad85f051ebb8d6db926596a2ca6 (diff)
parent	7256c1864e94cf172a4c487a5f434e58f6f71666 (diff)
download	libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.tar.gz libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.tar.bz2 libayatana-appindicator-57f1cab18bd5cf92612988f66ce2fed7df9cfdf4.zip