Mercurial > pidgin3 / annotate

doc/reference/libpurple/signals_cmd.xml@e6fe6fc1f516 (annotated)

doc/reference/libpurple/signals_cmd.xml

Fri, 01 May 2020 04:42:52 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Fri, 01 May 2020 04:42:52 -0500
changeset 40358
e6fe6fc1f516
parent 37033
ce8b96a22ebe
permissions
-rw-r--r--

move all protocols, purple plugins, and purple tests to use purple.h instead of including files individually

35389
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
1 <?xml version='1.0' encoding="ISO-8859-1"?>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
4 ]>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
5 <chapter id="chapter-signals-cmd">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
6 <title>Command signals</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
7
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
8 <refsect1 id="cmds.signals" role="signal_proto">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
9 <title role="signal_proto.title">List of signals</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
10 <synopsis>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
11 &quot;<link linkend="cmds-cmd-added">cmd-added</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
12 &quot;<link linkend="cmds-cmd-removed">cmd-removed</link>&quot;
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
13 </synopsis>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
14 </refsect1>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
15
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
16 <refsect1 id="cmds.signal-details" role="signals">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
17 <title role="signals.title">Signal details</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
18
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
19 <refsect2 id="cmds-cmd-added" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
20 <title>The <literal>&quot;cmd-added&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
21 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
22 void user_function (const char *command,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
23 PurpleCmdPriority priority,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
24 PurpleCmdFlag flag,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
25 gpointer user_data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
26 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
27 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
28 Emitted when a new command is added.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
29 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
30 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
31 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
32 <term><parameter>command</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
33 <listitem><simpara>The new command.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
34 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
35 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
36 <term><parameter>priority</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
37 <listitem><simpara>The priority of the new command.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
38 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
39 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
40 <term><parameter>flag</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
41 <listitem><simpara>The command flags.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
42 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
43 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
44 <term><parameter>user_data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
45 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
46 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
47 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
48 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
49
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
50 <refsect2 id="cmds-cmd-removed" role="signal">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
51 <title>The <literal>&quot;cmd-removed&quot;</literal> signal</title>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
52 <programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
53 void user_function (const char *command,
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
54 gpointer user_data)
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
55 </programlisting>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
56 <para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
57 Emitted when a command is removed.
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
58 </para>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
59 <variablelist role="params">
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
60 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
61 <term><parameter>command</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
62 <listitem><simpara>The removed command.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
63 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
64 <varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
65 <term><parameter>user_data</parameter>&#160;:</term>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
66 <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
67 </varlistentry>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
68 </variablelist>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
69 </refsect2>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
70
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
71 </refsect1>
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
72
884a5385bb2c Added doc/reference directory with the documentation .xml files
Ankit Vani <a@nevitus.org>
parents:
diff changeset
73 </chapter>

Mercurial Repository: pidgin3

mercurial