Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages

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 };
00126 
00127 struct _GtkIMHtmlClass {
00128     GtkTextViewClass parent_class;
00129 
00130     void (*url_clicked)(GtkIMHtml *, const gchar *);
00131     void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
00132     void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
00133     void (*clear_format)(GtkIMHtml *);
00134     void (*update_format)(GtkIMHtml *);
00135 };
00136 
00137 struct _GtkIMHtmlFontDetail {
00138     gushort size;
00139     gchar *face;
00140     gchar *fore;
00141     gchar *back;
00142     gchar *sml;
00143     gboolean underline;
00144 };
00145 
00146 struct _GtkSmileyTree {
00147     GString *values;
00148     GtkSmileyTree **children;
00149     GtkIMHtmlSmiley *image;
00150 };
00151 
00152 struct _GtkIMHtmlSmiley {
00153     gchar *smile;
00154     gchar *file;
00155     GdkPixbufAnimation *icon;
00156     gboolean hidden;
00157 };
00158 
00159 struct _GtkIMHtmlScalable {
00160     void (*scale)(struct _GtkIMHtmlScalable *, int, int);
00161     void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
00162     void (*free)(struct _GtkIMHtmlScalable *);
00163 };
00164 
00165 struct _GtkIMHtmlImage {
00166     GtkIMHtmlScalable scalable;
00167     GtkImage *image;
00168     GdkPixbuf *pixbuf;
00169     GtkTextMark *mark;
00170     gchar *filename;
00171     int width;
00172     int height;
00173     int id;
00174     GtkWidget *filesel;
00175 };
00176 
00177 struct _GtkIMHtmlHr {
00178     GtkIMHtmlScalable scalable;
00179     GtkWidget *sep;
00180 };
00181 
00182 typedef enum {
00183     GTK_IMHTML_NO_COLOURS    = 1 << 0,
00184     GTK_IMHTML_NO_FONTS      = 1 << 1,
00185     GTK_IMHTML_NO_COMMENTS   = 1 << 2, /* Remove */
00186     GTK_IMHTML_NO_TITLE      = 1 << 3,
00187     GTK_IMHTML_NO_NEWLINE    = 1 << 4,
00188     GTK_IMHTML_NO_SIZES      = 1 << 5,
00189     GTK_IMHTML_NO_SCROLL     = 1 << 6,
00190     GTK_IMHTML_RETURN_LOG    = 1 << 7,
00191     GTK_IMHTML_USE_POINTSIZE = 1 << 8
00192 } GtkIMHtmlOptions;
00193 
00194 enum {
00195     GTK_IMHTML_DRAG_URL = 0,
00196     GTK_IMHTML_DRAG_HTML,
00197     GTK_IMHTML_DRAG_UTF8_STRING,
00198     GTK_IMHTML_DRAG_COMPOUND_TEXT,
00199     GTK_IMHTML_DRAG_STRING,
00200     GTK_IMHTML_DRAG_TEXT,
00201     GTK_IMHTML_DRAG_NUM
00202 };
00203 
00204 #define GTK_IMHTML_DND_TARGETS  \
00205     { "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
00206     { "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
00207     { "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
00208     { "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
00209     { "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
00210     { "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
00211     { "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
00212     { "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
00213     { "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
00214     { "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
00215 
00216 typedef gpointer    (*GtkIMHtmlGetImageFunc)        (int id);
00217 typedef gpointer    (*GtkIMHtmlGetImageDataFunc)    (gpointer i);
00218 typedef size_t      (*GtkIMHtmlGetImageSizeFunc)    (gpointer i);
00219 typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
00220 typedef void        (*GtkIMHtmlImageRefFunc)        (int id);
00221 typedef void        (*GtkIMHtmlImageUnrefFunc)      (int id);
00222 
00223 struct _GtkIMHtmlFuncs {
00224     GtkIMHtmlGetImageFunc image_get;
00225     GtkIMHtmlGetImageDataFunc image_get_data;
00226     GtkIMHtmlGetImageSizeFunc image_get_size;
00227     GtkIMHtmlGetImageFilenameFunc image_get_filename;
00228     GtkIMHtmlImageRefFunc image_ref;
00229     GtkIMHtmlImageUnrefFunc image_unref;
00230 };
00231 
00234 /**************************************************************************
00235  * @name GTK+ IM/HTML rendering component API
00236  **************************************************************************/
00244 GType gtk_imhtml_get_type(void);
00245 
00251 GtkWidget *gtk_imhtml_new(void *, void *);
00252 
00260 void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, gchar *sml, GtkIMHtmlSmiley *smiley);
00261 
00267 void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
00268 
00275 void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
00276 
00283 void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
00284 
00291 void gtk_imhtml_html_shortcuts(GtkIMHtml *imhtml, gboolean allow);
00292 
00299 void gtk_imhtml_smiley_shortcuts(GtkIMHtml *imhtml, gboolean allow);
00300 
00307 void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
00308 
00316 #define gtk_imhtml_append_text(imhtml, text, options) \
00317  gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
00318 
00327 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
00328                                          const gchar *text,
00329                                          GtkIMHtmlOptions options,
00330                                          GSList *unused);
00331 
00340 void gtk_imhtml_insert_html_at_iter(GtkIMHtml        *imhtml,
00341                                     const gchar      *text,
00342                                     GtkIMHtmlOptions  options,
00343                                     GtkTextIter      *iter);
00344 
00350 void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml);
00351 
00357 void gtk_imhtml_clear(GtkIMHtml *imhtml);
00358 
00364 void gtk_imhtml_page_up(GtkIMHtml *imhtml);
00365 
00371 void gtk_imhtml_page_down(GtkIMHtml *imhtml);
00372 
00379 void gtk_imhtml_font_zoom(GtkIMHtml *imhtml, double zoom);
00380 
00386 GtkIMHtmlScalable *gtk_imhtml_scalable_new();
00387 
00397 GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
00398 
00404 void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
00405 
00413 void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
00414 
00422 void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00423 
00429 GtkIMHtmlScalable *gtk_imhtml_hr_new();
00430 
00436 void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
00437 
00445 void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
00446 
00455 void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00456 
00465 gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
00466 
00472 void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
00473 
00480 void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
00481 
00490 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
00491 
00498 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
00499 
00507 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
00508 
00518 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
00519 
00528 char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
00529 
00538 char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
00539 
00548 char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
00549 
00558 gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
00559 
00567 gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
00568 
00576 gboolean gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
00577 
00585 gboolean gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
00586 
00594 gboolean gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
00595 
00603 gboolean gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
00604 
00614 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
00615 
00625 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
00626 
00635 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
00636 
00644 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
00645 
00654 void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
00655 
00663 void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
00672 void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
00673 
00682 void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
00683 
00690 void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
00691 
00698 void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
00699 
00706 void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
00707 
00717 char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00718 
00726 char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
00727 
00736 char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
00737 
00748 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
00749 
00752 #ifdef __cplusplus
00753 }
00754 #endif
00755 
00756 #endif /* _GAIM_GTKIMHTML_H_ */

Generated on Fri Apr 22 05:21:09 2005 for gaim by  doxygen 1.3.9.1