doc/reference/libpurple/signals_imgstore.xml

   1 <?xml version='1.0' encoding="ISO-8859-1"?>
   2 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 ]>
   5 <chapter id="chapter-signals-imgstore">
   6 <title>Stored Image signals</title>
   7
   8 <refsect1 id="imgstores.signals" role="signal_proto">
   9 <title role="signal_proto.title">List of signals</title>
  10 <synopsis>
  11   &quot;<link linkend="imgstores-image-deleting">image-deleting</link>&quot;
  12 </synopsis>
  13 </refsect1>
  14
  15 <refsect1 id="imgstores.signal-details" role="signals">
  16 <title role="signals.title">Signal details</title>
  17
  18 <refsect2 id="imgstores-image-deleting" role="signal">
  19  <title>The <literal>&quot;image-deleting&quot;</literal> signal</title>
  20 <programlisting>
  21 char *              user_function                      (const PurpleStoredImage *img,
  22                                                         gpointer user_data)
  23 </programlisting>
  24   <para>
  25 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.
  26   </para>
  27   <note><para>
  28 It's not possible to purple_imgstore_ref() img to save it.
  29   </para></note>
  30   <variablelist role="params">
  31   <varlistentry>
  32     <term><parameter>img</parameter>&#160;:</term>
  33     <listitem><simpara>The image about to be destroyed.</simpara></listitem>
  34   </varlistentry>
  35   <varlistentry>
  36     <term><parameter>user_data</parameter>&#160;:</term>
  37     <listitem><simpara>user data set when the signal handler was connected.</simpara></listitem>
  38   </varlistentry>
  39   </variablelist>
  40 </refsect2>
  41
  42 </refsect1>
  43
  44 </chapter>