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