doc/reference/libpurple/signals_protocol.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 36919
ca118d6cc20f
permissions
-rw-r--r--

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

<?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-protocol">
<title>Protocol signals</title>

<refsect1 id="protocols.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="protocols-protocol-added">protocol-added</link>&quot;
  &quot;<link linkend="protocols-protocol-removed">protocol-removed</link>&quot;
</synopsis>
</refsect1>

<refsect1 id="protocols.signal-details" role="signals">
<title role="signals.title">Signal details</title>

<refsect2 id="protocols-protocol-added" role="signal">
 <title>The <literal>&quot;protocol-added&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleProtocol *protocol,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when a protocol is added.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>protocol</parameter>&#160;:</term>
    <listitem><simpara>The protocol that was added.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>user_data</parameter>&#160;:</term>
    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

<refsect2 id="protocols-protocol-removed" role="signal">
 <title>The <literal>&quot;protocol-removed&quot;</literal> signal</title>
<programlisting>
void                user_function                      (PurpleProtocol *protocol,
                                                        gpointer user_data)
</programlisting>
  <para>
Emitted when a protocol is removed.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>protocol</parameter>&#160;:</term>
    <listitem><simpara>The protocol that was removed.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>user_data</parameter>&#160;:</term>
    <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

</refsect1>

</chapter>

mercurial