gtkimhtml.h

Go to the documentation of this file.
00001 
00023 #ifndef _GAIM_GTKIMHTML_H_
00024 #define _GAIM_GTKIMHTML_H_
00025 
00026 #include <gdk/gdk.h>
00027 #include <gtk/gtktextview.h>
00028 #include <gtk/gtktooltips.h>
00029 #include <gtk/gtkimage.h>
00030 
00031 #ifdef __cplusplus
00032 extern "C" {
00033 #endif
00034 
00035 /**************************************************************************
00036  * @name Structures
00037  **************************************************************************/
00040 #define GTK_TYPE_IMHTML            (gtk_imhtml_get_type ())
00041 #define GTK_IMHTML(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_IMHTML, GtkIMHtml))
00042 #define GTK_IMHTML_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMHTML, GtkIMHtmlClass))
00043 #define GTK_IS_IMHTML(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_IMHTML))
00044 #define GTK_IS_IMHTML_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMHTML))
00045 #define GTK_IMHTML_SCALABLE(obj)   ((GtkIMHtmlScalable *)obj)
00046 
00047 typedef struct _GtkIMHtml           GtkIMHtml;
00048 typedef struct _GtkIMHtmlClass      GtkIMHtmlClass;
00049 typedef struct _GtkIMHtmlFontDetail GtkIMHtmlFontDetail;    /* The five elements contained in a FONT tag */
00050 typedef struct _GtkSmileyTree       GtkSmileyTree;
00051 typedef struct _GtkIMHtmlSmiley     GtkIMHtmlSmiley;
00052 typedef struct _GtkIMHtmlScalable   GtkIMHtmlScalable;
00053 typedef struct _GtkIMHtmlImage      GtkIMHtmlImage;
00054 typedef struct _GtkIMHtmlHr         GtkIMHtmlHr;
00055 typedef struct _GtkIMHtmlFuncs      GtkIMHtmlFuncs;
00056 
00057 typedef enum {
00058     GTK_IMHTML_BOLD =      1 << 0,
00059     GTK_IMHTML_ITALIC =    1 << 1,
00060     GTK_IMHTML_UNDERLINE = 1 << 2,
00061     GTK_IMHTML_GROW =      1 << 3,
00062     GTK_IMHTML_SHRINK =    1 << 4,
00063     GTK_IMHTML_FACE =      1 << 5,
00064     GTK_IMHTML_FORECOLOR = 1 << 6,
00065     GTK_IMHTML_BACKCOLOR = 1 << 7,
00066     GTK_IMHTML_LINK =      1 << 8,
00067     GTK_IMHTML_IMAGE =     1 << 9,
00068     GTK_IMHTML_SMILEY =    1 << 10,
00069     GTK_IMHTML_LINKDESC =  1 << 11,
00070     GTK_IMHTML_STRIKE =    1 << 12,
00071     GTK_IMHTML_ALL =      -1
00072 } GtkIMHtmlButtons;
00073 
00074 struct _GtkIMHtml {
00075     GtkTextView text_view;
00076     GtkTextBuffer *text_buffer;
00077     GtkTextMark *scrollpoint;
00078     GdkCursor *hand_cursor;
00079     GdkCursor *arrow_cursor;
00080     GdkCursor *text_cursor;
00081     GHashTable *smiley_data;
00082     GtkSmileyTree *default_smilies;
00083     char *protocol_name;
00084 
00085     gboolean show_comments;
00086 
00087     gboolean html_shortcuts;
00088     gboolean smiley_shortcuts;
00089 
00090     GtkWidget *tip_window;
00091     char *tip;
00092     guint tip_timer;
00093 
00094     GList *scalables;
00095     GdkRectangle old_rect;
00096 
00097     gchar *search_string;
00098 
00099     gboolean editable;
00100     GtkIMHtmlButtons format_functions;
00101     gboolean wbfo;  /* Whole buffer formatting only. */
00102 
00103     gint insert_offset;
00104 
00105     struct {
00106         gboolean bold:1;
00107         gboolean italic:1;
00108         gboolean underline:1;
00109         gboolean strike:1;
00110         gchar *forecolor;
00111         gchar *backcolor;
00112         gchar *fontface;
00113         int fontsize;
00114         GtkTextTag *link;
00115     } edit;
00116 
00117     double zoom;
00118     int original_fsize;
00119 
00120     char *clipboard_text_string;
00121     char *clipboard_html_string;
00122 
00123     GSList *im_images;
00124     GtkIMHtmlFuncs *funcs;
00125     guint scroll_src;
00126 };
00127 
00128 struct _GtkIMHtmlClass {
00129     GtkTextViewClass parent_class;
00130 
00131     void (*url_clicked)(GtkIMHtml *, const gchar *);
00132     void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
00133     void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
00134     void (*clear_format)(GtkIMHtml *);
00135     void (*update_format)(GtkIMHtml *);
00136 };
00137 
00138 struct _GtkIMHtmlFontDetail {
00139     gushort size;
00140     gchar *face;
00141     gchar *fore;
00142     gchar *back;
00143     gchar *sml;
00144     gboolean underline;
00145 };
00146 
00147 struct _GtkSmileyTree {
00148     GString *values;
00149     GtkSmileyTree **children;
00150     GtkIMHtmlSmiley *image;
00151 };
00152 
00153 struct _GtkIMHtmlSmiley {
00154     gchar *smile;
00155     gchar *file;
00156     GdkPixbufAnimation *icon;
00157     gboolean hidden;
00158 };
00159 
00160 struct _GtkIMHtmlScalable {
00161     void (*scale)(struct _GtkIMHtmlScalable *, int, int);
00162     void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
00163     void (*free)(struct _GtkIMHtmlScalable *);
00164 };
00165 
00166 struct _GtkIMHtmlImage {
00167     GtkIMHtmlScalable scalable;
00168     GtkImage *image;
00169     GdkPixbuf *pixbuf;
00170     GtkTextMark *mark;
00171     gchar *filename;
00172     int width;
00173     int height;
00174     int id;
00175     GtkWidget *filesel;
00176 };
00177 
00178 struct _GtkIMHtmlHr {
00179     GtkIMHtmlScalable scalable;
00180     GtkWidget *sep;
00181 };
00182 
00183 typedef enum {
00184     GTK_IMHTML_NO_COLOURS    = 1 << 0,
00185     GTK_IMHTML_NO_FONTS      = 1 << 1,
00186     GTK_IMHTML_NO_COMMENTS   = 1 << 2, /* Remove */
00187     GTK_IMHTML_NO_TITLE      = 1 << 3,
00188     GTK_IMHTML_NO_NEWLINE    = 1 << 4,
00189     GTK_IMHTML_NO_SIZES      = 1 << 5,
00190     GTK_IMHTML_NO_SCROLL     = 1 << 6,
00191     GTK_IMHTML_RETURN_LOG    = 1 << 7,
00192     GTK_IMHTML_USE_POINTSIZE = 1 << 8
00193 } GtkIMHtmlOptions;
00194 
00195 enum {
00196     GTK_IMHTML_DRAG_URL = 0,
00197     GTK_IMHTML_DRAG_HTML,
00198     GTK_IMHTML_DRAG_UTF8_STRING,
00199     GTK_IMHTML_DRAG_COMPOUND_TEXT,
00200     GTK_IMHTML_DRAG_STRING,
00201     GTK_IMHTML_DRAG_TEXT,
00202     GTK_IMHTML_DRAG_NUM
00203 };
00204 
00205 #define GTK_IMHTML_DND_TARGETS  \
00206     { "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
00207     { "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
00208     { "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
00209     { "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
00210     { "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
00211     { "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
00212     { "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
00213     { "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
00214     { "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
00215     { "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
00216 
00217 typedef gpointer    (*GtkIMHtmlGetImageFunc)        (int id);
00218 typedef gpointer    (*GtkIMHtmlGetImageDataFunc)    (gpointer i);
00219 typedef size_t      (*GtkIMHtmlGetImageSizeFunc)    (gpointer i);
00220 typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
00221 typedef void        (*GtkIMHtmlImageRefFunc)        (int id);
00222 typedef void        (*GtkIMHtmlImageUnrefFunc)      (int id);
00223 
00224 struct _GtkIMHtmlFuncs {
00225     GtkIMHtmlGetImageFunc image_get;
00226     GtkIMHtmlGetImageDataFunc image_get_data;
00227     GtkIMHtmlGetImageSizeFunc image_get_size;
00228     GtkIMHtmlGetImageFilenameFunc image_get_filename;
00229     GtkIMHtmlImageRefFunc image_ref;
00230     GtkIMHtmlImageUnrefFunc image_unref;
00231 };
00232 
00235 /**************************************************************************
00236  * @name GTK+ IM/HTML rendering component API
00237  **************************************************************************/
00245 GType gtk_imhtml_get_type(void);
00246 
00252 GtkWidget *gtk_imhtml_new(void *, void *);
00253 
00261 void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, gchar *sml, GtkIMHtmlSmiley *smiley);
00262 
00268 void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
00269 
00276 void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
00277 
00284 void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
00285 
00292 void gtk_imhtml_html_shortcuts(GtkIMHtml *imhtml, gboolean allow);
00293 
00300 void gtk_imhtml_smiley_shortcuts(GtkIMHtml *imhtml, gboolean allow);
00301 
00308 void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
00309 
00317 #define gtk_imhtml_append_text(imhtml, text, options) \
00318  gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
00319 
00328 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
00329                                          const gchar *text,
00330                                          GtkIMHtmlOptions options,
00331                                          GSList *unused);
00332 
00341 void gtk_imhtml_insert_html_at_iter(GtkIMHtml        *imhtml,
00342                                     const gchar      *text,
00343                                     GtkIMHtmlOptions  options,
00344                                     GtkTextIter      *iter);
00345 
00351 void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml);
00352 
00358 void gtk_imhtml_clear(GtkIMHtml *imhtml);
00359 
00365 void gtk_imhtml_page_up(GtkIMHtml *imhtml);
00366 
00372 void gtk_imhtml_page_down(GtkIMHtml *imhtml);
00373 
00380 void gtk_imhtml_font_zoom(GtkIMHtml *imhtml, double zoom);
00381 
00387 GtkIMHtmlScalable *gtk_imhtml_scalable_new();
00388 
00398 GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
00399 
00405 void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
00406 
00414 void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
00415 
00423 void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00424 
00430 GtkIMHtmlScalable *gtk_imhtml_hr_new();
00431 
00437 void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
00438 
00446 void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
00447 
00456 void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00457 
00466 gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
00467 
00473 void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
00474 
00481 void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
00482 
00491 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
00492 
00499 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
00500 
00508 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
00509 
00519 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
00520 
00529 char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
00530 
00539 char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
00540 
00549 char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
00550 
00559 gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
00560 
00568 gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
00569 
00577 gboolean gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
00578 
00586 gboolean gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
00587 
00595 gboolean gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
00596 
00604 gboolean gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
00605 
00615 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
00616 
00626 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
00627 
00636 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
00637 
00645 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
00646 
00655 void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
00656 
00664 void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
00673 void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
00674 
00683 void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
00684 
00691 void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
00692 
00699 void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
00700 
00707 void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
00708 
00718 char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00719 
00727 char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
00728 
00737 char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
00738 
00749 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
00750 
00753 #ifdef __cplusplus
00754 }
00755 #endif
00756 
00757 #endif /* _GAIM_GTKIMHTML_H_ */

Generated on Sun Feb 18 07:36:17 2007 for gaim by  doxygen 1.5.1