gtkimhtml.h

Go to the documentation of this file.
00001 
00023 #ifndef _PIDGINIMHTML_H_
00024 #define _PIDGINIMHTML_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_BACKGROUND = 1 << 8,
00067     GTK_IMHTML_LINK =       1 << 9,
00068     GTK_IMHTML_IMAGE =      1 << 10,
00069     GTK_IMHTML_SMILEY =     1 << 11,
00070     GTK_IMHTML_LINKDESC =   1 << 12,
00071     GTK_IMHTML_STRIKE =     1 << 13,
00072     GTK_IMHTML_ALL =       -1
00073 } GtkIMHtmlButtons;
00074 
00075 typedef enum {
00076     GTK_IMHTML_SMILEY_CUSTOM =  1 << 0
00077 } GtkIMHtmlSmileyFlags;
00078 
00079 struct _GtkIMHtml {
00080     GtkTextView text_view;
00081     GtkTextBuffer *text_buffer;
00082     GdkCursor *hand_cursor;
00083     GdkCursor *arrow_cursor;
00084     GdkCursor *text_cursor;
00085     GHashTable *smiley_data;
00086     GtkSmileyTree *default_smilies;
00087     char *protocol_name;
00088     guint scroll_src;
00089     GTimer *scroll_time;
00090     GQueue *animations;
00091     int num_animations;
00092 
00093     gboolean show_comments;
00094 
00095     GtkWidget *tip_window;
00096     char *tip;
00097     guint tip_timer;
00098     GtkTextTag *prelit_tag;
00099 
00100     GList *scalables;
00101     GdkRectangle old_rect;
00102 
00103     gchar *search_string;
00104 
00105     gboolean editable;
00106     GtkIMHtmlButtons format_functions;
00107     gboolean wbfo;  /* Whole buffer formatting only. */
00108 
00109     gint insert_offset;
00110 
00111     struct {
00112         gboolean bold:1;
00113         gboolean italic:1;
00114         gboolean underline:1;
00115         gboolean strike:1;
00116         gchar *forecolor;
00117         gchar *backcolor;
00118         gchar *background;
00119         gchar *fontface;
00120         int fontsize;
00121         GtkTextTag *link;
00122     } edit;
00123 
00124     char *clipboard_text_string;
00125     char *clipboard_html_string;
00126 
00127     GSList *im_images;
00128     GtkIMHtmlFuncs *funcs;
00129 };
00130 
00131 struct _GtkIMHtmlClass {
00132     GtkTextViewClass parent_class;
00133 
00134     void (*url_clicked)(GtkIMHtml *, const gchar *);
00135     void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
00136     void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
00137     void (*clear_format)(GtkIMHtml *);
00138     void (*update_format)(GtkIMHtml *);
00139     gboolean (*message_send)(GtkIMHtml *);
00140 };
00141 
00142 struct _GtkIMHtmlFontDetail {
00143     gushort size;
00144     gchar *face;
00145     gchar *fore;
00146     gchar *back;
00147     gchar *bg;
00148     gchar *sml;
00149     gboolean underline;
00150     gshort bold;
00151 };
00152 
00153 struct _GtkSmileyTree {
00154     GString *values;
00155     GtkSmileyTree **children;
00156     GtkIMHtmlSmiley *image;
00157 };
00158 
00159 struct _GtkIMHtmlSmiley {
00160     gchar *smile;
00161     gchar *file;
00162     GdkPixbufAnimation *icon;
00163     gboolean hidden;
00164     GdkPixbufLoader *loader;
00165     GSList *anchors;
00166     GtkIMHtmlSmileyFlags flags;
00167     GtkIMHtml *imhtml;
00168 };
00169 
00170 struct _GtkIMHtmlScalable {
00171     void (*scale)(struct _GtkIMHtmlScalable *, int, int);
00172     void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
00173     void (*free)(struct _GtkIMHtmlScalable *);
00174 };
00175 
00176 struct _GtkIMHtmlImage {
00177     GtkIMHtmlScalable scalable;
00178     GtkImage *image;
00179     GdkPixbuf *pixbuf;
00180     GtkTextMark *mark;
00181     gchar *filename;
00182     int width;
00183     int height;
00184     int id;
00185     GtkWidget *filesel;
00186 };
00187 
00188 struct _GtkIMHtmlHr {
00189     GtkIMHtmlScalable scalable;
00190     GtkWidget *sep;
00191 };
00192 
00193 typedef enum {
00194     GTK_IMHTML_NO_COLOURS          = 1 << 0,
00195     GTK_IMHTML_NO_FONTS            = 1 << 1,
00196     GTK_IMHTML_NO_COMMENTS         = 1 << 2, /* Remove */
00197     GTK_IMHTML_NO_TITLE            = 1 << 3,
00198     GTK_IMHTML_NO_NEWLINE          = 1 << 4,
00199     GTK_IMHTML_NO_SIZES            = 1 << 5,
00200     GTK_IMHTML_NO_SCROLL           = 1 << 6,
00201     GTK_IMHTML_RETURN_LOG          = 1 << 7,
00202     GTK_IMHTML_USE_POINTSIZE       = 1 << 8,
00203     GTK_IMHTML_NO_FORMATTING       = 1 << 9,
00204     GTK_IMHTML_USE_SMOOTHSCROLLING = 1 << 10
00205 } GtkIMHtmlOptions;
00206 
00207 enum {
00208     GTK_IMHTML_DRAG_URL = 0,
00209     GTK_IMHTML_DRAG_HTML,
00210     GTK_IMHTML_DRAG_UTF8_STRING,
00211     GTK_IMHTML_DRAG_COMPOUND_TEXT,
00212     GTK_IMHTML_DRAG_STRING,
00213     GTK_IMHTML_DRAG_TEXT,
00214     GTK_IMHTML_DRAG_NUM
00215 };
00216 
00217 #define GTK_IMHTML_DND_TARGETS  \
00218     { "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
00219     { "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
00220     { "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
00221     { "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
00222     { "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
00223     { "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
00224     { "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
00225     { "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
00226     { "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
00227     { "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
00228 
00229 typedef gpointer    (*GtkIMHtmlGetImageFunc)        (int id);
00230 typedef gpointer    (*GtkIMHtmlGetImageDataFunc)    (gpointer i);
00231 typedef size_t      (*GtkIMHtmlGetImageSizeFunc)    (gpointer i);
00232 typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
00233 typedef void        (*GtkIMHtmlImageRefFunc)        (int id);
00234 typedef void        (*GtkIMHtmlImageUnrefFunc)      (int id);
00235 
00236 struct _GtkIMHtmlFuncs {
00237     GtkIMHtmlGetImageFunc image_get;
00238     GtkIMHtmlGetImageDataFunc image_get_data;
00239     GtkIMHtmlGetImageSizeFunc image_get_size;
00240     GtkIMHtmlGetImageFilenameFunc image_get_filename;
00241     GtkIMHtmlImageRefFunc image_ref;
00242     GtkIMHtmlImageUnrefFunc image_unref;
00243 };
00244 
00247 /**************************************************************************
00248  * @name GTK+ IM/HTML rendering component API
00249  **************************************************************************/
00257 GType gtk_imhtml_get_type(void);
00258 
00264 GtkWidget *gtk_imhtml_new(void *, void *);
00265 
00274 GtkIMHtmlSmiley *gtk_imhtml_smiley_get(GtkIMHtml * imhtml,
00275                                         const gchar * sml, const gchar * text);
00276 
00277 
00285 void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, const gchar *sml, GtkIMHtmlSmiley *smiley);
00286 
00292 void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
00293 
00300 void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
00301 
00308 void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
00309 
00315 const char *gtk_imhtml_get_protocol_name(GtkIMHtml *imhtml);
00316 
00323 void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
00324 
00332 #define gtk_imhtml_append_text(imhtml, text, options) \
00333  gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
00334 
00343 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
00344                                          const gchar *text,
00345                                          GtkIMHtmlOptions options,
00346                                          GSList *unused);
00347 
00356 void gtk_imhtml_insert_html_at_iter(GtkIMHtml        *imhtml,
00357                                     const gchar      *text,
00358                                     GtkIMHtmlOptions  options,
00359                                     GtkTextIter      *iter);
00360 
00367 void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml, gboolean smooth);
00368 
00376 void gtk_imhtml_delete(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00377 
00383 #define gtk_imhtml_clear(imhtml) \
00384  gtk_imhtml_delete(imhtml, NULL, NULL)
00385 
00391 void gtk_imhtml_page_up(GtkIMHtml *imhtml);
00392 
00398 void gtk_imhtml_page_down(GtkIMHtml *imhtml);
00399 
00405 GtkIMHtmlScalable *gtk_imhtml_scalable_new(void);
00406 
00416 GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
00417 
00423 void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
00424 
00432 void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
00433 
00441 void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00442 
00448 GtkIMHtmlScalable *gtk_imhtml_hr_new(void);
00449 
00455 void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
00456 
00464 void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
00465 
00474 void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00475 
00484 gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
00485 
00491 void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
00492 
00499 void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
00500 
00509 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
00510 
00517 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
00518 
00526 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
00527 
00537 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
00538 
00547 char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
00548 
00557 char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
00558 
00567 char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
00568 
00577 char *gtk_imhtml_get_current_background(GtkIMHtml *imhtml);
00578 
00587 gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
00588 
00596 gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
00597 
00603 void gtk_imhtml_clear_formatting(GtkIMHtml *imhtml);
00604 
00610 void gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
00611 
00617 void gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
00618 
00624 void gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
00625 
00631 void gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
00632 
00642 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
00643 
00653 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
00654 
00664 gboolean gtk_imhtml_toggle_background(GtkIMHtml *imhtml, const char *color);
00665 
00674 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
00675 
00683 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
00684 
00693 void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
00694 
00702 void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
00711 void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
00712 
00721 void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
00722 
00729 void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
00730 
00737 void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
00738 
00745 void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
00746 
00756 char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00757 
00765 char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
00766 
00775 char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
00776 
00787 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
00788 
00791 #ifdef __cplusplus
00792 }
00793 #endif
00794 
00795 #endif /* _PIDGINIMHTML_H_ */