Mercurial > pidgin3 / file revision

<?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-gtkimhtml">
<title>IMHtml signals</title>

<refsect1 id="gtkimhtml.signals" role="signal_proto">
<title role="signal_proto.title">List of signals</title>
<synopsis>
  &quot;<link linkend="gtkimhtml-url_clicked">url_clicked</link>&quot;
  &quot;<link linkend="gtkimhtml-format_buttons_update">format_buttons_update</link>&quot;
  &quot;<link linkend="gtkimhtml-format_function_clear">format_function_clear</link>&quot;
  &quot;<link linkend="gtkimhtml-format_function_toggle">format_function_toggle</link>&quot;
  &quot;<link linkend="gtkimhtml-format_function_update">format_function_update</link>&quot;
  &quot;<link linkend="gtkimhtml-paste">paste</link>&quot;
</synopsis>
</refsect1>

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

<refsect2 id="gtkimhtml-url_clicked" role="signal">
 <title>The <literal>&quot;url_clicked&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        char *uri,
                                                        gpointer user_data)</programlisting>
  <para>
Emitted when a link is clicked.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>url</parameter>&#160;:</term>
    <listitem><simpara>The uri.</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="gtkimhtml-format_buttons_update" role="signal">
 <title>The <literal>&quot;format_buttons_update&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        GtkIMHtmlButtons buttons,
                                                        gpointer data)</programlisting>
  <para>
Emitted when allowed formatting has changed.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>buttons</parameter>&#160;:</term>
    <listitem><simpara>GtkIMHtmlButtons for the GtkIMHtml.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>data</parameter>&#160;:</term>
    <listitem><simpara>User defined data.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

<refsect2 id="gtkimhtml-format_function_clear" role="signal">
 <title>The <literal>&quot;format_function_clear&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        gpointer data)</programlisting>
  <para>
Emitted when clearing the formatting for the GtkIMHtml.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>data</parameter>&#160;:</term>
    <listitem><simpara>User defined data.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

<refsect2 id="gtkimhtml-format_function_toggle" role="signal">
 <title>The <literal>&quot;format_function_toggle&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        GtkIMHtmlButtons buttons,
                                                        gpointer data)</programlisting>
  <para>
Emitted when a format has been toggled.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>buttons</parameter>&#160;:</term>
    <listitem><simpara>GtkIMHtmlButtons for the GtkIMHtml.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>data</parameter>&#160;:</term>
    <listitem><simpara>User defined data.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

<refsect2 id="gtkimhtml-format_function_update" role="signal">
 <title>The <literal>&quot;format_function_update&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        gpointer data)</programlisting>
  <para>
Emitted when the cursor has moved and formatting has changed.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>data</parameter>&#160;:</term>
    <listitem><simpara>User defined data.</simpara></listitem>
  </varlistentry>
  </variablelist>
</refsect2>

<refsect2 id="gtkimhtml-paste" role="signal">
 <title>The <literal>&quot;paste&quot;</literal> signal</title>
  <programlisting>
void                user_function                      (GtkIMHtml *imhtml,
                                                        char *format,
                                                        gpointer user_data)</programlisting>
  <para>
Emitted when paste from the clipboard is requested.
  </para>
  <variablelist role="params">
  <varlistentry>
    <term><parameter>imhtml</parameter>&#160;:</term>
    <listitem><simpara>The GtkIMHtml emitting the signal.</simpara></listitem>
  </varlistentry>
  <varlistentry>
    <term><parameter>format</parameter>&#160;:</term>
    <listitem><simpara>If 'text', then the formatting of the clipboard content will be removed before pasting. If empty or 'html', then the formatting will not be removed. Any other value for this parameter is ignored and nothing is pasted.</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>