Pileus Git - ~andy/gtk/blob - gtk/gtktextlayout.h

   1 /* GTK - The GIMP Toolkit
   2  * gtktextlayout.h
   3  *
   4  * Copyright (c) 1992-1994 The Regents of the University of California.
   5  * Copyright (c) 1994-1997 Sun Microsystems, Inc.
   6  * Copyright (c) 2000 Red Hat, Inc.
   7  * Tk->Gtk port by Havoc Pennington
   8  * Pango support by Owen Taylor
   9  *
  10  * This file can be used under your choice of two licenses, the LGPL
  11  * and the original Tk license.
  12  *
  13  * LGPL:
  14  *
  15  * This library is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU Lesser General Public
  17  * License as published by the Free Software Foundation; either
  18  * version 2 of the License, or (at your option) any later version.
  19  *
  20  * This library is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  * Lesser General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU Lesser General Public
  26  * License along with this library; if not, write to the Free
  27  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  28  *
  29  * Original Tk license:
  30  *
  31  * This software is copyrighted by the Regents of the University of
  32  * California, Sun Microsystems, Inc., and other parties.  The
  33  * following terms apply to all files associated with the software
  34  * unless explicitly disclaimed in individual files.
  35  *
  36  * The authors hereby grant permission to use, copy, modify,
  37  * distribute, and license this software and its documentation for any
  38  * purpose, provided that existing copyright notices are retained in
  39  * all copies and that this notice is included verbatim in any
  40  * distributions. No written agreement, license, or royalty fee is
  41  * required for any of the authorized uses.  Modifications to this
  42  * software may be copyrighted by their authors and need not follow
  43  * the licensing terms described here, provided that the new terms are
  44  * clearly indicated on the first page of each file where they apply.
  45  *
  46  * IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY
  47  * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
  48  * DAMAGES ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION,
  49  * OR ANY DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED
  50  * OF THE POSSIBILITY OF SUCH DAMAGE.
  51  *
  52  * THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
  53  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  54  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
  55  * NON-INFRINGEMENT.  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS,
  56  * AND THE AUTHORS AND DISTRIBUTORS HAVE NO OBLIGATION TO PROVIDE
  57  * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  58  *
  59  * GOVERNMENT USE: If you are acquiring this software on behalf of the
  60  * U.S. government, the Government shall have only "Restricted Rights"
  61  * in the software and related documentation as defined in the Federal
  62  * Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
  63  * are acquiring the software on behalf of the Department of Defense,
  64  * the software shall be classified as "Commercial Computer Software"
  65  * and the Government shall have only "Restricted Rights" as defined
  66  * in Clause 252.227-7013 (c) (1) of DFARs.  Notwithstanding the
  67  * foregoing, the authors grant the U.S. Government and others acting
  68  * in its behalf permission to use and distribute the software in
  69  * accordance with the terms specified in this license.
  70  *
  71  */
  72 /*
  73  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  74  * file for a list of people on the GTK+ Team.  See the ChangeLog
  75  * files for a list of changes.  These files are distributed with
  76  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  77  */
  78
  79 #ifndef GTK_TEXT_LAYOUT_H
  80 #define GTK_TEXT_LAYOUT_H
  81
  82 #ifdef __cplusplus
  83 extern "C" {
  84 #endif /* __cplusplus */
  85
  86 /* This is a "semi-private" header; it is intended for
  87  * use by the text widget, and the text canvas item,
  88  * but that's all. We may have to install it so the
  89  * canvas item can use it, but users are not supposed
  90  * to use it.
  91  */
  92 #ifndef GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
  93 #error "You are not supposed to be including this file; the equivalent public API is in gtktextview.h"
  94 #endif
  95
  96 #include <gtk/gtktextbuffer.h>
  97 #include <gtk/gtktextiter.h>
  98
  99 /* forward declarations that have to be here to avoid including
 100  * gtktextbtree.h
 101  */
 102 typedef struct _GtkTextLine     GtkTextLine;
 103 typedef struct _GtkTextLineData GtkTextLineData;
 104
 105 #define GTK_TYPE_TEXT_LAYOUT             (gtk_text_layout_get_type ())
 106 #define GTK_TEXT_LAYOUT(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayout))
 107 #define GTK_TEXT_LAYOUT_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
 108 #define GTK_IS_TEXT_LAYOUT(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_LAYOUT))
 109 #define GTK_IS_TEXT_LAYOUT_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_LAYOUT))
 110 #define GTK_TEXT_LAYOUT_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
 111
 112 typedef struct _GtkTextLayout         GtkTextLayout;
 113 typedef struct _GtkTextLayoutClass    GtkTextLayoutClass;
 114 typedef struct _GtkTextLineDisplay    GtkTextLineDisplay;
 115 typedef struct _GtkTextCursorDisplay  GtkTextCursorDisplay;
 116 typedef struct _GtkTextAttrAppearance GtkTextAttrAppearance;
 117
 118 struct _GtkTextLayout
 119 {
 120   GObject parent_instance;
 121
 122   /* width of the display area on-screen,
 123    * i.e. pixels we should wrap to fit inside. */
 124   gint screen_width;
 125
 126   /* width/height of the total logical area being layed out */
 127   gint width;
 128   gint height;
 129
 130   /* Pixel offsets from the left and from the top to be used when we
 131    * draw; these allow us to create left/top margins. We don't need
 132    * anything special for bottom/right margins, because those don't
 133    * affect drawing.
 134    */
 135   /* gint left_edge; */
 136   /* gint top_edge; */
 137
 138   GtkTextBuffer *buffer;
 139
 140   /* Default style used if no tags override it */
 141   GtkTextAttributes *default_style;
 142
 143   /* Pango contexts used for creating layouts */
 144   PangoContext *ltr_context;
 145   PangoContext *rtl_context;
 146
 147   /* A cache of one style; this is used to ensure
 148    * we don't constantly regenerate the style
 149    * over long runs with the same style. */
 150   GtkTextAttributes *one_style_cache;
 151
 152   /* A cache of one line display. Getting the same line
 153    * many times in a row is the most common case.
 154    */
 155   GtkTextLineDisplay *one_display_cache;
 156
 157   /* Whether we are allowed to wrap right now */
 158   gint wrap_loop_count;
 159
 160   /* Whether to show the insertion cursor */
 161   guint cursor_visible : 1;
 162
 163   /* For what GtkTextDirection to draw cursor GTK_TEXT_DIR_NONE -
 164    * means draw both cursors.
 165    */
 166   gint cursor_direction : 2;
 167
 168   /* The preedit string and attributes, if any */
 169
 170   gchar *preedit_string;
 171   PangoAttrList *preedit_attrs;
 172   gint preedit_len;
 173   gint preedit_cursor;
 174 };
 175
 176 struct _GtkTextLayoutClass
 177 {
 178   GObjectClass parent_class;
 179
 180   /* Some portion of the layout was invalidated
 181    */
 182   void  (*invalidated)  (GtkTextLayout *layout);
 183
 184   /* A range of the layout changed appearance and possibly height
 185    */
 186   void  (*changed)              (GtkTextLayout     *layout,
 187                                  gint               y,
 188                                  gint               old_height,
 189                                  gint               new_height);
 190   GtkTextLineData* (*wrap)      (GtkTextLayout     *layout,
 191                                  GtkTextLine       *line,
 192                                  GtkTextLineData   *line_data); /* may be NULL */
 193   void  (*get_log_attrs)        (GtkTextLayout     *layout,
 194                                  GtkTextLine       *line,
 195                                  PangoLogAttr     **attrs,
 196                                  gint              *n_attrs);
 197   void  (*invalidate)           (GtkTextLayout     *layout,
 198                                  const GtkTextIter *start,
 199                                  const GtkTextIter *end);
 200   void  (*free_line_data)       (GtkTextLayout     *layout,
 201                                  GtkTextLine       *line,
 202                                  GtkTextLineData   *line_data);
 203
 204   void (*allocate_child)        (GtkTextLayout     *layout,
 205                                  GtkWidget         *child,
 206                                  gint               x,
 207                                  gint               y);
 208 };
 209
 210 struct _GtkTextAttrAppearance
 211 {
 212   PangoAttribute attr;
 213   GtkTextAppearance appearance;
 214 };
 215 struct _GtkTextCursorDisplay
 216 {
 217   gint x;
 218   gint y;
 219   gint height;
 220   guint is_strong : 1;
 221   guint is_weak : 1;
 222 };
 223 struct _GtkTextLineDisplay
 224 {
 225   PangoLayout *layout;
 226   GSList *cursors;
 227   GSList *shaped_objects;
 228
 229   GtkTextDirection direction;
 230
 231   gint width;                   /* Width of layout */
 232   gint total_width;             /* width - margins, if no width set on layout, if width set on layout, -1 */
 233   gint height;
 234   /* Amount layout is shifted from left edge - this is the left margin
 235    * plus any other factors, such as alignment or indentation.
 236    */
 237   gint x_offset;
 238   gint left_margin;
 239   gint right_margin;
 240   gint top_margin;
 241   gint bottom_margin;
 242   gint insert_index;            /* Byte index of insert cursor within para or -1 */
 243
 244   gboolean size_only;
 245   GtkTextLine *line;
 246 };
 247
 248 extern PangoAttrType gtk_text_attr_appearance_type;
 249
 250 GType         gtk_text_layout_get_type    (void) G_GNUC_CONST;
 251
 252 GtkTextLayout*     gtk_text_layout_new                   (void);
 253 void               gtk_text_layout_set_buffer            (GtkTextLayout     *layout,
 254                                                           GtkTextBuffer     *buffer);
 255 GtkTextBuffer     *gtk_text_layout_get_buffer            (GtkTextLayout     *layout);
 256 void               gtk_text_layout_set_default_style     (GtkTextLayout     *layout,
 257                                                           GtkTextAttributes *values);
 258 void               gtk_text_layout_set_contexts          (GtkTextLayout     *layout,
 259                                                           PangoContext      *ltr_context,
 260                                                           PangoContext      *rtl_context);
 261 void               gtk_text_layout_set_cursor_direction  (GtkTextLayout     *layout,
 262                                                           GtkTextDirection   direction);
 263 void               gtk_text_layout_default_style_changed (GtkTextLayout     *layout);
 264
 265 void gtk_text_layout_set_screen_width       (GtkTextLayout     *layout,
 266                                              gint               width);
 267 void gtk_text_layout_set_preedit_string     (GtkTextLayout     *layout,
 268                                              const gchar       *preedit_string,
 269                                              PangoAttrList     *preedit_attrs,
 270                                              gint               cursor_pos);
 271
 272 void     gtk_text_layout_set_cursor_visible (GtkTextLayout     *layout,
 273                                              gboolean           cursor_visible);
 274 gboolean gtk_text_layout_get_cursor_visible (GtkTextLayout     *layout);
 275
 276 /* Getting the size or the lines potentially results in a call to
 277  * recompute, which is pretty massively expensive. Thus it should
 278  * basically only be done in an idle handler.
 279  *
 280  * Long-term, we would really like to be able to do these without
 281  * a full recompute so they may get cheaper over time.
 282  */
 283 void    gtk_text_layout_get_size  (GtkTextLayout  *layout,
 284                                    gint           *width,
 285                                    gint           *height);
 286 GSList* gtk_text_layout_get_lines (GtkTextLayout  *layout,
 287                                    /* [top_y, bottom_y) */
 288                                    gint            top_y,
 289                                    gint            bottom_y,
 290                                    gint           *first_line_y);
 291
 292 void gtk_text_layout_wrap_loop_start (GtkTextLayout *layout);
 293 void gtk_text_layout_wrap_loop_end   (GtkTextLayout *layout);
 294
 295 GtkTextLineDisplay* gtk_text_layout_get_line_display  (GtkTextLayout      *layout,
 296                                                        GtkTextLine        *line,
 297                                                        gboolean            size_only);
 298 void                gtk_text_layout_free_line_display (GtkTextLayout      *layout,
 299                                                        GtkTextLineDisplay *display);
 300
 301 void gtk_text_layout_get_line_at_y     (GtkTextLayout     *layout,
 302                                         GtkTextIter       *target_iter,
 303                                         gint               y,
 304                                         gint              *line_top);
 305 void gtk_text_layout_get_iter_at_pixel (GtkTextLayout     *layout,
 306                                         GtkTextIter       *iter,
 307                                         gint               x,
 308                                         gint               y);
 309 void gtk_text_layout_invalidate        (GtkTextLayout     *layout,
 310                                         const GtkTextIter *start,
 311                                         const GtkTextIter *end);
 312 void gtk_text_layout_free_line_data    (GtkTextLayout     *layout,
 313                                         GtkTextLine       *line,
 314                                         GtkTextLineData   *line_data);
 315
 316 gboolean gtk_text_layout_is_valid        (GtkTextLayout *layout);
 317 void     gtk_text_layout_validate_yrange (GtkTextLayout *layout,
 318                                           GtkTextIter   *anchor_line,
 319                                           gint           y0,
 320                                           gint           y1);
 321 void     gtk_text_layout_validate        (GtkTextLayout *layout,
 322                                           gint           max_pixels);
 323
 324 /* This function should return the passed-in line data,
 325  * OR remove the existing line data from the line, and
 326  * return a NEW line data after adding it to the line.
 327  * That is, invariant after calling the callback is that
 328  * there should be exactly one line data for this view
 329  * stored on the btree line.
 330  */
 331 GtkTextLineData* gtk_text_layout_wrap  (GtkTextLayout   *layout,
 332                                         GtkTextLine     *line,
 333                                         GtkTextLineData *line_data); /* may be NULL */
 334 void     gtk_text_layout_changed              (GtkTextLayout     *layout,
 335                                                gint               y,
 336                                                gint               old_height,
 337                                                gint               new_height);
 338 void     gtk_text_layout_get_iter_location    (GtkTextLayout     *layout,
 339                                                const GtkTextIter *iter,
 340                                                GdkRectangle      *rect);
 341 void     gtk_text_layout_get_line_yrange      (GtkTextLayout     *layout,
 342                                                const GtkTextIter *iter,
 343                                                gint              *y,
 344                                                gint              *height);
 345 void     gtk_text_layout_get_cursor_locations (GtkTextLayout     *layout,
 346                                                GtkTextIter       *iter,
 347                                                GdkRectangle      *strong_pos,
 348                                                GdkRectangle      *weak_pos);
 349 gboolean gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout     *layout,
 350                                                GtkTextIter       *iter,
 351                                                gint               top,
 352                                                gint               bottom);
 353
 354 gboolean gtk_text_layout_move_iter_to_line_end      (GtkTextLayout *layout,
 355                                                      GtkTextIter   *iter,
 356                                                      gint           direction);
 357 gboolean gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout,
 358                                                      GtkTextIter   *iter);
 359 gboolean gtk_text_layout_move_iter_to_next_line     (GtkTextLayout *layout,
 360                                                      GtkTextIter   *iter);
 361 void     gtk_text_layout_move_iter_to_x             (GtkTextLayout *layout,
 362                                                      GtkTextIter   *iter,
 363                                                      gint           x);
 364 gboolean gtk_text_layout_move_iter_visually         (GtkTextLayout *layout,
 365                                                      GtkTextIter   *iter,
 366                                                      gint           count);
 367
 368 gboolean gtk_text_layout_iter_starts_line           (GtkTextLayout       *layout,
 369                                                      const GtkTextIter   *iter);
 370
 371 void     gtk_text_layout_get_iter_at_line           (GtkTextLayout *layout,
 372                                                      GtkTextIter    *iter,
 373                                                      GtkTextLine    *line,
 374                                                      gint            byte_offset);
 375
 376 /* Don't use these. Use gtk_text_view_add_child_at_anchor().
 377  * These functions are defined in gtktextchild.c, but here
 378  * since they are semi-public and require GtkTextLayout to
 379  * be declared.
 380  */
 381 void gtk_text_child_anchor_register_child   (GtkTextChildAnchor *anchor,
 382                                              GtkWidget          *child,
 383                                              GtkTextLayout      *layout);
 384 void gtk_text_child_anchor_unregister_child (GtkTextChildAnchor *anchor,
 385                                              GtkWidget          *child);
 386
 387 void gtk_text_child_anchor_queue_resize     (GtkTextChildAnchor *anchor,
 388                                              GtkTextLayout      *layout);
 389
 390 void gtk_text_anchored_child_set_layout     (GtkWidget          *child,
 391                                              GtkTextLayout      *layout);
 392
 393 void gtk_text_layout_spew (GtkTextLayout *layout);
 394
 395 #ifdef __cplusplus
 396 }
 397 #endif /* __cplusplus */
 398
 399 #endif  /* GTK_TEXT_LAYOUT_H */