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