pidgin/pidgin

closing merged branch
port-changes-from-branch-2.x.y-to-default
2020-02-03, Gary Kramlich
2f836435c33c
closing merged branch
<?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-imgstore">
<title>Stored Image signals</title>
<refsect1 id="imgstores.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
&quot;<link linkend="imgstores-image-deleting">image-deleting</link>&quot;
</synopsis>
</refsect1>
<refsect1 id="imgstores.signal-details" role="signals">
<title role="signals.title">Signal details</title>
<refsect2 id="imgstores-image-deleting" role="signal">
<title>The <literal>&quot;image-deleting&quot;</literal> signal</title>
<programlisting>
char * user_function (const PurpleStoredImage *img,
gpointer user_data)
</programlisting>
<para>
Emitted when a #PurpleStoredImage is about to be destroyed. This allows for what amounts to weak references. Code can hold onto a pointer to the PurpleStoredImage without actually "holding" a reference. They can then use a signal handler to let them know when their img is about to be destroyed.
</para>
<note><para>
It's not possible to purple_imgstore_ref() img to save it.
</para></note>
<variablelist role="params">
<varlistentry>
<term><parameter>img</parameter>&#160;:</term>
<listitem><simpara>The image about to be destroyed.</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>