diff options
Diffstat (limited to 'trunk/pango/pango-layout.h')
| -rw-r--r-- | trunk/pango/pango-layout.h | 286 |
1 files changed, 286 insertions, 0 deletions
diff --git a/trunk/pango/pango-layout.h b/trunk/pango/pango-layout.h new file mode 100644 index 00000000..d84b1f79 --- /dev/null +++ b/trunk/pango/pango-layout.h @@ -0,0 +1,286 @@ +/* Pango + * pango-layout.h: High-level layout driver + * + * Copyright (C) 2000 Red Hat Software + * + * 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 + * MERCHANTABILITY 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; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __PANGO_LAYOUT_H__ +#define __PANGO_LAYOUT_H__ + +#include <pango/pango-attributes.h> +#include <pango/pango-context.h> +#include <pango/pango-glyph-item.h> +#include <pango/pango-tabs.h> + +G_BEGIN_DECLS + +typedef struct _PangoLayout PangoLayout; +typedef struct _PangoLayoutClass PangoLayoutClass; +typedef struct _PangoLayoutLine PangoLayoutLine; + +/* For backwards compatiblity */ +typedef PangoGlyphItem PangoLayoutRun; + +typedef enum { + PANGO_ALIGN_LEFT, + PANGO_ALIGN_CENTER, + PANGO_ALIGN_RIGHT +} PangoAlignment; + +typedef enum { + PANGO_WRAP_WORD, + PANGO_WRAP_CHAR, + PANGO_WRAP_WORD_CHAR +} PangoWrapMode; + +/** + * PangoEllipsizeMode + * @PANGO_ELLIPSIZE_NONE: No ellipsization + * @PANGO_ELLIPSIZE_START: Omit characters at the start of the text + * @PANGO_ELLIPSIZE_MIDDLE: Omit characters in the middle of the text + * @PANGO_ELLIPSIZE_END: Omit characters at the end of the text + * + * The #PangoEllipsizeMode type describes what sort of (if any) + * ellipsization should be applied to a line of text. In + * the ellipsization process characters are removed from the + * text in order to make it fit to a given width and replaced + * with an ellipsis. + */ +typedef enum { + PANGO_ELLIPSIZE_NONE, + PANGO_ELLIPSIZE_START, + PANGO_ELLIPSIZE_MIDDLE, + PANGO_ELLIPSIZE_END +} PangoEllipsizeMode; + +struct _PangoLayoutLine +{ + PangoLayout *layout; + gint start_index; /* start of line as byte index into layout->text */ + gint length; /* length of line in bytes */ + GSList *runs; + guint is_paragraph_start : 1; /* TRUE if this is the first line of the paragraph */ + guint resolved_dir : 3; /* Resolved PangoDirection of line */ +}; + +#define PANGO_TYPE_LAYOUT (pango_layout_get_type ()) +#define PANGO_LAYOUT(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_LAYOUT, PangoLayout)) +#define PANGO_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_LAYOUT, PangoLayoutClass)) +#define PANGO_IS_LAYOUT(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_LAYOUT)) +#define PANGO_IS_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_LAYOUT)) +#define PANGO_LAYOUT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_LAYOUT, PangoLayoutClass)) + +/* The PangoLayout and PangoLayoutClass structs are private; if you + * need to create a subclass of these, file a bug. + */ + +GType pango_layout_get_type (void) G_GNUC_CONST; +PangoLayout *pango_layout_new (PangoContext *context); +PangoLayout *pango_layout_copy (PangoLayout *src); + +PangoContext *pango_layout_get_context (PangoLayout *layout); + +void pango_layout_set_attributes (PangoLayout *layout, + PangoAttrList *attrs); +PangoAttrList *pango_layout_get_attributes (PangoLayout *layout); + +void pango_layout_set_text (PangoLayout *layout, + const char *text, + int length); +const char *pango_layout_get_text (PangoLayout *layout); + +void pango_layout_set_markup (PangoLayout *layout, + const char *markup, + int length); + +void pango_layout_set_markup_with_accel (PangoLayout *layout, + const char *markup, + int length, + gunichar accel_marker, + gunichar *accel_char); + +void pango_layout_set_font_description (PangoLayout *layout, + const PangoFontDescription *desc); + +G_CONST_RETURN PangoFontDescription *pango_layout_get_font_description (PangoLayout *layout); + +void pango_layout_set_width (PangoLayout *layout, + int width); +int pango_layout_get_width (PangoLayout *layout); +void pango_layout_set_wrap (PangoLayout *layout, + PangoWrapMode wrap); +PangoWrapMode pango_layout_get_wrap (PangoLayout *layout); +gboolean pango_layout_is_wrapped (PangoLayout *layout); +void pango_layout_set_indent (PangoLayout *layout, + int indent); +int pango_layout_get_indent (PangoLayout *layout); +void pango_layout_set_spacing (PangoLayout *layout, + int spacing); +int pango_layout_get_spacing (PangoLayout *layout); +void pango_layout_set_justify (PangoLayout *layout, + gboolean justify); +gboolean pango_layout_get_justify (PangoLayout *layout); +void pango_layout_set_auto_dir (PangoLayout *layout, + gboolean auto_dir); +gboolean pango_layout_get_auto_dir (PangoLayout *layout); +void pango_layout_set_alignment (PangoLayout *layout, + PangoAlignment alignment); +PangoAlignment pango_layout_get_alignment (PangoLayout *layout); + +void pango_layout_set_tabs (PangoLayout *layout, + PangoTabArray *tabs); + +PangoTabArray* pango_layout_get_tabs (PangoLayout *layout); + +void pango_layout_set_single_paragraph_mode (PangoLayout *layout, + gboolean setting); +gboolean pango_layout_get_single_paragraph_mode (PangoLayout *layout); + +void pango_layout_set_ellipsize (PangoLayout *layout, + PangoEllipsizeMode ellipsize); +PangoEllipsizeMode pango_layout_get_ellipsize (PangoLayout *layout); +gboolean pango_layout_is_ellipsized (PangoLayout *layout); + +int pango_layout_get_unknown_glyphs_count (PangoLayout *layout); + +void pango_layout_context_changed (PangoLayout *layout); + +void pango_layout_get_log_attrs (PangoLayout *layout, + PangoLogAttr **attrs, + gint *n_attrs); + +void pango_layout_index_to_pos (PangoLayout *layout, + int index_, + PangoRectangle *pos); +void pango_layout_index_to_line_x (PangoLayout *layout, + int index_, + gboolean trailing, + int *line, + int *x_pos); +void pango_layout_get_cursor_pos (PangoLayout *layout, + int index_, + PangoRectangle *strong_pos, + PangoRectangle *weak_pos); +void pango_layout_move_cursor_visually (PangoLayout *layout, + gboolean strong, + int old_index, + int old_trailing, + int direction, + int *new_index, + int *new_trailing); +gboolean pango_layout_xy_to_index (PangoLayout *layout, + int x, + int y, + int *index_, + int *trailing); +void pango_layout_get_extents (PangoLayout *layout, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +void pango_layout_get_pixel_extents (PangoLayout *layout, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +void pango_layout_get_size (PangoLayout *layout, + int *width, + int *height); +void pango_layout_get_pixel_size (PangoLayout *layout, + int *width, + int *height); + +int pango_layout_get_line_count (PangoLayout *layout); +PangoLayoutLine *pango_layout_get_line (PangoLayout *layout, + int line); +PangoLayoutLine *pango_layout_get_line_readonly (PangoLayout *layout, + int line); +GSList * pango_layout_get_lines (PangoLayout *layout); +GSList * pango_layout_get_lines_readonly (PangoLayout *layout); + + +#define PANGO_TYPE_LAYOUT_LINE (pango_layout_line_get_type ()) + +GType pango_layout_line_get_type (void) G_GNUC_CONST; + +PangoLayoutLine *pango_layout_line_ref (PangoLayoutLine *line); +void pango_layout_line_unref (PangoLayoutLine *line); + +gboolean pango_layout_line_x_to_index (PangoLayoutLine *line, + int x_pos, + int *index_, + int *trailing); +void pango_layout_line_index_to_x (PangoLayoutLine *line, + int index_, + gboolean trailing, + int *x_pos); +void pango_layout_line_get_x_ranges (PangoLayoutLine *line, + int start_index, + int end_index, + int **ranges, + int *n_ranges); +void pango_layout_line_get_extents (PangoLayoutLine *line, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +void pango_layout_line_get_pixel_extents (PangoLayoutLine *layout_line, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); + +typedef struct _PangoLayoutIter PangoLayoutIter; + +#define PANGO_TYPE_LAYOUT_ITER (pango_layout_iter_get_type ()) + +GType pango_layout_iter_get_type (void) G_GNUC_CONST; + +PangoLayoutIter *pango_layout_get_iter (PangoLayout *layout); +void pango_layout_iter_free (PangoLayoutIter *iter); + +int pango_layout_iter_get_index (PangoLayoutIter *iter); +PangoLayoutRun *pango_layout_iter_get_run (PangoLayoutIter *iter); +PangoLayoutRun *pango_layout_iter_get_run_readonly (PangoLayoutIter *iter); +PangoLayoutLine *pango_layout_iter_get_line (PangoLayoutIter *iter); +PangoLayoutLine *pango_layout_iter_get_line_readonly (PangoLayoutIter *iter); +gboolean pango_layout_iter_at_last_line (PangoLayoutIter *iter); + +gboolean pango_layout_iter_next_char (PangoLayoutIter *iter); +gboolean pango_layout_iter_next_cluster (PangoLayoutIter *iter); +gboolean pango_layout_iter_next_run (PangoLayoutIter *iter); +gboolean pango_layout_iter_next_line (PangoLayoutIter *iter); + +void pango_layout_iter_get_char_extents (PangoLayoutIter *iter, + PangoRectangle *logical_rect); +void pango_layout_iter_get_cluster_extents (PangoLayoutIter *iter, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +void pango_layout_iter_get_run_extents (PangoLayoutIter *iter, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +void pango_layout_iter_get_line_extents (PangoLayoutIter *iter, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +/* All the yranges meet, unlike the logical_rect's (i.e. the yranges + * assign between-line spacing to the nearest line) + */ +void pango_layout_iter_get_line_yrange (PangoLayoutIter *iter, + int *y0_, + int *y1_); +void pango_layout_iter_get_layout_extents (PangoLayoutIter *iter, + PangoRectangle *ink_rect, + PangoRectangle *logical_rect); +int pango_layout_iter_get_baseline (PangoLayoutIter *iter); + +G_END_DECLS + +#endif /* __PANGO_LAYOUT_H__ */ + |