pango/pango-layout.h

   1 /* Pango
   2  * pango-layout.h: High-level layout driver
   3  *
   4  * Copyright (C) 2000 Red Hat Software
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __PANGO_LAYOUT_H__
  23 #define __PANGO_LAYOUT_H__
  24
  25 #include <pango/pango-attributes.h>
  26 #include <pango/pango-context.h>
  27 #include <pango/pango-glyph-item.h>
  28 #include <pango/pango-tabs.h>
  29
  30 G_BEGIN_DECLS
  31
  32 typedef struct _PangoLayout      PangoLayout;
  33 typedef struct _PangoLayoutClass PangoLayoutClass;
  34 typedef struct _PangoLayoutLine  PangoLayoutLine;
  35
  36 typedef PangoGlyphItem PangoLayoutRun;
  37
  38 typedef enum {
  39   PANGO_ALIGN_LEFT,
  40   PANGO_ALIGN_CENTER,
  41   PANGO_ALIGN_RIGHT
  42 } PangoAlignment;
  43
  44 typedef enum {
  45   PANGO_WRAP_WORD,
  46   PANGO_WRAP_CHAR,
  47   PANGO_WRAP_WORD_CHAR
  48 } PangoWrapMode;
  49
  50 /**
  51  * PangoEllipsizeMode
  52  * @PANGO_ELLIPSIZE_NONE: No ellipsization
  53  * @PANGO_ELLIPSIZE_START: Omit characters at the start of the text
  54  * @PANGO_ELLIPSIZE_MIDDLE: Omit characters in the middle of the text
  55  * @PANGO_ELLIPSIZE_END: Omit characters at the end of the text
  56  *
  57  * The #PangoEllipsizeMode type describes what sort of (if any)
  58  * ellipsization should be applied to a line of text. In
  59  * the ellipsization process characters are removed from the
  60  * text in order to make it fit to a given width and replaced
  61  * with an ellipsis.
  62  */
  63 typedef enum {
  64   PANGO_ELLIPSIZE_NONE,
  65   PANGO_ELLIPSIZE_START,
  66   PANGO_ELLIPSIZE_MIDDLE,
  67   PANGO_ELLIPSIZE_END
  68 } PangoEllipsizeMode;
  69
  70 struct _PangoLayoutLine
  71 {
  72   PangoLayout *layout;
  73   gint         start_index;     /* start of line as byte index into layout->text */
  74   gint         length;          /* length of line in bytes */
  75   GSList      *runs;
  76   guint        is_paragraph_start : 1;  /* TRUE if this is the first line of the paragraph */
  77   guint        resolved_dir : 3;  /* Resolved PangoDirection of line */
  78 };
  79
  80 #define PANGO_TYPE_LAYOUT              (pango_layout_get_type ())
  81 #define PANGO_LAYOUT(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), PANGO_TYPE_LAYOUT, PangoLayout))
  82 #define PANGO_LAYOUT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  83 #define PANGO_IS_LAYOUT(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), PANGO_TYPE_LAYOUT))
  84 #define PANGO_IS_LAYOUT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_LAYOUT))
  85 #define PANGO_LAYOUT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_LAYOUT, PangoLayoutClass))
  86
  87 /* The PangoLayout and PangoLayoutClass structs are private; if you
  88  * need to create a subclass of these, file a bug.
  89  */
  90
  91 GType        pango_layout_get_type       (void) G_GNUC_CONST;
  92 PangoLayout *pango_layout_new            (PangoContext   *context);
  93 PangoLayout *pango_layout_copy           (PangoLayout    *src);
  94
  95 PangoContext  *pango_layout_get_context    (PangoLayout    *layout);
  96
  97 void           pango_layout_set_attributes (PangoLayout    *layout,
  98                                             PangoAttrList  *attrs);
  99 PangoAttrList *pango_layout_get_attributes (PangoLayout    *layout);
 100
 101 void           pango_layout_set_text       (PangoLayout    *layout,
 102                                             const char     *text,
 103                                             int             length);
 104 const char    *pango_layout_get_text       (PangoLayout    *layout);
 105
 106 void           pango_layout_set_markup     (PangoLayout    *layout,
 107                                             const char     *markup,
 108                                             int             length);
 109
 110 void           pango_layout_set_markup_with_accel (PangoLayout    *layout,
 111                                                    const char     *markup,
 112                                                    int             length,
 113                                                    gunichar        accel_marker,
 114                                                    gunichar       *accel_char);
 115
 116 void           pango_layout_set_font_description (PangoLayout                *layout,
 117                                                   const PangoFontDescription *desc);
 118
 119 G_CONST_RETURN PangoFontDescription *pango_layout_get_font_description (PangoLayout *layout);
 120
 121 void           pango_layout_set_width            (PangoLayout                *layout,
 122                                                   int                         width);
 123 int            pango_layout_get_width            (PangoLayout                *layout);
 124 void           pango_layout_set_height           (PangoLayout                *layout,
 125                                                   int                         height);
 126 int            pango_layout_get_height           (PangoLayout                *layout);
 127 void           pango_layout_set_wrap             (PangoLayout                *layout,
 128                                                   PangoWrapMode               wrap);
 129 PangoWrapMode  pango_layout_get_wrap             (PangoLayout                *layout);
 130 gboolean       pango_layout_is_wrapped           (PangoLayout                *layout);
 131 void           pango_layout_set_indent           (PangoLayout                *layout,
 132                                                   int                         indent);
 133 int            pango_layout_get_indent           (PangoLayout                *layout);
 134 void           pango_layout_set_spacing          (PangoLayout                *layout,
 135                                                   int                         spacing);
 136 int            pango_layout_get_spacing          (PangoLayout                *layout);
 137 void           pango_layout_set_justify          (PangoLayout                *layout,
 138                                                   gboolean                    justify);
 139 gboolean       pango_layout_get_justify          (PangoLayout                *layout);
 140 void           pango_layout_set_auto_dir         (PangoLayout                *layout,
 141                                                   gboolean                    auto_dir);
 142 gboolean       pango_layout_get_auto_dir         (PangoLayout                *layout);
 143 void           pango_layout_set_alignment        (PangoLayout                *layout,
 144                                                   PangoAlignment              alignment);
 145 PangoAlignment pango_layout_get_alignment        (PangoLayout                *layout);
 146
 147 void           pango_layout_set_tabs             (PangoLayout                *layout,
 148                                                   PangoTabArray              *tabs);
 149
 150 PangoTabArray* pango_layout_get_tabs             (PangoLayout                *layout);
 151
 152 void           pango_layout_set_single_paragraph_mode (PangoLayout                *layout,
 153                                                        gboolean                    setting);
 154 gboolean       pango_layout_get_single_paragraph_mode (PangoLayout                *layout);
 155
 156 void               pango_layout_set_ellipsize (PangoLayout        *layout,
 157                                                PangoEllipsizeMode  ellipsize);
 158 PangoEllipsizeMode pango_layout_get_ellipsize (PangoLayout        *layout);
 159 gboolean           pango_layout_is_ellipsized (PangoLayout        *layout);
 160
 161 int      pango_layout_get_unknown_glyphs_count (PangoLayout    *layout);
 162
 163 void     pango_layout_context_changed (PangoLayout    *layout);
 164
 165 void     pango_layout_get_log_attrs (PangoLayout    *layout,
 166                                      PangoLogAttr  **attrs,
 167                                      gint           *n_attrs);
 168
 169 void     pango_layout_index_to_pos         (PangoLayout    *layout,
 170                                             int             index_,
 171                                             PangoRectangle *pos);
 172 void     pango_layout_index_to_line_x      (PangoLayout    *layout,
 173                                             int             index_,
 174                                             gboolean        trailing,
 175                                             int            *line,
 176                                             int            *x_pos);
 177 void     pango_layout_get_cursor_pos       (PangoLayout    *layout,
 178                                             int             index_,
 179                                             PangoRectangle *strong_pos,
 180                                             PangoRectangle *weak_pos);
 181 void     pango_layout_move_cursor_visually (PangoLayout    *layout,
 182                                             gboolean        strong,
 183                                             int             old_index,
 184                                             int             old_trailing,
 185                                             int             direction,
 186                                             int            *new_index,
 187                                             int            *new_trailing);
 188 gboolean pango_layout_xy_to_index          (PangoLayout    *layout,
 189                                             int             x,
 190                                             int             y,
 191                                             int            *index_,
 192                                             int            *trailing);
 193 void     pango_layout_get_extents          (PangoLayout    *layout,
 194                                             PangoRectangle *ink_rect,
 195                                             PangoRectangle *logical_rect);
 196 void     pango_layout_get_pixel_extents    (PangoLayout    *layout,
 197                                             PangoRectangle *ink_rect,
 198                                             PangoRectangle *logical_rect);
 199 void     pango_layout_get_size             (PangoLayout    *layout,
 200                                             int            *width,
 201                                             int            *height);
 202 void     pango_layout_get_pixel_size       (PangoLayout    *layout,
 203                                             int            *width,
 204                                             int            *height);
 205 int      pango_layout_get_baseline         (PangoLayout    *layout);
 206
 207 int              pango_layout_get_line_count       (PangoLayout    *layout);
 208 PangoLayoutLine *pango_layout_get_line             (PangoLayout    *layout,
 209                                                     int             line);
 210 PangoLayoutLine *pango_layout_get_line_readonly    (PangoLayout    *layout,
 211                                                     int             line);
 212 GSList *         pango_layout_get_lines            (PangoLayout    *layout);
 213 GSList *         pango_layout_get_lines_readonly   (PangoLayout    *layout);
 214
 215
 216 #define PANGO_TYPE_LAYOUT_LINE (pango_layout_line_get_type ())
 217
 218 GType    pango_layout_line_get_type     (void) G_GNUC_CONST;
 219
 220 PangoLayoutLine *pango_layout_line_ref   (PangoLayoutLine *line);
 221 void             pango_layout_line_unref (PangoLayoutLine *line);
 222
 223 gboolean pango_layout_line_x_to_index   (PangoLayoutLine  *line,
 224                                          int               x_pos,
 225                                          int              *index_,
 226                                          int              *trailing);
 227 void     pango_layout_line_index_to_x   (PangoLayoutLine  *line,
 228                                          int               index_,
 229                                          gboolean          trailing,
 230                                          int              *x_pos);
 231 void     pango_layout_line_get_x_ranges (PangoLayoutLine  *line,
 232                                          int               start_index,
 233                                          int               end_index,
 234                                          int             **ranges,
 235                                          int              *n_ranges);
 236 void     pango_layout_line_get_extents  (PangoLayoutLine  *line,
 237                                          PangoRectangle   *ink_rect,
 238                                          PangoRectangle   *logical_rect);
 239 void     pango_layout_line_get_pixel_extents (PangoLayoutLine *layout_line,
 240                                               PangoRectangle  *ink_rect,
 241                                               PangoRectangle  *logical_rect);
 242
 243 typedef struct _PangoLayoutIter PangoLayoutIter;
 244
 245 #define PANGO_TYPE_LAYOUT_ITER         (pango_layout_iter_get_type ())
 246
 247 GType            pango_layout_iter_get_type (void) G_GNUC_CONST;
 248
 249 PangoLayoutIter *pango_layout_get_iter  (PangoLayout     *layout);
 250 PangoLayoutIter *pango_layout_iter_copy (PangoLayoutIter *iter);
 251 void             pango_layout_iter_free (PangoLayoutIter *iter);
 252
 253 int              pango_layout_iter_get_index  (PangoLayoutIter *iter);
 254 PangoLayoutRun  *pango_layout_iter_get_run    (PangoLayoutIter *iter);
 255 PangoLayoutRun  *pango_layout_iter_get_run_readonly   (PangoLayoutIter *iter);
 256 PangoLayoutLine *pango_layout_iter_get_line   (PangoLayoutIter *iter);
 257 PangoLayoutLine *pango_layout_iter_get_line_readonly  (PangoLayoutIter *iter);
 258 gboolean         pango_layout_iter_at_last_line (PangoLayoutIter *iter);
 259 PangoLayout     *pango_layout_iter_get_layout (PangoLayoutIter *iter);
 260
 261 gboolean pango_layout_iter_next_char    (PangoLayoutIter *iter);
 262 gboolean pango_layout_iter_next_cluster (PangoLayoutIter *iter);
 263 gboolean pango_layout_iter_next_run     (PangoLayoutIter *iter);
 264 gboolean pango_layout_iter_next_line    (PangoLayoutIter *iter);
 265
 266 void pango_layout_iter_get_char_extents    (PangoLayoutIter *iter,
 267                                             PangoRectangle  *logical_rect);
 268 void pango_layout_iter_get_cluster_extents (PangoLayoutIter *iter,
 269                                             PangoRectangle  *ink_rect,
 270                                             PangoRectangle  *logical_rect);
 271 void pango_layout_iter_get_run_extents     (PangoLayoutIter *iter,
 272                                             PangoRectangle  *ink_rect,
 273                                             PangoRectangle  *logical_rect);
 274 void pango_layout_iter_get_line_extents    (PangoLayoutIter *iter,
 275                                             PangoRectangle  *ink_rect,
 276                                             PangoRectangle  *logical_rect);
 277 /* All the yranges meet, unlike the logical_rect's (i.e. the yranges
 278  * assign between-line spacing to the nearest line)
 279  */
 280 void pango_layout_iter_get_line_yrange     (PangoLayoutIter *iter,
 281                                             int             *y0_,
 282                                             int             *y1_);
 283 void pango_layout_iter_get_layout_extents  (PangoLayoutIter *iter,
 284                                             PangoRectangle  *ink_rect,
 285                                             PangoRectangle  *logical_rect);
 286 int  pango_layout_iter_get_baseline        (PangoLayoutIter *iter);
 287
 288 G_END_DECLS
 289
 290 #endif /* __PANGO_LAYOUT_H__ */
 291