gtkimhtml.h

Go to the documentation of this file.
00001 
00007 /* Pidgin is the legal property of its developers, whose names are too numerous
00008  * to list here.  Please refer to the COPYRIGHT file distributed with this
00009  * source distribution.
00010  *
00011  * This program is free software; you can redistribute it and/or modify
00012  * under the terms of the GNU General Public License as published by
00013  * the Free Software Foundation; either version 2 of the License, or
00014  * (at your option) any later version.
00015  *
00016  * This program is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU General Public License
00022  * along with this program; if not, write to the Free Software
00023  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00024  */
00025 #ifndef _PIDGINIMHTML_H_
00026 #define _PIDGINIMHTML_H_
00027 
00028 #include <gdk/gdk.h>
00029 #include <gtk/gtk.h>
00030 #include "gtksourceundomanager.h"
00031 
00032 #include "connection.h"
00033 
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 
00038 /**************************************************************************
00039  * @name Structures
00040  **************************************************************************/
00043 #define GTK_TYPE_IMHTML            (gtk_imhtml_get_type())
00044 #define GTK_IMHTML(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_IMHTML, GtkIMHtml))
00045 #define GTK_IMHTML_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), GTK_TYPE_IMHTML, GtkIMHtmlClass))
00046 #define GTK_IS_IMHTML(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), GTK_TYPE_IMHTML))
00047 #define GTK_IS_IMHTML_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GTK_TYPE_IMHTML))
00048 #define GTK_IMHTML_SCALABLE(obj)   ((GtkIMHtmlScalable *)obj)
00049 #define GTK_IMHTML_ANIMATION(obj)  ((GtkIMHtmlAnimation *)obj)
00050 
00051 typedef struct _GtkIMHtml           GtkIMHtml;
00052 typedef struct _GtkIMHtmlClass      GtkIMHtmlClass;
00053 typedef struct _GtkIMHtmlFontDetail GtkIMHtmlFontDetail;    /* The five elements contained in a FONT tag */
00054 typedef struct _GtkSmileyTree       GtkSmileyTree;
00055 typedef struct _GtkIMHtmlSmiley     GtkIMHtmlSmiley;
00056 typedef struct _GtkIMHtmlScalable   GtkIMHtmlScalable;
00057 typedef struct _GtkIMHtmlImage      GtkIMHtmlImage;
00058 typedef struct _GtkIMHtmlAnimation  GtkIMHtmlAnimation;
00059 typedef struct _GtkIMHtmlHr         GtkIMHtmlHr;
00060 typedef struct _GtkIMHtmlFuncs      GtkIMHtmlFuncs;
00061 
00065 typedef struct _GtkIMHtmlLink       GtkIMHtmlLink;
00066 
00067 typedef enum {
00068     GTK_IMHTML_BOLD =       1 << 0,
00069     GTK_IMHTML_ITALIC =     1 << 1,
00070     GTK_IMHTML_UNDERLINE =  1 << 2,
00071     GTK_IMHTML_GROW =       1 << 3,
00072     GTK_IMHTML_SHRINK =     1 << 4,
00073     GTK_IMHTML_FACE =       1 << 5,
00074     GTK_IMHTML_FORECOLOR =  1 << 6,
00075     GTK_IMHTML_BACKCOLOR =  1 << 7,
00076     GTK_IMHTML_BACKGROUND = 1 << 8,
00077     GTK_IMHTML_LINK =       1 << 9,
00078     GTK_IMHTML_IMAGE =      1 << 10,
00079     GTK_IMHTML_SMILEY =     1 << 11,
00080     GTK_IMHTML_LINKDESC =   1 << 12,
00081     GTK_IMHTML_STRIKE =     1 << 13,
00083     GTK_IMHTML_CUSTOM_SMILEY = 1 << 14,
00084     GTK_IMHTML_ALL =       -1
00085 } GtkIMHtmlButtons;
00086 
00087 typedef enum {
00088     GTK_IMHTML_SMILEY_CUSTOM =  1 << 0
00089 } GtkIMHtmlSmileyFlags;
00090 
00091 struct _GtkIMHtml {
00092     GtkTextView text_view;
00093     GtkTextBuffer *text_buffer;
00094     GdkCursor *hand_cursor;
00095     GdkCursor *arrow_cursor;
00096     GdkCursor *text_cursor;
00097     GHashTable *smiley_data;
00098     GtkSmileyTree *default_smilies;
00099     char *protocol_name;
00100     guint scroll_src;
00101     GTimer *scroll_time;
00102     GQueue *animations;
00103     int num_animations;
00104 
00105     gboolean show_comments;
00106 
00107     GtkWidget *tip_window;
00108     char *tip;
00109     guint tip_timer;
00110     GtkTextTag *prelit_tag;
00111 
00112     GList *scalables;
00113     GdkRectangle old_rect;
00114 
00115     gchar *search_string;
00116 
00117     gboolean editable;
00118     GtkIMHtmlButtons format_functions;
00119     gboolean wbfo;  /* Whole buffer formatting only. */
00120 
00121     gint insert_offset;
00122 
00123     struct {
00124         gboolean bold:1;
00125         gboolean italic:1;
00126         gboolean underline:1;
00127         gboolean strike:1;
00128         gchar *forecolor;
00129         gchar *backcolor;
00130         gchar *background;
00131         gchar *fontface;
00132         int fontsize;
00133         GtkTextTag *link;
00134     } edit;
00135 
00136 #if !(defined PIDGIN_DISABLE_DEPRECATED) || (defined _PIDGIN_GTKIMHTML_C_)
00137 
00138     char *clipboard_text_string;
00140     char *clipboard_html_string;
00141 #else
00142     char *depr1;
00143     char *depr2;
00144 #endif
00145 
00146     GSList *im_images;
00147     GtkIMHtmlFuncs *funcs;
00148     GtkSourceUndoManager *undo_manager;
00149 };
00150 
00151 struct _GtkIMHtmlClass {
00152     GtkTextViewClass parent_class;
00153 
00154     void (*url_clicked)(GtkIMHtml *, const gchar *);
00155     void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
00156     void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
00157     void (*clear_format)(GtkIMHtml *);
00158     void (*update_format)(GtkIMHtml *);
00159     gboolean (*message_send)(GtkIMHtml *);
00160     void (*undo)(GtkIMHtml *);
00161     void (*redo)(GtkIMHtml *);
00162     GList *protocols; /* List of GtkIMHtmlProtocol's */
00163 };
00164 
00165 struct _GtkIMHtmlFontDetail {
00166     gushort size;
00167     gchar *face;
00168     gchar *fore;
00169     gchar *back;
00170     gchar *bg;
00171     gchar *sml;
00172     gboolean underline;
00173     gshort bold;
00174 };
00175 
00176 struct _GtkSmileyTree {
00177     GString *values;
00178     GtkSmileyTree **children;
00179     GtkIMHtmlSmiley *image;
00180 };
00181 
00182 struct _GtkIMHtmlSmiley {
00183     gchar *smile;
00184     gchar *file;
00185     GdkPixbufAnimation *icon;
00186     gboolean hidden;
00187     GdkPixbufLoader *loader;
00188     GSList *anchors;
00189     GtkIMHtmlSmileyFlags flags;
00190     GtkIMHtml *imhtml;
00191     gpointer data;       
00192     gsize datasize;      
00193 };
00194 
00195 struct _GtkIMHtmlScalable {
00196     void (*scale)(struct _GtkIMHtmlScalable *, int, int);
00197     void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
00198     void (*free)(struct _GtkIMHtmlScalable *);
00199 };
00200 
00201 struct _GtkIMHtmlImage {
00202     GtkIMHtmlScalable scalable;
00203     GtkImage *image; 
00204     GdkPixbuf *pixbuf; 
00205     GtkTextMark *mark;
00206     gchar *filename;
00207     int width;
00208     int height;
00209     int id;
00210     GtkWidget *filesel;
00211 };
00212 
00213 struct _GtkIMHtmlAnimation {
00214     GtkIMHtmlImage imhtmlimage;
00215     GdkPixbufAnimation *anim; 
00216     GdkPixbufAnimationIter *iter;
00217     guint timer;
00218 };
00219 
00220 struct _GtkIMHtmlHr {
00221     GtkIMHtmlScalable scalable;
00222     GtkWidget *sep;
00223 };
00224 
00225 typedef enum {
00226     GTK_IMHTML_NO_COLOURS          = 1 << 0,
00227     GTK_IMHTML_NO_FONTS            = 1 << 1,
00228     GTK_IMHTML_NO_COMMENTS         = 1 << 2, /* Remove */
00229     GTK_IMHTML_NO_TITLE            = 1 << 3,
00230     GTK_IMHTML_NO_NEWLINE          = 1 << 4,
00231     GTK_IMHTML_NO_SIZES            = 1 << 5,
00232     GTK_IMHTML_NO_SCROLL           = 1 << 6,
00233     GTK_IMHTML_RETURN_LOG          = 1 << 7,
00234     GTK_IMHTML_USE_POINTSIZE       = 1 << 8,
00235     GTK_IMHTML_NO_FORMATTING       = 1 << 9,
00236     GTK_IMHTML_USE_SMOOTHSCROLLING = 1 << 10,
00237     GTK_IMHTML_NO_SMILEY           = 1 << 11,
00238 } GtkIMHtmlOptions;
00239 
00240 enum {
00241     GTK_IMHTML_DRAG_URL = 0,
00242     GTK_IMHTML_DRAG_HTML,
00243     GTK_IMHTML_DRAG_UTF8_STRING,
00244     GTK_IMHTML_DRAG_COMPOUND_TEXT,
00245     GTK_IMHTML_DRAG_STRING,
00246     GTK_IMHTML_DRAG_TEXT,
00247     GTK_IMHTML_DRAG_NUM
00248 };
00249 
00250 #define GTK_IMHTML_DND_TARGETS  \
00251     { "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
00252     { "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
00253     { "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
00254     { "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
00255     { "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
00256     { "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
00257     { "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
00258     { "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
00259     { "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
00260     { "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
00261 
00262 typedef gpointer    (*GtkIMHtmlGetImageFunc)        (int id);
00263 typedef gpointer    (*GtkIMHtmlGetImageDataFunc)    (gpointer i);
00264 typedef size_t      (*GtkIMHtmlGetImageSizeFunc)    (gpointer i);
00265 typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
00266 typedef void        (*GtkIMHtmlImageRefFunc)        (int id);
00267 typedef void        (*GtkIMHtmlImageUnrefFunc)      (int id);
00268 
00269 struct _GtkIMHtmlFuncs {
00270     GtkIMHtmlGetImageFunc image_get;
00271     GtkIMHtmlGetImageDataFunc image_get_data;
00272     GtkIMHtmlGetImageSizeFunc image_get_size;
00273     GtkIMHtmlGetImageFilenameFunc image_get_filename;
00274     GtkIMHtmlImageRefFunc image_ref;
00275     GtkIMHtmlImageUnrefFunc image_unref;
00276 };
00277 
00280 /**************************************************************************
00281  * @name GTK+ IM/HTML rendering component API
00282  **************************************************************************/
00290 GType gtk_imhtml_get_type(void);
00291 
00297 GtkWidget *gtk_imhtml_new(void *, void *);
00298 
00307 GtkIMHtmlSmiley *gtk_imhtml_smiley_get(GtkIMHtml * imhtml,
00308                                         const gchar * sml, const gchar * text);
00309 
00310 
00318 void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, const gchar *sml, GtkIMHtmlSmiley *smiley);
00319 
00325 void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
00326 
00333 void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
00334 
00341 void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
00342 
00348 const char *gtk_imhtml_get_protocol_name(GtkIMHtml *imhtml);
00349 
00356 void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
00357 
00365 #define gtk_imhtml_append_text(imhtml, text, options) \
00366  gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
00367 
00376 void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
00377                                          const gchar *text,
00378                                          GtkIMHtmlOptions options,
00379                                          GSList *unused);
00380 
00389 void gtk_imhtml_insert_html_at_iter(GtkIMHtml        *imhtml,
00390                                     const gchar      *text,
00391                                     GtkIMHtmlOptions  options,
00392                                     GtkTextIter      *iter);
00393 
00400 void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml, gboolean smooth);
00401 
00409 void gtk_imhtml_delete(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00410 
00416 #define gtk_imhtml_clear(imhtml) \
00417  gtk_imhtml_delete(imhtml, NULL, NULL)
00418 
00424 void gtk_imhtml_page_up(GtkIMHtml *imhtml);
00425 
00431 void gtk_imhtml_page_down(GtkIMHtml *imhtml);
00432 
00438 GtkIMHtmlScalable *gtk_imhtml_scalable_new(void);
00439 
00449 GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
00450 
00463 /*
00464  * TODO: All this animation code could be combined much better with
00465  *       the image code.  It couldn't be done when it was written
00466  *       because it requires breaking backward compatibility.  It
00467  *       would be good to do it for 3.0.0.
00468  */
00469 GtkIMHtmlScalable *gtk_imhtml_animation_new(GdkPixbufAnimation *img, const gchar *filename, int id);
00470 
00476 /* TODO: Is there any reason this isn't private? */
00477 void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
00478 
00484 /* TODO: Is there any reason this isn't private? */
00485 void gtk_imhtml_animation_free(GtkIMHtmlScalable *scale);
00486 
00494 /* TODO: Is there any reason this isn't private? */
00495 void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
00496 
00504 /* TODO: Is there any reason this isn't private? */
00505 void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00506 
00512 GtkIMHtmlScalable *gtk_imhtml_hr_new(void);
00513 
00519 void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
00520 
00528 void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
00529 
00538 void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
00539 
00548 gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
00549 
00555 void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
00556 
00563 void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
00564 
00573 void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
00574 
00581 void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
00582 
00590 GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
00591 
00601 void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
00602 
00611 char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
00612 
00621 char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
00622 
00631 char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
00632 
00641 char *gtk_imhtml_get_current_background(GtkIMHtml *imhtml);
00642 
00651 gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
00652 
00660 gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
00661 
00667 void gtk_imhtml_clear_formatting(GtkIMHtml *imhtml);
00668 
00674 void gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
00675 
00681 void gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
00682 
00688 void gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
00689 
00695 void gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
00696 
00706 gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
00707 
00717 gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
00718 
00728 gboolean gtk_imhtml_toggle_background(GtkIMHtml *imhtml, const char *color);
00729 
00738 gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
00739 
00747 void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
00748 
00757 void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
00758 
00766 void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
00775 void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
00776 
00785 void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
00786 
00793 void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
00794 
00801 void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
00802 
00809 void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
00810 
00820 char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
00821 
00829 char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
00830 
00839 char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
00840 
00851 char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
00852 
00861 void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
00862 
00874 GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
00875         GtkIMHtmlSmileyFlags flags);
00876 
00884 void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
00885 
00893 void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
00894 
00913 gboolean gtk_imhtml_class_register_protocol(const char *name,
00914         gboolean (*activate)(GtkIMHtml *imhtml, GtkIMHtmlLink *link),
00915         gboolean (*context_menu)(GtkIMHtml *imhtml, GtkIMHtmlLink *link, GtkWidget *menu));
00916 
00926 const char *gtk_imhtml_link_get_url(GtkIMHtmlLink *link);
00927 
00937 const GtkTextTag *gtk_imhtml_link_get_text_tag(GtkIMHtmlLink *link);
00938 
00949 gboolean gtk_imhtml_link_activate(GtkIMHtmlLink *link);
00950 
00960 void gtk_imhtml_set_return_inserts_newline(GtkIMHtml *imhtml);
00961 
00970 void gtk_imhtml_set_populate_primary_clipboard(GtkIMHtml *imhtml, gboolean populate);
00971 
00974 #ifdef __cplusplus
00975 }
00976 #endif
00977 
00978 #endif /* _PIDGINIMHTML_H_ */