aboutsummaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorSebastien Bacher <seb128@ubuntu.com>2012-10-02 23:18:17 +0200
committerSebastien Bacher <seb128@ubuntu.com>2012-10-02 23:18:17 +0200
commit78f8f75ee73478ecb704aecc467c861fa4558b52 (patch)
treea75c86a1f9262d9dc0954ffdab75524163584874 /doc/reference
parentc8794795a7054eff4e21bbca52321195f2d8720c (diff)
parent36692583866dac99672571d6d83ed2c65b9e795d (diff)
downloadayatana-indicator-messages-78f8f75ee73478ecb704aecc467c861fa4558b52.tar.gz
ayatana-indicator-messages-78f8f75ee73478ecb704aecc467c861fa4558b52.tar.bz2
ayatana-indicator-messages-78f8f75ee73478ecb704aecc467c861fa4558b52.zip
Import upstream version 12.10.4
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/Makefile.in2
-rw-r--r--doc/reference/html/MessagingMenuApp.html29
-rw-r--r--doc/reference/html/ch01.html2
-rw-r--r--doc/reference/html/index.html2
-rw-r--r--doc/reference/messaging-menu-docs.xml2
5 files changed, 22 insertions, 15 deletions
diff --git a/doc/reference/Makefile.in b/doc/reference/Makefile.in
index eda7a81..3eb5410 100644
--- a/doc/reference/Makefile.in
+++ b/doc/reference/Makefile.in
@@ -1,4 +1,4 @@
-# Makefile.in generated by automake 1.11.5 from Makefile.am.
+# Makefile.in generated by automake 1.11.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
diff --git a/doc/reference/html/MessagingMenuApp.html b/doc/reference/html/MessagingMenuApp.html
index e89bc0d..aab65dc 100644
--- a/doc/reference/html/MessagingMenuApp.html
+++ b/doc/reference/html/MessagingMenuApp.html
@@ -43,7 +43,10 @@
</tr></table></div>
<div class="refsynopsisdiv">
<a name="MessagingMenuApp.synopsis"></a><h2>Synopsis</h2>
-<pre class="synopsis"> <a class="link" href="MessagingMenuApp.html#MessagingMenuApp-struct" title="MessagingMenuApp">MessagingMenuApp</a>;
+<pre class="synopsis">
+#include &lt;messaging-menu.h&gt;
+
+ <a class="link" href="MessagingMenuApp.html#MessagingMenuApp-struct" title="MessagingMenuApp">MessagingMenuApp</a>;
typedef <a class="link" href="MessagingMenuApp.html#MessagingMenuAppClass" title="MessagingMenuAppClass">MessagingMenuAppClass</a>;
enum <a class="link" href="MessagingMenuApp.html#MessagingMenuStatus" title="enum MessagingMenuStatus">MessagingMenuStatus</a>;
<span class="returnvalue">void</span> <a class="link" href="MessagingMenuApp.html#messaging-menu-app-append-source" title="messaging_menu_app_append_source ()">messaging_menu_app_append_source</a> (<em class="parameter"><code><a class="link" href="MessagingMenuApp.html" title="MessagingMenuApp"><span class="type">MessagingMenuApp</span></a> *app</code></em>,
@@ -159,11 +162,12 @@ desktop file. Activating this item starts the application.
</p>
<p>
Following the application item, the Messaging Menu inserts all
-shortcuts actions found in the desktop file which are marked as
-appearing in the Messaging Menu (the TargetEnvironment or OnlyShowIn
-keywords contains "Messaging Menu"). The <a class="ulink" href="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-1.1.html#extra-actions" target="_top">
+shortcut actions found in the desktop file. Actions whose
+<code class="code">NotShowIn</code> keyword contains "Messaging Menu" or whose
+<code class="code">OnlyShowIn</code> keyword does not contain "Messaging Menu"
+will not appear (the <a class="ulink" href="http://standards.freedesktop.org/desktop-entry-spec/desktop-entry-spec-1.1.html#extra-actions" target="_top">
desktop file specification</a> contains a detailed explanation of
-shortcut actions [1]. An application cannot add, remove, or change
+shortcut actions.) An application cannot add, remove, or change
these shortcut items while it is running.
</p>
<p>
@@ -416,8 +420,10 @@ It is an error to insert a source with an <em class="parameter"><code>id</code><
<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><span class="type">gint64</span> time</code></em>);</pre>
<p>
-Appends a new message source to the end of the section representing <em class="parameter"><code>app</code></em> and
-initializes it with <em class="parameter"><code>time</code></em>.
+Appends a new message source to the end of the section representing
+<em class="parameter"><code>app</code></em> and initializes it with <em class="parameter"><code>time</code></em>. Use
+<a class="link" href="MessagingMenuApp.html#messaging-menu-app-append-source" title="messaging_menu_app_append_source ()"><code class="function">messaging_menu_app_append_source()</code></a> to append a source with the
+current time.
</p>
<p>
To change the time, use <a class="link" href="MessagingMenuApp.html#messaging-menu-app-set-source-time" title="messaging_menu_app_set_source_time ()"><code class="function">messaging_menu_app_set_source_time()</code></a>.
@@ -449,7 +455,7 @@ It is an error to insert a source with an <em class="parameter"><code>id</code><
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
-<td>the time when the source was created</td>
+<td>the time when the source was created, in microseconds</td>
</tr>
</tbody>
</table></div>
@@ -669,7 +675,8 @@ It is an error to insert a source with an <em class="parameter"><code>id</code><
<em class="parameter"><code><span class="type">gint64</span> time</code></em>);</pre>
<p>
Inserts a new message source into the section representing <em class="parameter"><code>app</code></em> and
-initializes it with <em class="parameter"><code>time</code></em>.
+initializes it with <em class="parameter"><code>time</code></em>. Use <a class="link" href="MessagingMenuApp.html#messaging-menu-app-insert-source" title="messaging_menu_app_insert_source ()"><code class="function">messaging_menu_app_insert_source()</code></a> to
+insert a source with the current time.
</p>
<p>
To change the time, use <a class="link" href="MessagingMenuApp.html#messaging-menu-app-set-source-time" title="messaging_menu_app_set_source_time ()"><code class="function">messaging_menu_app_set_source_time()</code></a>.
@@ -705,7 +712,7 @@ It is an error to insert a source with an <em class="parameter"><code>id</code><
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
-<td>the time when the source was created</td>
+<td>the time when the source was created, in microseconds</td>
</tr>
</tbody>
</table></div>
@@ -885,7 +892,7 @@ count associated with it.
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
-<td>the new time for the source</td>
+<td>the new time for the source, in microseconds</td>
</tr>
</tbody>
</table></div>
diff --git a/doc/reference/html/ch01.html b/doc/reference/html/ch01.html
index 522cb09..e0b133a 100644
--- a/doc/reference/html/ch01.html
+++ b/doc/reference/html/ch01.html
@@ -21,7 +21,7 @@
</tr></table>
<div class="chapter">
<div class="titlepage"><div><div><h2 class="title">
-<a name="idp3768560"></a>API Reference</h2></div></div></div>
+<a name="idp3325184"></a>API Reference</h2></div></div></div>
<div class="toc"><dl><dt>
<span class="refentrytitle"><a href="MessagingMenuApp.html">MessagingMenuApp</a></span><span class="refpurpose"> — An application section in the messaging menu</span>
</dt></dl></div>
diff --git a/doc/reference/html/index.html b/doc/reference/html/index.html
index ae97e66..b899df6 100644
--- a/doc/reference/html/index.html
+++ b/doc/reference/html/index.html
@@ -14,7 +14,7 @@
<div class="titlepage">
<div>
<div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">Messaging Menu Reference Manual</p></th></tr></table></div>
-<div><p class="releaseinfo">for libmessaging-menu 12.10.2</p></div>
+<div><p class="releaseinfo">for libmessaging-menu 12.10.4</p></div>
<div><p class="copyright">Copyright © 2012 Canonical Ltd.</p></div>
</div>
<hr>
diff --git a/doc/reference/messaging-menu-docs.xml b/doc/reference/messaging-menu-docs.xml
index b63236a..771e269 100644
--- a/doc/reference/messaging-menu-docs.xml
+++ b/doc/reference/messaging-menu-docs.xml
@@ -2,7 +2,7 @@
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
-<!ENTITY version "12.10.2">
+<!ENTITY version "12.10.4">
]>
<book lang="en" id="messaging-menu" xmlns:xi="http://www.w3.org/2003/XInclude">
<title>Messaging Menu Reference Manual</title>