annotate src/gtkimhtml.h @ 10161:f17e538bf9e0

[gaim-migrate @ 11247] it SUCKS to have to commit this note twice. but if it was true before, it is DOUBLY true now committer: Tailor Script <[e-mail]>

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