HGKeeper

<?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" [

<title>Connection signals</title>

<title role="signal_proto.title">List of signals</title>

"<link linkend="connections-online">online</link>"

"<link linkend="connections-offline">offline</link>"

"<link linkend="connections-signing-on">signing-on</link>"

"<link linkend="connections-signed-on">signed-on</link>"

"<link linkend="connections-autojoin">autojoin</link>"

"<link linkend="connections-signing-off">signing-off</link>"

"<link linkend="connections-signed-off">signed-off</link>"

"<link linkend="connections-connection-error">connection-error</link>"

</synopsis>

</refsect1>

<title role="signals.title">Signal details</title>

<title>The <literal>"online"</literal> signal</title>

void user_function (gpointer user_data)

</programlisting>

<para>

Emitted when the first connection has connected when all connections were

previously not connected.

</para>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"online"</literal> signal</title>

void user_function (gpointer user_data)

</programlisting>

<para>

Emitted when the last connected connection has disconnected.

</para>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"signing-on"</literal> signal</title>

void user_function (PurpleConnection *gc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection is about to sign on.

</para>

<listitem><simpara>The connection that is about to sign on.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"signed-on"</literal> signal</title>

void user_function (PurpleConnection *gc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection has signed on.

</para>

<listitem><simpara>The connection that has signed on.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"autojoin"</literal> signal</title>

gboolean user_function (PurpleConnection *gc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection has signed on, after the signed-on signal, to signal UIs to autojoin chats if they wish. UIs should connect to this with <literal>PURPLE_SIGNAL_PRIORITY_HIGHEST</literal> to allow plugins to block this signal before the UI sees it and then re-emit it later.

</para>

<listitem><simpara>The connection that has signed on.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

<term><emphasis>Returns</emphasis> :</term>

<listitem><simpara><literal>TRUE</literal> if the signal was handled or <literal>FALSE</literal> otherwise. In practice, the return value is irrelevant, as it really only exists so plugins can block the UI's autojoin.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"signing-off"</literal> signal</title>

void user_function (PurpleConnection *gc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection is about to sign off.

</para>

<listitem><simpara>The connection that is about to sign off.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"signed-off"</literal> signal</title>

void user_function (PurpleConnection *gc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection has signed off.

</para>

<listitem><simpara>The connection that has signed off.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

<title>The <literal>"connection-error"</literal> signal</title>

void user_function (PurpleConnection *gc,

PurpleConnectionError err,

const gchar *desc,

gpointer user_data)

</programlisting>

<para>

Emitted when a connection error occurs, before <literal>"signed"</literal>-off.

</para>

<listitem><simpara>The connection on which the error has occurred.</simpara></listitem>

</varlistentry>

<listitem><simpara>The error that occurred.</simpara></listitem>

</varlistentry>

<listitem><simpara>A description of the error, giving more information.</simpara></listitem>

</varlistentry>

<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>

</varlistentry>

</variablelist>

</refsect2>

</refsect1>

</chapter>

pidgin/pidgin