/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */ /* This file is part of the GtkHTML library Copyright (C) 1997 Martin Jones (mjones@kde.org) Copyright (C) 1997 Torben Weis (weis@kde.org) Copyright (C) 1999, 2000 Helix Code, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHcANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef _HTMLOBJECT_H_ #define _HTMLOBJECT_H_ #include #include #include "htmltypes.h" #include "htmlenums.h" #define HTML_OBJECT(x) ((HTMLObject *) (x)) #define HTML_OBJECT_CLASS(x) ((HTMLObjectClass *) (x)) #define HTML_OBJECT_TYPE(x) (HTML_OBJECT (x)->klass->type) struct _HTMLObject { HTMLObjectClass *klass; /* Pointer to the parent object. */ HTMLObject *parent; HTMLObject *prev; HTMLObject *next; HTMLChangeFlags change; gint x, y; gint ascent, descent; gint min_width; gint width; gint pref_width; gint max_width; gint percent; guchar flags; /* FIXME maybe unify with `flags'? */ guint redraw_pending : 1; guint selected : 1; /* If an object has a redraw pending and is being destroyed, this flag is set to TRUE instead of g_free()ing the object. When the draw queue is flushed, the g_free() is performed. */ guint free_pending : 1; GData *object_data; }; struct _HTMLObjectClearRectangle { HTMLObject *object; gint x; gint y; gint width; gint height; }; struct _HTMLObjectClass { HTMLType type; guint object_size; /* Destroy the object. */ void (* destroy) (HTMLObject *o); /* Copy an object into another one. @dest can just point to a memory area of the proper size. */ void (* copy) (HTMLObject *self, HTMLObject *dest); /* copy/cut/paste operations */ HTMLObject * (* op_copy) (HTMLObject *self, HTMLEngine *e, GList *from, GList *to, guint *len); HTMLObject * (* op_cut) (HTMLObject *self, HTMLEngine *e, GList *from, GList *to, GList *left, GList *right, guint *len); gboolean (* merge) (HTMLObject *self, HTMLObject *o, HTMLEngine *e, GList **left, GList **right, HTMLCursor *cursor); void (* remove_child) (HTMLObject *self, HTMLObject *child); void (* split) (HTMLObject *self, HTMLEngine *e, HTMLObject *child, gint offset, gint level, GList **left, GList **right); /* Layout management and geometry handling. */ HTMLFitType (* fit_line) (HTMLObject *o, HTMLPainter *painter, gboolean start_of_line, gboolean first_run, gint width_left); gboolean (* calc_size) (HTMLObject *o, HTMLPainter *painter, GList **changed_objs); gint (* calc_min_width) (HTMLObject *o, HTMLPainter *painter); gint (* calc_preferred_width) (HTMLObject *o, HTMLPainter *painter); void (* set_max_ascent) (HTMLObject *o, HTMLPainter *painter, gint a); void (* set_max_descent) (HTMLObject *o, HTMLPainter *painter, gint d); void (* set_max_width) (HTMLObject *o, HTMLPainter *painter, gint max_width); /* Relayout object `o' starting from child `child'. This method can be called by the child when it changes any of its layout properties. */ gboolean (* layout) (HTMLObject *o, HTMLObject *child); /* This method is used to draw the object. @x & @y are in object coordinates (e.g. the same coordinate system as o->x and o->y). @tx & @ty are used to translate the object coordinates into painter coordinates. */ void (* draw) (HTMLObject *o, HTMLPainter *painter, gint x, gint y, gint width, gint height, gint tx, gint ty); /* "Transparent" objects (i.e. objects that don't draw all the area they occupy, such as text) should return `TRUE' here. */ gboolean (* is_transparent) (HTMLObject *self); /* This draws the background only. If the object is transparent, it should simply forward the method to the parent. */ void (* draw_background) (HTMLObject *o, HTMLPainter *painter, gint x, gint y, gint width, gint height, gint tx, gint ty); void (* set_bg_color) (HTMLObject *o, GdkColor *color); GdkColor * (* get_bg_color) (HTMLObject *o, HTMLPainter *p); /* Margins. This should actually be used only by objects that contain other objects, so it should be in HTMLClue. But HTMLTable does not derive from HTMLClue and we don't want to spend time reorganizing the hierarchy now. */ gint (* get_left_margin) (HTMLObject *self, HTMLPainter *painter, gint y); gint (* get_right_margin) (HTMLObject *self, HTMLPainter *painter, gint y); void (* set_painter) (HTMLObject *o, HTMLPainter *painter); /* Resetting the object. Do this before using a different HTMLPainter. */ void (* reset) (HTMLObject *o); const gchar * (* get_url) (HTMLObject *o); const gchar * (* get_target) (HTMLObject *o); const gchar * (* get_src) (HTMLObject *o); HTMLAnchor * (* find_anchor) (HTMLObject *o, const gchar *name, gint *x, gint *y); HTMLObject * (* check_point) (HTMLObject *self, HTMLPainter *painter, gint x, gint y, guint *offset_return, gboolean for_cursor); /* Relayout this object. The object will relayout all the children starting from `child'. Children before `child' are not affected. The return value is FALSE if nothing has changed during relayout, TRUE otherwise. */ gboolean (* relayout) (HTMLObject *self, HTMLEngine *engine, HTMLObject *child); /* Return the vertical alignment for the object in an HTMLClueFlow. If the returned value is `HTML_VALIGN_BOTTOM', the bottom of the object is aligned to the base line; if the value is `HTML_VALIGN_TOP', the top of the object is aligned to the top of the line; if the value is `HTML_VALIGN_MIDDLE', the center of the object is aligned to the baseline. */ HTMLVAlignType (* get_valign) (HTMLObject *self); /* Cursor handling. */ gboolean (* accepts_cursor) (HTMLObject *self); void (* get_cursor) (HTMLObject *self, HTMLPainter *painter, guint offset, gint *x1, gint *y1, gint *x2, gint *y2); void (* get_cursor_base) (HTMLObject *self, HTMLPainter *painter, guint offset, gint *x, gint *y); /* Container operations. */ HTMLEngine * (* get_engine) (HTMLObject *o, HTMLEngine *e); void (* forall) (HTMLObject *self, HTMLEngine *e, HTMLObjectForallFunc func, gpointer data); gboolean (* is_container) (HTMLObject *self); /* Saving. */ gboolean (* save) (HTMLObject *self, HTMLEngineSaveState *state); gboolean (* save_plain) (HTMLObject *self, HTMLEngineSaveState *state, gint requested_width); /* Page splitting (for printing). */ gint (* check_page_split) (HTMLObject *self, gint y); /* Selection. */ gboolean (* select_range) (HTMLObject *self, HTMLEngine *engine, guint start, gint length, gboolean queue_draw); void (* append_selection_string) (HTMLObject *self, GString *buffer); /* Search & Replace */ gboolean (* search) (HTMLObject *self, HTMLSearch *info); gboolean (* search_next) (HTMLObject *self, HTMLSearch *info); /* links */ HTMLObject * (* set_link) (HTMLObject *self, HTMLColor *color, const gchar *url, const gchar *target); /* length */ guint (* get_length) (HTMLObject *self); guint (* get_line_length) (HTMLObject *self, HTMLPainter *p, gint line_offset); guint (* get_recursive_length) (HTMLObject *self); /* movement */ HTMLObject * (* next) (HTMLObject *self, HTMLObject *child); HTMLObject * (* prev) (HTMLObject *self, HTMLObject *child); HTMLObject * (* head) (HTMLObject *self); HTMLObject * (* tail) (HTMLObject *self); }; extern HTMLObjectClass html_object_class; /* Basics. */ void html_object_type_init (void); void html_object_init (HTMLObject *self, HTMLObjectClass *klass); void html_object_class_init (HTMLObjectClass *klass, HTMLType type, guint object_size); HTMLObject *html_object_new (HTMLObject *parent); void html_object_destroy (HTMLObject *self); void html_object_copy (HTMLObject *self, HTMLObject *dest); HTMLObject *html_object_dup (HTMLObject *self); /* copy/cut/paste operations */ HTMLObject *html_object_op_copy (HTMLObject *self, HTMLEngine *e, GList *from, GList *to, guint *len); HTMLObject *html_object_op_cut (HTMLObject *self, HTMLEngine *e, GList *from, GList *to, GList *left, GList *right, guint *len); gboolean html_object_merge (HTMLObject *self, HTMLObject *with, HTMLEngine *e, GList **left, GList **right, HTMLCursor *cursor); void html_object_remove_child (HTMLObject *self, HTMLObject *child); void html_object_split (HTMLObject *self, HTMLEngine *e, HTMLObject *child, gint offset, gint level, GList **left, GList **right); void html_object_set_parent (HTMLObject *self, HTMLObject *parent); gint html_object_get_left_margin (HTMLObject *self, HTMLPainter *painter, gint y); gint html_object_get_right_margin (HTMLObject *self, HTMLPainter *painter, gint y); void html_object_set_painter (HTMLObject *o, HTMLPainter *p); void html_object_clear_word_width (HTMLObject *o); void html_object_reset (HTMLObject *o); gboolean html_object_is_text (HTMLObject *object); gboolean html_object_is_clue (HTMLObject *object); HTMLEngine *html_object_get_engine (HTMLObject *self, HTMLEngine *e); void html_object_forall (HTMLObject *self, HTMLEngine *e, HTMLObjectForallFunc func, gpointer data); gboolean html_object_is_container (HTMLObject *self); HTMLObject *html_object_next_not_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_prev_not_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_next_not_slave (HTMLObject *self); HTMLObject *html_object_prev_not_slave (HTMLObject *self); HTMLObject *html_object_next_by_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_prev_by_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_nth_parent (HTMLObject *self, gint n); gint html_object_get_parent_level (HTMLObject *self); /* do search request on object using info */ gboolean html_object_search (HTMLObject *self, HTMLSearch *info); gboolean html_object_search_next (HTMLObject *self, HTMLSearch *info); /* Drawing-related stuff. */ void html_object_draw (HTMLObject *o, HTMLPainter *p, gint x, gint y, gint width, gint height, gint tx, gint ty); void html_object_draw_background (HTMLObject *o, HTMLPainter *p, gint x, gint y, gint width, gint height, gint tx, gint ty); void html_object_set_bg_color (HTMLObject *o, GdkColor *color); GdkColor *html_object_get_bg_color (HTMLObject *o, HTMLPainter *p); gboolean html_object_is_transparent (HTMLObject *self); /* Layout. */ HTMLFitType html_object_fit_line (HTMLObject *o, HTMLPainter *painter, gboolean start_of_line, gboolean first_run, gint width_left); gboolean html_object_calc_size (HTMLObject *o, HTMLPainter *painter, GList **changed_objs); void html_object_set_max_ascent (HTMLObject *o, HTMLPainter *painter, gint a); void html_object_set_max_descent (HTMLObject *o, HTMLPainter *painter, gint d); void html_object_set_max_width (HTMLObject *o, HTMLPainter *painter, gint max_width); gint html_object_calc_min_width (HTMLObject *o, HTMLPainter *painter); gint html_object_calc_preferred_width (HTMLObject *o, HTMLPainter *painter); void html_object_calc_abs_position (HTMLObject *o, gint *x_return, gint *y_return); void html_object_calc_intersection (HTMLObject *o, ArtIRect *intersection, gint x, gint y, gint width, gint height); gboolean html_object_relayout (HTMLObject *obj, HTMLEngine *engine, HTMLObject *child); HTMLVAlignType html_object_get_valign (HTMLObject *self); /* Links. */ const gchar *html_object_get_url (HTMLObject *o); const gchar *html_object_get_target (HTMLObject *o); const gchar *html_object_get_src (HTMLObject *o); HTMLAnchor *html_object_find_anchor (HTMLObject *o, const gchar *name, gint *x, gint *y); HTMLObject *html_object_set_link (HTMLObject *self, HTMLColor *color, const gchar *url, const gchar *target); HTMLObject *html_object_remove_link (HTMLObject *self, HTMLColor *color); /* Cursor. */ gboolean html_object_accepts_cursor (HTMLObject *obj); void html_object_get_cursor (HTMLObject *obj, HTMLPainter *painter, guint offset, gint *x1, gint *y1, gint *x2, gint *y2); void html_object_get_cursor_base (HTMLObject *obj, HTMLPainter *painter, guint offset, gint *x, gint *y); guint html_object_get_length (HTMLObject *self); guint html_object_get_line_length (HTMLObject *self, HTMLPainter *p, gint line_offset); guint html_object_get_recursive_length (HTMLObject *self); guint html_object_get_bytes (HTMLObject *self); guint html_object_get_index (HTMLObject *self, guint offset); HTMLObject *html_object_check_point (HTMLObject *clue, HTMLPainter *painter, gint x, gint y, guint *offset_return, gboolean for_cursor); /* Movement functions */ /* move cursor in scope of object */ gboolean html_object_cursor_forward (HTMLObject *self, HTMLCursor *cursor); gboolean html_object_cursor_backward (HTMLObject *self, HTMLCursor *cursor); /* get prev/next object in scope of parent */ HTMLObject *html_object_next (HTMLObject *self, HTMLObject *child); HTMLObject *html_object_prev (HTMLObject *self, HTMLObject *child); /* get head/tail object of this (parent) object */ HTMLObject *html_object_head (HTMLObject *self); HTMLObject *html_object_tail (HTMLObject *self); HTMLObject *html_object_tail_not_slave (HTMLObject *self); /* get prev/next leaf object in scope of whole tree */ HTMLObject *html_object_next_leaf (HTMLObject *self); HTMLObject *html_object_prev_leaf (HTMLObject *self); HTMLObject *html_object_next_leaf_not_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_prev_leaf_not_type (HTMLObject *self, HTMLType t); HTMLObject *html_object_get_head_leaf (HTMLObject *o); HTMLObject *html_object_get_tail_leaf (HTMLObject *o); HTMLObject *html_object_next_cursor (HTMLObject *self, gint *offset); HTMLObject *html_object_prev_cursor (HTMLObject *self, gint *offset); /* Page splitting. */ gint html_object_check_page_split (HTMLObject *self, gint y); /* Selection. */ gboolean html_object_select_range (HTMLObject *self, HTMLEngine *engine, guint start, gint length, gboolean queue_draw); void html_object_append_selection_string (HTMLObject *self, GString *buffer); gchar *html_object_get_selection_string (HTMLObject *o, HTMLEngine *e); /* Saving. */ gboolean html_object_save (HTMLObject *self, HTMLEngineSaveState *state); gboolean html_object_save_plain (HTMLObject *self, HTMLEngineSaveState *state, gint requested_width); /* set change flag f of this object and of all its parents */ void html_object_change_set (HTMLObject *self, HTMLChangeFlags f); /* set change flag f for this object and all childern */ void html_object_change_set_down (HTMLObject *self, HTMLChangeFlags f); /* object data */ void html_object_set_data (HTMLObject *object, const gchar *key, const gchar *value); gpointer html_object_get_data (HTMLObject *object, const gchar *key); void html_object_copy_data_from_object (HTMLObject *dst, HTMLObject *src); /* * editing */ GList *html_object_get_bound_list (HTMLObject *obj, GList *list); void html_object_move_cursor_before_remove (HTMLObject *o, HTMLEngine *e); gboolean html_object_could_remove_whole (HTMLObject *o, GList *from, GList *to, GList *left, GList *right); void html_object_check_cut_lists (HTMLObject *self, HTMLObject *replacement, GList *left, GList *right); GList *html_object_heads_list (HTMLObject *o); GList *html_object_tails_list (HTMLObject *o); void html_object_merge_down (HTMLObject *o, HTMLObject *w, HTMLEngine *e); gboolean html_object_is_parent (HTMLObject *parent, HTMLObject *child); gint html_object_get_insert_level (HTMLObject *o); void html_object_engine_translation (HTMLObject *o, HTMLEngine *e, gint *tx, gint *ty); gboolean html_object_engine_intersection (HTMLObject *o, HTMLEngine *e, gint tx, gint ty, gint *x1, gint *y1, gint *x2, gint *y2); void html_object_add_to_changed (GList **changed_objs, HTMLObject *o); #endif /* _HTMLOBJECT_H_ */