view doc/gtkimhtml-signals.dox @ 30229:e5575248ca82

*** Plucked rev 16e7d9f71db071e6d043c456869b8f860bcc8d45 ([e-mail]): Since these messages are shown to the user, they should at least look like complete sentences. They are still confusing and should probably be rephrased further, but I'm not sure how now.

/** @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
  @signal paste
 @endsignals

 @see gtkimhtml.h

 <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.

 @signaldef paste
 	@signalproto
void (*paste) (GtkIMHtml *imhtml, char *format)
	@endsignalproto
	@signaldesc Emitted when paste from the clipboard is requested.
	@param imhtml  The GtkIMHtml emitting the signal.
	@param format  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.
 @endsignaldef
*/
// vim: syntax=c.doxygen tw=75 et