doc/gtkimhtml-signals.dox

   1 /** @page gtkimhtml-signals GtkIMHtml Signals
   2
   3  @signals
   4   @signal url_clicked
   5   @signal format_buttons_update
   6   @signal format_function_clear
   7   @signal format_function_toggle
   8   @signal format_function_update
   9   @signal paste
  10  @endsignals
  11
  12  @see gtkimhtml.h
  13
  14  <hr>
  15
  16  @signaldef url_clicked
  17   @signalproto
  18 void (*url_clicked)(GtkIMHtml *imhtml, char *uri);
  19   @endsignalproto
  20   @signaldesc Emitted when a link is clicked
  21   @param imhtml The GtkIMHtml emitting the signal.
  22   @param url The uri.
  23  @endsignaldef
  24
  25  @signaldef format_buttons_update
  26   @signalproto
  27 void (*format_buttons_update)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
  28   @endsignalproto
  29   @signaldesc Emitted when allowed formatting has changed.
  30   @param imhtml  The GtkIMHtml emitting the signal.
  31   @param buttons GtkIMHtmlButtons for the GtkIMHtml.
  32   @param data    User defined data.
  33  @endsignaldef
  34
  35  @signaldef format_function_clear
  36   @signalproto
  37 void (*format_function_clear)(GtkIMHtml *imhtml, gpointer data);
  38   @endsignalproto
  39   @signaldesc Emitted when clearing the formatting for the GtkIMHtml.
  40   @param imhtml The GtkIMHtml emitting the signal.
  41   @param data   User defined data.
  42  @endsignaldef
  43
  44  @signaldef format_function_toggle
  45   @signalproto
  46 void (*format_function_toggle)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
  47   @endsignalproto
  48   @signaldesc Emitted when a format has been toggled.
  49   @param imhtml  The GtkIMHtml emitting the signal.
  50   @param buttons GtkIMHtmlButtons for the GtkIMHtml.
  51   @param data    User defined data.
  52  @endsignaldef
  53
  54  @signaldef format_function_update
  55   @signalproto
  56 void (*format_function_update)(GtkIMHtml *imhtml, gpointer data);
  57   @endsignalproto
  58   @signaldesc Emitted when the cursor has moved and formatting has changed
  59   @param imhtml The GtkIMHtml emitting the signal.
  60   @param data   User defined data.
  61
  62  @signaldef paste
  63         @signalproto
  64 void (*paste) (GtkIMHtml *imhtml, char *format)
  65         @endsignalproto
  66         @signaldesc Emitted when paste from the clipboard is requested.
  67         @param imhtml  The GtkIMHtml emitting the signal.
  68         @param format  If 'text', then the formatting of the clipboard content
  69                        will be removed before pasting. If empty or 'html', then
  70                        the formatting will not be removed. Any other value for
  71                        this parameter is ignored and nothing is pasted.
  72  @endsignaldef
  73 */
  74 // vim: syntax=c.doxygen tw=75 et