--- a/doc/reference/libpurple/signals_blist.xml Tue Oct 22 02:51:40 2013 +0530
+++ b/doc/reference/libpurple/signals_blist.xml Tue Oct 22 02:52:36 2013 +0530
@@ -3,134 +3,249 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<chapter id="chapter-signals-blist">
- <title>Buddy List signals</title>
+<title>Buddy List signals</title>
+<refsect1 id="blist.signals" role="signal_proto">
+<title role="signal_proto.title">List of signals</title>
+<synopsis>
+ "<link linkend="blist-buddy-status-changed">buddy-status-changed</link>"
+ "<link linkend="blist-buddy-idle-changed">buddy-idle-changed</link>"
+ "<link linkend="blist-buddy-signed-on">buddy-signed-on</link>"
+ "<link linkend="blist-buddy-signed-off">buddy-signed-off</link>"
+ "<link linkend="blist-update-idle">update-idle</link>"
+ "<link linkend="blist-blist-node-extended-menu">blist-node-extended-menu</link>"
+ "<link linkend="blist-buddy-icon-changed">buddy-icon-changed</link>"
+ "<link linkend="blist-blist-node-aliased">blist-node-aliased</link>"
+ "<link linkend="blist-buddy-caps-changed">buddy-caps-changed</link>"
+ "<link linkend="blist-ui-caps-changed">ui-caps-changed</link>"
+</synopsis>
+</refsect1>
+
+<refsect1 id="blist.signal-details" role="signals">
+<title role="signals.title">Signal details</title>
+
+<refsect2 id="blist-buddy-status-changed" role="signal">
+ <title>The <literal>"buddy-status-changed"</literal> signal</title>
<programlisting>
- @signals
- @signal buddy-status-changed
- @signal buddy-idle-changed
- @signal buddy-signed-on
- @signal buddy-signed-off
- @signal update-idle
- @signal blist-node-extended-menu
- @signal buddy-icon-changed
- @signal blist-node-aliased
- @signal buddy-caps-changed
- @signal ui-caps-changed
- @endsignals
-
- @see blist.h
-
- @signaldef buddy-status-changed
- @signalproto
-void (*buddy_away)(PurpleBuddy *buddy, PurpleStatus *old_status, PurpleStatus *status);
- @endsignalproto
- @signaldesc
- Emitted when a buddy on your buddy list goes away.
- @param buddy The buddy whose status changed.
- @param old_status The status that the buddy just changed from.
- @param status The status that the buddy just changed to.
- @endsignaldef
+void user_function (PurpleBuddy *buddy,
+ PurpleStatus *old_status,
+ PurpleStatus *status,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddy on your buddy list goes away.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>buddy</parameter> :</term>
+ <listitem><simpara>The buddy whose status changed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>old_status</parameter> :</term>
+ <listitem><simpara>The status that the buddy just changed from.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>status</parameter> :</term>
+ <listitem><simpara>The status that the buddy just changed to.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef buddy-idle-changed
- @signalproto
-void (*buddy_idle)(PurpleBuddy *buddy, gboolean old_idle, gboolean idle);
- @endsignalproto
- @signaldesc
- Emitted when a buddy on your buddy list becomes idle.
- @param buddy The buddy whose idle status changed.
- @param old_idle Whether the buddy was idle.
- @param idle Whether the buddy is currently idle.
- @endsignaldef
+<refsect2 id="blist-buddy-idle-changed" role="signal">
+ <title>The <literal>"buddy-idle-changed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBuddy *buddy,
+ gboolean old_idle,
+ gboolean idle,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddy on your buddy list becomes idle.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>buddy</parameter> :</term>
+ <listitem><simpara>The buddy whose idle status changed.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>old_idle</parameter> :</term>
+ <listitem><simpara>Whether the buddy was idle.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>idle</parameter> :</term>
+ <listitem><simpara>Whether the buddy is currently idle.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef buddy-signed-on
- @signalproto
-void (*buddy_signed_on)(PurpleBuddy *buddy);
- @endsignalproto
- @signaldesc
- Emitted when a buddy on your buddy list signs on.
- @param buddy The buddy that signed on.
- @endsignaldef
+<refsect2 id="blist-buddy-signed-on" role="signal">
+ <title>The <literal>"buddy-signed-on"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBuddy *buddy,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddy on your buddy list signs on.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>buddy</parameter> :</term>
+ <listitem><simpara>The buddy that signed on.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef buddy-signed-off
- @signalproto
-void (*buddy_signed_off)(PurpleBuddy *buddy);
- @endsignalproto
- @signaldesc
- Emitted when a buddy on your buddy list signs off.
- @param buddy The buddy that signed off.
- @endsignaldef
-
- @signaldef update-idle
- @signalproto
-void (*update_idle)();
- @endsignalproto
- @signaldesc
- Emitted when the buddy list is refreshed and the idle times are updated.
- @endsignaldef
+<refsect2 id="blist-buddy-signed-off" role="signal">
+ <title>The <literal>"buddy-signed-off"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBuddy *buddy,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddy on your buddy list signs off.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>buddy</parameter> :</term>
+ <listitem><simpara>The buddy that signed off.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef blist-node-extended-menu
- @signalproto
-void (*blist_node_extended_menu)(PurpleBlistNode *node, GList **menu)
- @endsignalproto
- @signaldesc
- Emitted when a buddlist menu is being constructed @a menu is a pointer to
- a GList of PurpleBlistNodeAction's allowing a plugin to add menu items
- @endsignaldef
+<refsect2 id="blist-update-idle" role="signal">
+ <title>The <literal>"update-idle"</literal> signal</title>
+ <programlisting>
+void user_function (gpointer user_data)</programlisting>
+ <para>
+Emitted when the buddy list is refreshed and the idle times are updated.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
+
+<refsect2 id="blist-blist-node-extended-menu" role="signal">
+ <title>The <literal>"blist-node-extended-menu"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBlistNode *node,
+ GList **menu,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddlist menu is being constructed <literal>menu</literal> is a pointer to a GList of PurpleBlistNodeAction's allowing a plugin to add menu items.
+ </para>
+</refsect2>
- @signaldef blist-node-added
- @signalproto
-void (*blist_node_added)(PurpleBlistNode *node)
- @endsignalproto
- @signaldesc
- Emitted when a new blist node is added to the buddy list.
- @endsignaldef
+<refsect2 id="blist-blist-node-added" role="signal">
+ <title>The <literal>"blist-node-added"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBlistNode *node,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a new blist node is added to the buddy list.
+ </para>
+</refsect2>
- @signaldef blist-node-removed
- @signalproto
-void (*blist_node_removed)(PurpleBlistNode *node)
- @endsignalproto
- @signaldesc
- Emitted when a blist node is removed from the buddy list.
- @endsignaldef
+<refsect2 id="blist-blist-node-removed" role="signal">
+ <title>The <literal>"blist-node-removed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBlistNode *node,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a blist node is removed from the buddy list.
+ </para>
+</refsect2>
- @signaldef buddy-icon-changed
- @signalproto
-void (*buddy_icon_changed)(PurpleBuddy *buddy)
- @endsignalproto
- @signaldesc
- Emitted when a buddy's icon is set.
- @endsignaldef
+<refsect2 id="blist-buddy-icon-changed" role="signal">
+ <title>The <literal>"buddy-icon-changed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBuddy *buddy,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a buddy's icon is set.
+ </para>
+</refsect2>
- @signaldef blist-node-aliased
- @signalproto
-void (*blist_node_aliased)(PurpleBlistNode *node, const char *old_alias)
- @endsignalproto
- @signaldesc
- Emitted when a blist node (buddy, chat, or contact) is aliased.
- @endsignaldef
+<refsect2 id="blist-blist-node-aliased" role="signal">
+ <title>The <literal>"blist-node-aliased"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBlistNode *node,
+ const char *old_alias,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when a blist node (buddy, chat, or contact) is aliased.
+ </para>
+</refsect2>
- @signaldef buddy-caps-changed
- @signalproto
-void (*buddy_caps_changed)(PurpleBuddy *buddy, PurpleMediaCaps newcaps,
- PurpleMediaCaps oldcaps)
- @endsignalproto
- @signaldesc
- Emitted when updating a buddy's media capabilities.
- @param buddy The buddy
- @param newcaps
- @param oldcaps
- @endsignaldef
+<refsect2 id="blist-buddy-caps-changed" role="signal">
+ <title>The <literal>"buddy-caps-changed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleBuddy *buddy,
+ PurpleMediaCaps newcaps,
+ PurpleMediaCaps oldcaps,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when updating a buddy's media capabilities.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>buddy</parameter> :</term>
+ <listitem><simpara>The buddy.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>newcaps</parameter> :</term>
+ <listitem><simpara>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>oldcaps</parameter> :</term>
+ <listitem><simpara>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- @signaldef ui-caps-changed
- @signalproto
-void (*ui_caps_changed)(PurpleMediaCaps newcaps, PurpleMediaCaps oldcaps)
- @endsignalproto
- @signaldesc
- Emitted when updating the media capabilities of the UI.
- @param newcaps
- @param oldcaps
- @endsignaldef
+<refsect2 id="blist-ui-caps-changed" role="signal">
+ <title>The <literal>"ui-caps-changed"</literal> signal</title>
+ <programlisting>
+void user_function (PurpleMediaCaps newcaps,
+ PurpleMediaCaps oldcaps,
+ gpointer user_data)</programlisting>
+ <para>
+Emitted when updating the media capabilities of the UI.
+ </para>
+ <variablelist role="params">
+ <varlistentry>
+ <term><parameter>newcaps</parameter> :</term>
+ <listitem><simpara>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>oldcaps</parameter> :</term>
+ <listitem><simpara>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_data</parameter> :</term>
+ <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+</refsect2>
- </programlisting>
+</refsect1>
+
</chapter>