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