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