view doc/gtkimhtml-signals.dox @ 9587:5e1c76f3d232

[gaim-migrate @ 10430] " These 2 patches (one or the other, they are mutually exclusive) fix a slight bug in the gaim_conv_chat_add_user (it was not emitting the user's flags in the chat joining/joined signals). The 1st patch (gaim-0.81cvs-chat-join-signal-fix.patch) just fixes that bug, and nothing else. The 2nd patch (gaim-0.81cvs-chat-join-signal-fix-and-change.patch) also changes the joining/leaving signals to boolean signals to allow a plugin to optionally prevent the display of users joining and leaving chats. This would allow us to respond to "How do I turn off the display of users joinging and leaving a chat?" with "Write a plugin", instead of "You can't"." --Stu Tomlinson - nosnilmot should we be updating the ChangeLog.API? committer: Tailor Script <[e-mail]>

/** @page gtkimhtml-signals GtkIMHtml Signals

 @signals
  @signal url_clicked
  @signal format_buttons_update
  @signal format_function_clear
  @signal format_function_toggle
  @signal format_function_update
 @endsignals

 <hr>

 @signaldef url_clicked
  @signalproto
void (*url_clicked)(GtkIMHtml *imhtml, char *uri);
  @endsignalproto
  @signaldesc Emitted when a link is clicked
  @param imhtml The GtkIMHtml emitting the signal.
  @param url The uri.
 @endsignaldef

 @signaldef format_buttons_update
  @signalproto
void (*format_buttons_update)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
  @endsignalproto
  @signaldesc Emitted when allowed formatting has changed.
  @param imhtml  The GtkIMHtml emitting the signal.
  @param buttons GtkIMHtmlButtons for the GtkIMHtml.
  @param data    User defined data.
 @endsignaldef

 @signaldef format_function_clear
  @signalproto
void (*format_function_clear)(GtkIMHtml *imhtml, gpointer data);
  @endsignalproto
  @signaldesc Emitted when clearing the formatting for the GtkIMHtml.
  @param imhtml The GtkIMHtml emitting the signal.
  @param data   User defined data.
 @endsignaldef

 @signaldef format_function_toggle
  @signalproto
void (*format_function_toggle)(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons, gpointer data);
  @endsignalproto
  @signaldesc Emitted when a format has been toggled.
  @param imhtml  The GtkIMHtml emitting the signal.
  @param buttons GtkIMHtmlButtons for the GtkIMHtml.
  @param data    User defined data.
 @endsignaldef

 @signaldef format_function_update
  @signalproto
void (*format_function_update)(GtkIMHtml *imhtml, gpointer data);
  @endsignalproto
  @signaldesc Emitted when the cursor has moved and formatting has changed
  @param imhtml The GtkIMHtml emitting the signal.
  @param data   User defined data.
 @endsignaldef
*/