pidgin/gtkimhtml.h

   1 /**
   2  * @file gtkimhtml.h GTK+ IM/HTML rendering component
   3  * @ingroup pidgin
   4  * @see @ref gtkimhtml-signals
   5  */
   6
   7 /* Pidgin is the legal property of its developers, whose names are too numerous
   8  * to list here.  Please refer to the COPYRIGHT file distributed with this
   9  * source distribution.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  24  */
  25 #ifndef _PIDGINIMHTML_H_
  26 #define _PIDGINIMHTML_H_
  27
  28 #include <gdk/gdk.h>
  29 #include <gtk/gtktextview.h>
  30 #include <gtk/gtktooltips.h>
  31 #include <gtk/gtkimage.h>
  32 #include "gtksourceundomanager.h"
  33
  34 #include "connection.h"
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /**************************************************************************
  41  * @name Structures
  42  **************************************************************************/
  43 /*@{*/
  44
  45 #define GTK_TYPE_IMHTML            (gtk_imhtml_get_type ())
  46 #define GTK_IMHTML(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_IMHTML, GtkIMHtml))
  47 #define GTK_IMHTML_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMHTML, GtkIMHtmlClass))
  48 #define GTK_IS_IMHTML(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_IMHTML))
  49 #define GTK_IS_IMHTML_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMHTML))
  50 #define GTK_IMHTML_SCALABLE(obj)   ((GtkIMHtmlScalable *)obj)
  51 #define GTK_IMHTML_ANIMATION(obj)   ((GtkIMHtmlAnimation *)obj)
  52
  53 typedef struct _GtkIMHtml                       GtkIMHtml;
  54 typedef struct _GtkIMHtmlClass          GtkIMHtmlClass;
  55 typedef struct _GtkIMHtmlFontDetail     GtkIMHtmlFontDetail;    /* The five elements contained in a FONT tag */
  56 typedef struct _GtkSmileyTree           GtkSmileyTree;
  57 typedef struct _GtkIMHtmlSmiley         GtkIMHtmlSmiley;
  58 typedef struct _GtkIMHtmlScalable       GtkIMHtmlScalable;
  59 typedef struct _GtkIMHtmlImage          GtkIMHtmlImage;
  60 typedef struct _GtkIMHtmlAnimation      GtkIMHtmlAnimation;
  61 typedef struct _GtkIMHtmlHr                     GtkIMHtmlHr;
  62 typedef struct _GtkIMHtmlFuncs          GtkIMHtmlFuncs;
  63
  64 typedef enum {
  65         GTK_IMHTML_BOLD =       1 << 0,
  66         GTK_IMHTML_ITALIC =     1 << 1,
  67         GTK_IMHTML_UNDERLINE =  1 << 2,
  68         GTK_IMHTML_GROW =       1 << 3,
  69         GTK_IMHTML_SHRINK =     1 << 4,
  70         GTK_IMHTML_FACE =       1 << 5,
  71         GTK_IMHTML_FORECOLOR =  1 << 6,
  72         GTK_IMHTML_BACKCOLOR =  1 << 7,
  73         GTK_IMHTML_BACKGROUND = 1 << 8,
  74         GTK_IMHTML_LINK =       1 << 9,
  75         GTK_IMHTML_IMAGE =      1 << 10,
  76         GTK_IMHTML_SMILEY =     1 << 11,
  77         GTK_IMHTML_LINKDESC =   1 << 12,
  78         GTK_IMHTML_STRIKE =     1 << 13,
  79         /** Show custom smileys when appropriate. @since 2.5.0 */
  80         GTK_IMHTML_CUSTOM_SMILEY = 1 << 14,
  81         GTK_IMHTML_ALL =       -1
  82 } GtkIMHtmlButtons;
  83
  84 typedef enum {
  85         GTK_IMHTML_SMILEY_CUSTOM =      1 << 0
  86 } GtkIMHtmlSmileyFlags;
  87
  88 struct _GtkIMHtml {
  89         GtkTextView text_view;
  90         GtkTextBuffer *text_buffer;
  91         GdkCursor *hand_cursor;
  92         GdkCursor *arrow_cursor;
  93         GdkCursor *text_cursor;
  94         GHashTable *smiley_data;
  95         GtkSmileyTree *default_smilies;
  96         char *protocol_name;
  97         guint scroll_src;
  98         GTimer *scroll_time;
  99         GQueue *animations;
 100         int num_animations;
 101
 102         gboolean show_comments;
 103
 104         GtkWidget *tip_window;
 105         char *tip;
 106         guint tip_timer;
 107         GtkTextTag *prelit_tag;
 108
 109         GList *scalables;
 110         GdkRectangle old_rect;
 111
 112         gchar *search_string;
 113
 114         gboolean editable;
 115         GtkIMHtmlButtons format_functions;
 116         gboolean wbfo;  /* Whole buffer formatting only. */
 117
 118         gint insert_offset;
 119
 120         struct {
 121                 gboolean bold:1;
 122                 gboolean italic:1;
 123                 gboolean underline:1;
 124                 gboolean strike:1;
 125                 gchar *forecolor;
 126                 gchar *backcolor;
 127                 gchar *background;
 128                 gchar *fontface;
 129                 int fontsize;
 130                 GtkTextTag *link;
 131         } edit;
 132
 133 #if !(defined PIDGIN_DISABLE_DEPRECATED) || (defined _PIDGIN_GTKIMHTML_C_)
 134         /** @deprecated */
 135         char *clipboard_text_string;
 136         /** @deprecated */
 137         char *clipboard_html_string;
 138 #else
 139         char *depr1;
 140         char *depr2;
 141 #endif
 142
 143         GSList *im_images;
 144         GtkIMHtmlFuncs *funcs;
 145         GtkSourceUndoManager *undo_manager;
 146 };
 147
 148 struct _GtkIMHtmlClass {
 149         GtkTextViewClass parent_class;
 150
 151         void (*url_clicked)(GtkIMHtml *, const gchar *);
 152         void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
 153         void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
 154         void (*clear_format)(GtkIMHtml *);
 155         void (*update_format)(GtkIMHtml *);
 156         gboolean (*message_send)(GtkIMHtml *);
 157         void (*undo)(GtkIMHtml *);
 158         void (*redo)(GtkIMHtml *);
 159 };
 160
 161 struct _GtkIMHtmlFontDetail {
 162         gushort size;
 163         gchar *face;
 164         gchar *fore;
 165         gchar *back;
 166         gchar *bg;
 167         gchar *sml;
 168         gboolean underline;
 169         gshort bold;
 170 };
 171
 172 struct _GtkSmileyTree {
 173         GString *values;
 174         GtkSmileyTree **children;
 175         GtkIMHtmlSmiley *image;
 176 };
 177
 178 struct _GtkIMHtmlSmiley {
 179         gchar *smile;
 180         gchar *file;
 181         GdkPixbufAnimation *icon;
 182         gboolean hidden;
 183         GdkPixbufLoader *loader;
 184         GSList *anchors;
 185         GtkIMHtmlSmileyFlags flags;
 186         GtkIMHtml *imhtml;
 187 };
 188
 189 struct _GtkIMHtmlScalable {
 190         void (*scale)(struct _GtkIMHtmlScalable *, int, int);
 191         void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
 192         void (*free)(struct _GtkIMHtmlScalable *);
 193 };
 194
 195 struct _GtkIMHtmlImage {
 196         GtkIMHtmlScalable scalable;
 197         GtkImage *image; /**< Contains the scaled version of this pixbuf. */
 198         GdkPixbuf *pixbuf; /**< The original pixbuf, before any scaling. */
 199         GtkTextMark *mark;
 200         gchar *filename;
 201         int width;
 202         int height;
 203         int id;
 204         GtkWidget *filesel;
 205 };
 206
 207 struct _GtkIMHtmlAnimation {
 208         GtkIMHtmlImage imhtmlimage;
 209         GdkPixbufAnimation *anim; /**< The original animation, before any scaling. */
 210         GdkPixbufAnimationIter *iter;
 211         guint timer;
 212 };
 213
 214 struct _GtkIMHtmlHr {
 215         GtkIMHtmlScalable scalable;
 216         GtkWidget *sep;
 217 };
 218
 219 typedef enum {
 220         GTK_IMHTML_NO_COLOURS          = 1 << 0,
 221         GTK_IMHTML_NO_FONTS            = 1 << 1,
 222         GTK_IMHTML_NO_COMMENTS         = 1 << 2, /* Remove */
 223         GTK_IMHTML_NO_TITLE            = 1 << 3,
 224         GTK_IMHTML_NO_NEWLINE          = 1 << 4,
 225         GTK_IMHTML_NO_SIZES            = 1 << 5,
 226         GTK_IMHTML_NO_SCROLL           = 1 << 6,
 227         GTK_IMHTML_RETURN_LOG          = 1 << 7,
 228         GTK_IMHTML_USE_POINTSIZE       = 1 << 8,
 229         GTK_IMHTML_NO_FORMATTING       = 1 << 9,
 230         GTK_IMHTML_USE_SMOOTHSCROLLING = 1 << 10,
 231         GTK_IMHTML_NO_SMILEY           = 1 << 11,
 232 } GtkIMHtmlOptions;
 233
 234 enum {
 235         GTK_IMHTML_DRAG_URL = 0,
 236         GTK_IMHTML_DRAG_HTML,
 237         GTK_IMHTML_DRAG_UTF8_STRING,
 238         GTK_IMHTML_DRAG_COMPOUND_TEXT,
 239         GTK_IMHTML_DRAG_STRING,
 240         GTK_IMHTML_DRAG_TEXT,
 241         GTK_IMHTML_DRAG_NUM
 242 };
 243
 244 #define GTK_IMHTML_DND_TARGETS  \
 245         { "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
 246         { "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
 247         { "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
 248         { "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
 249         { "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
 250         { "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
 251         { "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
 252         { "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
 253         { "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
 254         { "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
 255
 256 typedef gpointer    (*GtkIMHtmlGetImageFunc)        (int id);
 257 typedef gpointer    (*GtkIMHtmlGetImageDataFunc)    (gpointer i);
 258 typedef size_t      (*GtkIMHtmlGetImageSizeFunc)    (gpointer i);
 259 typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
 260 typedef void        (*GtkIMHtmlImageRefFunc)        (int id);
 261 typedef void        (*GtkIMHtmlImageUnrefFunc)      (int id);
 262
 263 struct _GtkIMHtmlFuncs {
 264         GtkIMHtmlGetImageFunc image_get;
 265         GtkIMHtmlGetImageDataFunc image_get_data;
 266         GtkIMHtmlGetImageSizeFunc image_get_size;
 267         GtkIMHtmlGetImageFilenameFunc image_get_filename;
 268         GtkIMHtmlImageRefFunc image_ref;
 269         GtkIMHtmlImageUnrefFunc image_unref;
 270 };
 271
 272 /*@}*/
 273
 274 /**************************************************************************
 275  * @name GTK+ IM/HTML rendering component API
 276  **************************************************************************/
 277 /*@{*/
 278
 279 /**
 280  * Returns the GType object for an IM/HTML widget.
 281  *
 282  * @return The GType for an IM/HTML widget.
 283  */
 284 GType gtk_imhtml_get_type(void);
 285
 286 /**
 287  * Creates and returns a new GTK+ IM/HTML widget.
 288  *
 289  * @return The GTK+ IM/HTML widget created.
 290  */
 291 GtkWidget *gtk_imhtml_new(void *, void *);
 292
 293 /**
 294  * Returns the smiley object associated with the text.
 295  *
 296  * @param imhtml The GTK+ IM/HTML.
 297  * @param sml    The name of the smiley category.
 298  * @param text   The text associated with the smiley.
 299  */
 300
 301 GtkIMHtmlSmiley *gtk_imhtml_smiley_get(GtkIMHtml * imhtml,
 302                                         const gchar * sml, const gchar * text);
 303
 304
 305 /**
 306  * Associates a smiley with a GTK+ IM/HTML.
 307  *
 308  * @param imhtml The GTK+ IM/HTML.
 309  * @param sml    The name of the smiley category.
 310  * @param smiley The GtkIMSmiley to associate.
 311  */
 312 void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, const gchar *sml, GtkIMHtmlSmiley *smiley);
 313
 314 /**
 315  * Removes all smileys associated with a GTK+ IM/HTML.
 316  *
 317  * @param imhtml The GTK+ IM/HTML.
 318  */
 319 void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
 320
 321 /**
 322  * Sets the function callbacks to use with a GTK+ IM/HTML instance.
 323  *
 324  * @param imhtml The GTK+ IM/HTML.
 325  * @param f      The GtkIMHTMLFuncs struct containing the functions to use.
 326  */
 327 void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
 328
 329 /**
 330  * Enables or disables showing the contents of HTML comments in a GTK+ IM/HTML.
 331  *
 332  * @param imhtml The GTK+ IM/HTML.
 333  * @param show   @c TRUE if comments should be shown, or @c FALSE otherwise.
 334  */
 335 void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
 336
 337 /**
 338  * Gets the protocol name associated with this GTK+ IM/HTML.
 339  *
 340  * @param imhtml The GTK+ IM/HTML
 341  */
 342 const char *gtk_imhtml_get_protocol_name(GtkIMHtml *imhtml);
 343
 344 /**
 345  * Associates a protocol name with a GTK+ IM/HTML.
 346  *
 347  * @param imhtml        The GTK+ IM/HTML.
 348  * @param protocol_name The protocol name to associate with the IM/HTML.
 349  */
 350 void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
 351
 352 /**
 353  * Appends HTML formatted text to a GTK+ IM/HTML.
 354  *
 355  * @param imhtml  The GTK+ IM/HTML.
 356  * @param text    The formatted text to append.
 357  * @param options A GtkIMHtmlOptions object indicating insert behavior.
 358  */
 359 #define gtk_imhtml_append_text(imhtml, text, options) \
 360  gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
 361
 362 /**
 363  * Appends HTML formatted text to a GTK+ IM/HTML.
 364  *
 365  * @param imhtml  The GTK+ IM/HTML.
 366  * @param text    The formatted text to append.
 367  * @param options A GtkIMHtmlOptions object indicating insert behavior.
 368  * @param unused  Use @c NULL value.
 369  */
 370 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
 371                                          const gchar *text,
 372                                          GtkIMHtmlOptions options,
 373                                          GSList *unused);
 374
 375 /**
 376  * Inserts HTML formatted text to a GTK+ IM/HTML at a given iter.
 377  *
 378  * @param imhtml  The GTK+ IM/HTML.
 379  * @param text    The formatted text to append.
 380  * @param options A GtkIMHtmlOptions object indicating insert behavior.
 381  * @param iter    A GtkTextIter in the GTK+ IM/HTML at which to insert text.
 382  */
 383 void gtk_imhtml_insert_html_at_iter(GtkIMHtml        *imhtml,
 384                                     const gchar      *text,
 385                                     GtkIMHtmlOptions  options,
 386                                     GtkTextIter      *iter);
 387
 388 /**
 389  * Scrolls a GTK+ IM/HTML to the end of its contents.
 390  *
 391  * @param imhtml  The GTK+ IM/HTML.
 392  * @param smooth  A boolean indicating if smooth scrolling should be used.
 393  */
 394 void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml, gboolean smooth);
 395
 396 /**
 397  * Delete the contents of a GTK+ IM/HTML between start and end.
 398  *
 399  * @param imhtml  The GTK+ IM/HTML.
 400  * @param start   a postition in the imhtml's buffer
 401  * @param end     another postition in the imhtml's buffer
 402  */
 403 void gtk_imhtml_delete(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
 404
 405 /**
 406  * Purges the contents from a GTK+ IM/HTML and resets formatting.
 407  *
 408  * @param imhtml  The GTK+ IM/HTML.
 409  */
 410 #define gtk_imhtml_clear(imhtml) \
 411  gtk_imhtml_delete(imhtml, NULL, NULL)
 412
 413 /**
 414  * Scrolls a GTK+ IM/HTML up by one page.
 415  *
 416  * @param imhtml  The GTK+ IM/HTML.
 417  */
 418 void gtk_imhtml_page_up(GtkIMHtml *imhtml);
 419
 420 /**
 421  * Scrolls a GTK+ IM/HTML down by one page.
 422  *
 423  * @param imhtml  The GTK+ IM/HTML.
 424  */
 425 void gtk_imhtml_page_down(GtkIMHtml *imhtml);
 426
 427 /**
 428  * Creates and returns an new GTK+ IM/HTML scalable object.
 429  *
 430  * @return A new IM/HTML Scalable object.
 431  */
 432 GtkIMHtmlScalable *gtk_imhtml_scalable_new(void);
 433
 434 /**
 435  * Creates and returns a new GTK+ IM/HTML scalable object with an image.
 436  *
 437  * @param img      A GdkPixbuf of the image to add.
 438  * @param filename The filename to associate with the image.
 439  * @param id       The id to associate with the image.
 440  *
 441  * @return A new IM/HTML Scalable object with an image.
 442  */
 443 GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
 444
 445 /**
 446  * Creates and returns a new GTK+ IM/HTML scalable object with an
 447  * animated image.
 448  *
 449  * @param img      A GdkPixbufAnimation of the image to add.
 450  * @param filename The filename to associate with the image.
 451  * @param id       The id to associate with the image.
 452  *
 453  * @return A new IM/HTML Scalable object with an image.
 454  *
 455  * @since 2.1.0
 456  */
 457 /*
 458  * TODO: All this animation code could be combined much better with
 459  *       the image code.  It couldn't be done when it was written
 460  *       because it requires breaking backward compatibility.  It
 461  *       would be good to do it for 3.0.0.
 462  */
 463 GtkIMHtmlScalable *gtk_imhtml_animation_new(GdkPixbufAnimation *img, const gchar *filename, int id);
 464
 465 /**
 466  * Destroys and frees a GTK+ IM/HTML scalable image.
 467  *
 468  * @param scale The GTK+ IM/HTML scalable.
 469  */
 470 /* TODO: Is there any reason this isn't private? */
 471 void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
 472
 473 /**
 474  * Destroys and frees a GTK+ IM/HTML scalable animation.
 475  *
 476  * @param scale The GTK+ IM/HTML scalable.
 477  */
 478 /* TODO: Is there any reason this isn't private? */
 479 void gtk_imhtml_animation_free(GtkIMHtmlScalable *scale);
 480
 481 /**
 482  * Rescales a GTK+ IM/HTML scalable image to a given size.
 483  *
 484  * @param scale  The GTK+ IM/HTML scalable.
 485  * @param width  The new width.
 486  * @param height The new height.
 487  */
 488 /* TODO: Is there any reason this isn't private? */
 489 void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
 490
 491 /**
 492  * Adds a GTK+ IM/HTML scalable image to a given GTK+ IM/HTML at a given iter.
 493  *
 494  * @param scale  The GTK+ IM/HTML scalable.
 495  * @param imhtml The GTK+ IM/HTML.
 496  * @param iter   The GtkTextIter at which to add the scalable.
 497  */
 498 /* TODO: Is there any reason this isn't private? */
 499 void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
 500
 501 /**
 502  * Creates and returns an new GTK+ IM/HTML scalable with a horizontal rule.
 503  *
 504  * @return A new IM/HTML Scalable object with an image.
 505  */
 506 GtkIMHtmlScalable *gtk_imhtml_hr_new(void);
 507
 508 /**
 509  * Destroys and frees a GTK+ IM/HTML scalable horizontal rule.
 510  *
 511  * @param scale The GTK+ IM/HTML scalable.
 512  */
 513 void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
 514
 515 /**
 516  * Rescales a GTK+ IM/HTML scalable horizontal rule to a given size.
 517  *
 518  * @param scale  The GTK+ IM/HTML scalable.
 519  * @param width  The new width.
 520  * @param height The new height.
 521  */
 522 void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
 523
 524 /**
 525  * Adds a GTK+ IM/HTML scalable horizontal rule to a given GTK+ IM/HTML at
 526  * a given iter.
 527  *
 528  * @param scale  The GTK+ IM/HTML scalable.
 529  * @param imhtml The GTK+ IM/HTML.
 530  * @param iter   The GtkTextIter at which to add the scalable.
 531  */
 532 void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
 533
 534 /**
 535  * Finds and highlights a given string in a GTK+ IM/HTML.
 536  *
 537  * @param imhtml The GTK+ IM/HTML.
 538  * @param text   The string to search for.
 539  *
 540  * @return @c TRUE if a search was performed, or @c FALSE if not.
 541  */
 542 gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
 543
 544 /**
 545  * Clears the highlighting from a prior search in a GTK+ IM/HTML.
 546  *
 547  * @param imhtml The GTK+ IM/HTML.
 548  */
 549 void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
 550
 551 /**
 552  * Enables or disables editing in a GTK+ IM/HTML.
 553  *
 554  * @param imhtml   The GTK+ IM/HTML.
 555  * @param editable @c TRUE to make the widget editable, or @c FALSE otherwise.
 556  */
 557 void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
 558
 559 /**
 560  * Enables or disables whole buffer formatting only (wbfo) in a GTK+ IM/HTML.
 561  * In this mode formatting options to the buffer take effect for the entire
 562  * buffer instead of specific text.
 563  *
 564  * @param imhtml The GTK+ IM/HTML.
 565  * @param wbfo   @c TRUE to enable the mode, or @c FALSE otherwise.
 566  */
 567 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
 568
 569 /**
 570  * Indicates which formatting functions to enable and disable in a GTK+ IM/HTML.
 571  *
 572  * @param imhtml  The GTK+ IM/HTML.
 573  * @param buttons A GtkIMHtmlButtons bitmask indicating which functions to use.
 574  */
 575 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
 576
 577 /**
 578  * Returns which formatting functions are enabled in a GTK+ IM/HTML.
 579  *
 580  * @param imhtml The GTK+ IM/HTML.
 581  *
 582  * @return A GtkIMHtmlButtons bitmask indicating which functions to are enabled.
 583  */
 584 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
 585
 586 /**
 587  * Sets each boolean to @c TRUE or @c FALSE to indicate if that formatting option
 588  * is enabled at the current position in a GTK+ IM/HTML.
 589  *
 590  * @param imhtml    The GTK+ IM/HTML.
 591  * @param bold      The boolean to set for bold or @c NULL.
 592  * @param italic    The boolean to set for italic or @c NULL.
 593  * @param underline The boolean to set for underline or @c NULL.
 594  */
 595 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
 596
 597 /**
 598  * Returns a string containing the selected font face at the current position
 599  * in a GTK+ IM/HTML.
 600  *
 601  * @param imhtml The GTK+ IM/HTML.
 602  *
 603  * @return A string containg the font face or @c NULL if none is set.
 604  */
 605 char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
 606
 607 /**
 608  * Returns a string containing the selected foreground color at the current
 609  * position in a GTK+ IM/HTML.
 610  *
 611  * @param imhtml The GTK+ IM/HTML.
 612  *
 613  * @return A string containg the foreground color or @c NULL if none is set.
 614  */
 615 char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
 616
 617 /**
 618  * Returns a string containing the selected font background color at the current
 619  * position in a GTK+ IM/HTML.
 620  *
 621  * @param imhtml The GTK+ IM/HTML.
 622  *
 623  * @return A string containg the font background color or @c NULL if none is set.
 624  */
 625 char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
 626
 627 /**
 628  * Returns a string containing the selected background color at the current
 629  * position in a GTK+ IM/HTML.
 630  *
 631  * @param imhtml The GTK+ IM/HTML.
 632  *
 633  * @return A string containg the background color or @c NULL if none is set.
 634  */
 635 char *gtk_imhtml_get_current_background(GtkIMHtml *imhtml);
 636
 637 /**
 638  * Returns a integer containing the selected HTML font size at the current
 639  * position in a GTK+ IM/HTML.
 640  *
 641  * @param imhtml The GTK+ IM/HTML.
 642  *
 643  * @return The HTML font size.
 644  */
 645 gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
 646
 647 /**
 648  * Checks whether a GTK+ IM/HTML is marked as editable.
 649  *
 650  * @param imhtml The GTK+ IM/HTML.
 651  *
 652  * @return @c TRUE if the IM/HTML is editable, or @c FALSE otherwise.
 653  */
 654 gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
 655
 656 /**
 657  * Clear all the formatting on a GTK+ IM/HTML.
 658  *
 659  * @param imhtml The GTK+ IM/HTML.
 660  */
 661 void gtk_imhtml_clear_formatting(GtkIMHtml *imhtml);
 662
 663 /**
 664  * Toggles bold at the cursor location or selection in a GTK+ IM/HTML.
 665  *
 666  * @param imhtml The GTK+ IM/HTML.
 667  */
 668 void gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
 669
 670 /**
 671  * Toggles italic at the cursor location or selection in a GTK+ IM/HTML.
 672  *
 673  * @param imhtml The GTK+ IM/HTML.
 674  */
 675 void gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
 676
 677 /**
 678  * Toggles underline at the cursor location or selection in a GTK+ IM/HTML.
 679  *
 680  * @param imhtml The GTK+ IM/HTML.
 681  */
 682 void gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
 683
 684 /**
 685  * Toggles strikethrough at the cursor location or selection in a GTK+ IM/HTML.
 686  *
 687  * @param imhtml The GTK+ IM/HTML.
 688  */
 689 void gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
 690
 691 /**
 692  * Toggles a foreground color at the current location or selection in a GTK
 693  * IM/HTML.
 694  *
 695  * @param imhtml The GTK+ IM/HTML.
 696  * @param color  The HTML-style color, or @c NULL or "" to clear the color.
 697  *
 698  * @return @c TRUE if a color was set, or @c FALSE if it was cleared.
 699  */
 700 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
 701
 702 /**
 703  * Toggles a background color at the current location or selection in a GTK
 704  * IM/HTML.
 705  *
 706  * @param imhtml The GTK+ IM/HTML.
 707  * @param color  The HTML-style color, or @c NULL or "" to clear the color.
 708  *
 709  * @return @c TRUE if a color was set, or @c FALSE if it was cleared.
 710  */
 711 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
 712
 713 /**
 714  * Toggles a background color at the current location or selection in a GTK
 715  * IM/HTML.
 716  *
 717  * @param imhtml The GTK+ IM/HTML.
 718  * @param color  The HTML-style color, or @c NULL or "" to clear the color.
 719  *
 720  * @return @c TRUE if a color was set, or @c FALSE if it was cleared.
 721  */
 722 gboolean gtk_imhtml_toggle_background(GtkIMHtml *imhtml, const char *color);
 723
 724 /**
 725  * Toggles a font face at the current location or selection in a GTK+ IM/HTML.
 726  *
 727  * @param imhtml The GTK+ IM/HTML.
 728  * @param face   The font face name, or @c NULL or "" to clear the font.
 729  *
 730  * @return @c TRUE if a font name was set, or @c FALSE if it was cleared.
 731  */
 732 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
 733
 734 /**
 735  * Toggles a link tag with the given URL at the current location or selection
 736  * in a GTK+ IM/HTML.
 737  *
 738  * @param imhtml The GTK+ IM/HTML.
 739  * @param url    The URL for the link or @c NULL to terminate the link.
 740  */
 741 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
 742
 743 /**
 744  * Inserts a link to the given url at the given GtkTextMark in a GTK+ IM/HTML.
 745  *
 746  * @param imhtml The GTK+ IM/HTML.
 747  * @param mark   The GtkTextMark to insert the link at.
 748  * @param url    The URL for the link.
 749  * @param text   The string to use for the link description.
 750  */
 751 void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
 752
 753 /**
 754  * Inserts a smiley at the current location or selection in a GTK+ IM/HTML.
 755  *
 756  * @param imhtml The GTK+ IM/HTML.
 757  * @param sml    The category of the smiley.
 758  * @param smiley The text of the smiley to insert.
 759  */
 760 void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
 761 /**
 762  * Inserts a smiley at the given iter in a GTK+ IM/HTML.
 763  *
 764  * @param imhtml The GTK+ IM/HTML.
 765  * @param sml    The category of the smiley.
 766  * @param smiley The text of the smiley to insert.
 767  * @param iter   The GtkTextIter in the IM/HTML to insert the smiley at.
 768  */
 769 void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
 770
 771 /**
 772  * Inserts the IM/HTML scalable image with the given id at the given iter in a
 773  * GTK+ IM/HTML.
 774  *
 775  * @param imhtml The GTK+ IM/HTML.
 776  * @param id     The id of the IM/HTML scalable.
 777  * @param iter   The GtkTextIter in the IM/HTML to insert the image at.
 778  */
 779 void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
 780
 781 /**
 782  * Sets the font size at the current location or selection in a GTK+ IM/HTML.
 783  *
 784  * @param imhtml The GTK+ IM/HTML.
 785  * @param size   The HTML font size to use.
 786  */
 787 void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
 788
 789 /**
 790  * Decreases the font size by 1 at the current location or selection in a GTK
 791  * IM/HTML.
 792  *
 793  * @param imhtml The GTK+ IM/HTML.
 794  */
 795 void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
 796
 797 /**
 798  * Increases the font size by 1 at the current location or selection in a GTK
 799  * IM/HTML.
 800  *
 801  * @param imhtml The GTK+ IM/HTML.
 802  */
 803 void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
 804
 805 /**
 806  * Returns the HTML formatted contents between two iters in a GTK+ IM/HTML.
 807  *
 808  * @param imhtml The GTK+ IM/HTML.
 809  * @param start  The GtkTextIter indicating the start point in the IM/HTML.
 810  * @param end    The GtkTextIter indicating the end point in the IM/HTML.
 811  *
 812  * @return A string containing the HTML formatted text.
 813  */
 814 char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
 815
 816 /**
 817  * Returns the entire HTML formatted contents of a GTK+ IM/HTML.
 818  *
 819  * @param imhtml The GTK+ IM/HTML.
 820  *
 821  * @return A string containing the HTML formatted text.
 822  */
 823 char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
 824
 825 /**
 826  * Returns a null terminated array of pointers to null terminated strings, each
 827  * string for each line.  g_strfreev() should be called to free it when done.
 828  *
 829  * @param imhtml The GTK+ IM/HTML.
 830  *
 831  * @return A null terminated array of null terminated HTML formatted strings.
 832  */
 833 char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
 834
 835 /**
 836  * Returns the entire unformatted (plain text) contents of a GTK+ IM/HTML
 837  * between two iters in a GTK+ IM/HTML.
 838  *
 839  * @param imhtml The GTK+ IM/HTML.
 840  * @param start  The GtkTextIter indicating the start point in the IM/HTML.
 841  * @param stop   The GtkTextIter indicating the end point in the IM/HTML.
 842  *
 843  * @return A string containing the unformatted text.
 844  */
 845 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
 846
 847 /**
 848  * Setup formatting for an imhtml depending on the flags specified.
 849  *
 850  * @param imhtml  The GTK+ IM/HTML.
 851  * @param flags   The connection flag which describes the allowed types of formatting.
 852  *
 853  * @since 2.1.0
 854  */
 855 void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
 856
 857 /**
 858  * Create a new GtkIMHtmlSmiley.
 859  *
 860  * @param file       The image file for the smiley
 861  * @param shortcut   The key shortcut for the smiley
 862  * @param hide       @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise
 863  * @param flags      The smiley flags
 864  *
 865  * @return The newly created smiley
 866  * @since 2.5.0
 867  */
 868 GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
 869                 GtkIMHtmlSmileyFlags flags);
 870
 871 /**
 872  * Reload the image data for the smiley.
 873  *
 874  * @param smiley   The smiley to reload
 875  *
 876  * @since 2.5.0
 877  */
 878 void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
 879
 880 /**
 881  * Destroy a GtkIMHtmlSmiley.
 882  *
 883  * @param smiley   The smiley to destroy
 884  *
 885  * @since 2.5.0
 886  */
 887 void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
 888 /*@}*/
 889
 890 #ifdef __cplusplus
 891 }
 892 #endif
 893
 894 #endif /* _PIDGINIMHTML_H_ */