Mercurial > pidgin.yaz
comparison src/gtkimhtml.h @ 9185:f2e75dd2971a
[gaim-migrate @ 9980]
(15:09:07) SimGuy: LSchiere:
http://kevin.simguy.net:8888/patches/gtk-imhtml-documentation-oopses3.diff
(Fixes some typos in my IMHTML documentation)
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Sat, 05 Jun 2004 19:29:30 +0000 |
parents | 812e7aa7eafa |
children | 2138b3a07cb8 |
comparison
equal
deleted
inserted
replaced
9184:3bc41e843afb | 9185:f2e75dd2971a |
---|---|
296 * Appends HTML formatted text to a GTK IM/HTML. | 296 * Appends HTML formatted text to a GTK IM/HTML. |
297 * | 297 * |
298 * @param imhtml The GTK IM/HTML. | 298 * @param imhtml The GTK IM/HTML. |
299 * @param text The formatted text to append. | 299 * @param text The formatted text to append. |
300 * @param options A GtkIMHtmlOptions object indicating insert behavior. | 300 * @param options A GtkIMHtmlOptions object indicating insert behavior. |
301 * @param unused Use NULL value. | 301 * @param unused Use @c NULL value. |
302 */ | 302 */ |
303 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml, | 303 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml, |
304 const gchar *text, | 304 const gchar *text, |
305 GtkIMHtmlOptions options, | 305 GtkIMHtmlOptions options, |
306 GSList *unused); | 306 GSList *unused); |
464 * @param wbfo @c TRUE to enable the mode, or @c FALSE otherwise. | 464 * @param wbfo @c TRUE to enable the mode, or @c FALSE otherwise. |
465 */ | 465 */ |
466 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo); | 466 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo); |
467 | 467 |
468 /** | 468 /** |
469 * Indicates which formatting fuctions to enable and disable in a GTK IM/HTML. | 469 * Indicates which formatting functions to enable and disable in a GTK IM/HTML. |
470 * | 470 * |
471 * @param imhtml The GTK IM/HTML. | 471 * @param imhtml The GTK IM/HTML. |
472 * @param buttons A GtkIMHtmlButtons bitmask indicating which fuctions to use. | 472 * @param buttons A GtkIMHtmlButtons bitmask indicating which functions to use. |
473 */ | 473 */ |
474 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons); | 474 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons); |
475 | 475 |
476 /** | 476 /** |
477 * Returns which formatting fuctions are enabled in a GTK IM/HTML. | 477 * Returns which formatting functions are enabled in a GTK IM/HTML. |
478 * | 478 * |
479 * @param imhtml The GTK IM/HTML. | 479 * @param imhtml The GTK IM/HTML. |
480 * | 480 * |
481 * @return A GtkIMHtmlButtons bitmask indicating which fuctions to are enabled. | 481 * @return A GtkIMHtmlButtons bitmask indicating which functions to are enabled. |
482 */ | 482 */ |
483 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml); | 483 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml); |
484 | 484 |
485 /** | 485 /** |
486 * Sets each boolean to TRUE if that formatting option is enabled at the | 486 * Sets each boolean to TRUE if that formatting option is enabled at the |
572 /** | 572 /** |
573 * Toggles a foreground color at the current location or selection in a GTK | 573 * Toggles a foreground color at the current location or selection in a GTK |
574 * IM/HTML. | 574 * IM/HTML. |
575 * | 575 * |
576 * @param imhtml The GTK IM/HTML. | 576 * @param imhtml The GTK IM/HTML. |
577 * @param color The HTML-style color, or NULL or "" to clear the color. | 577 * @param color The HTML-style color, or @c NULL or "" to clear the color. |
578 * | 578 * |
579 * @return @c TRUE if a color was set, or @c FALSE if it was cleared. | 579 * @return @c TRUE if a color was set, or @c FALSE if it was cleared. |
580 */ | 580 */ |
581 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color); | 581 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color); |
582 | 582 |
583 /** | 583 /** |
584 * Toggles a background color at the current location or selection in a GTK | 584 * Toggles a background color at the current location or selection in a GTK |
585 * IM/HTML. | 585 * IM/HTML. |
586 * | 586 * |
587 * @param imhtml The GTK IM/HTML. | 587 * @param imhtml The GTK IM/HTML. |
588 * @param color The HTML-style color, or NULL or "" to clear the color. | 588 * @param color The HTML-style color, or @c NULL or "" to clear the color. |
589 * | 589 * |
590 * @return @c TRUE if a color was set, or @c FALSE if it was cleared. | 590 * @return @c TRUE if a color was set, or @c FALSE if it was cleared. |
591 */ | 591 */ |
592 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color); | 592 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color); |
593 | 593 |
594 /** | 594 /** |
595 * Toggles a font face at the current location or selection in a GTK IM/HTML. | 595 * Toggles a font face at the current location or selection in a GTK IM/HTML. |
596 * | 596 * |
597 * @param imhtml The GTK IM/HTML. | 597 * @param imhtml The GTK IM/HTML. |
598 * @param face The font face name, or NULL or "" to clear the font. | 598 * @param face The font face name, or @c NULL or "" to clear the font. |
599 * | 599 * |
600 * @return @c TRUE if a font name was set, or @c FALSE if it was cleared. | 600 * @return @c TRUE if a font name was set, or @c FALSE if it was cleared. |
601 */ | 601 */ |
602 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face); | 602 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face); |
603 | 603 |
604 /** | 604 /** |
605 * Toggles a link tag with the given URL at the current location or selection | 605 * Toggles a link tag with the given URL at the current location or selection |
606 * in a GTK IM/HTML. | 606 * in a GTK IM/HTML. |
607 * | 607 * |
608 * @param imhtml The GTK IM/HTML. | 608 * @param imhtml The GTK IM/HTML. |
609 * @param url The URL for the link or NULL to terminate the link. | 609 * @param url The URL for the link or @c NULL to terminate the link. |
610 */ | 610 */ |
611 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url); | 611 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url); |
612 | 612 |
613 /** | 613 /** |
614 * Inserts a link to the given url at the given GtkTextMark in a GTK IM/HTML. | 614 * Inserts a link to the given url at the given GtkTextMark in a GTK IM/HTML. |
706 * Returns the entire unformatted (plain text) contents of a GTK IM/HTML | 706 * Returns the entire unformatted (plain text) contents of a GTK IM/HTML |
707 * between two iters in a GTK IM/HTML. | 707 * between two iters in a GTK IM/HTML. |
708 * | 708 * |
709 * @param imhtml The GTK IM/HTML. | 709 * @param imhtml The GTK IM/HTML. |
710 * @param start The GtkTextIter indicating the start point in the IM/HTML. | 710 * @param start The GtkTextIter indicating the start point in the IM/HTML. |
711 * @param end The GtkTextIter indicating the end point in the IM/HTML. | 711 * @param stop The GtkTextIter indicating the end point in the IM/HTML. |
712 * | 712 * |
713 * @return A string containing the unformatted text. | 713 * @return A string containing the unformatted text. |
714 */ | 714 */ |
715 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop); | 715 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop); |
716 | 716 |