propagate from branch 'im.pidgin.pidgin' (head 732d7332dd1537d25b59073beeec74d96da39f13)
[pidgin-git.git] / doc / gtkimhtml-signals.dox
blobb9b71c94ebe9f813c247a39222adb2a4cc35a533
1 /** @page gtkimhtml-signals GtkIMHtml Signals
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  @endsignals
11  @see gtkimhtml.h
13  <hr>
15  @signaldef url_clicked
16   @signalproto
17 void (*url_clicked)(GtkIMHtml *imhtml, char *uri);
18   @endsignalproto
19   @signaldesc Emitted when a link is clicked
20   @param imhtml The GtkIMHtml emitting the signal.
21   @param url The uri.
22  @endsignaldef
24  @signaldef format_buttons_update
25   @signalproto
26 void (*format_buttons_update)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
27   @endsignalproto
28   @signaldesc Emitted when allowed formatting has changed.
29   @param imhtml  The GtkIMHtml emitting the signal.
30   @param buttons GtkIMHtmlButtons for the GtkIMHtml.
31   @param data    User defined data.
32  @endsignaldef
34  @signaldef format_function_clear
35   @signalproto
36 void (*format_function_clear)(GtkIMHtml *imhtml, gpointer data);
37   @endsignalproto
38   @signaldesc Emitted when clearing the formatting for the GtkIMHtml.
39   @param imhtml The GtkIMHtml emitting the signal.
40   @param data   User defined data.
41  @endsignaldef
43  @signaldef format_function_toggle
44   @signalproto
45 void (*format_function_toggle)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
46   @endsignalproto
47   @signaldesc Emitted when a format has been toggled.
48   @param imhtml  The GtkIMHtml emitting the signal.
49   @param buttons GtkIMHtmlButtons for the GtkIMHtml.
50   @param data    User defined data.
51  @endsignaldef
53  @signaldef format_function_update
54   @signalproto
55 void (*format_function_update)(GtkIMHtml *imhtml, gpointer data);
56   @endsignalproto
57   @signaldesc Emitted when the cursor has moved and formatting has changed
58   @param imhtml The GtkIMHtml emitting the signal.
59   @param data   User defined data.
60  @endsignaldef
62 // vim: syntax=c.doxygen tw=75 et