1 /* GTK - The GIMP Toolkit
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
10 * This file can be used under your choice of two licenses, the LGPL
11 * and the original Tk license.
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.
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.
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.
29 * Original Tk license:
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.
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.
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.
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.
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.
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/.
79 #ifndef __GTK_TEXT_LAYOUT_H__
80 #define __GTK_TEXT_LAYOUT_H__
82 /* This is a "semi-private" header; it is intended for
83 * use by the text widget, and the text canvas item,
84 * but that's all. We may have to install it so the
85 * canvas item can use it, but users are not supposed
88 #ifndef GTK_TEXT_USE_INTERNAL_UNSUPPORTED_API
89 #error "You are not supposed to be including this file; the equivalent public API is in gtktextview.h"
92 #include <gtk/gtktextbuffer.h>
93 #include <gtk/gtktextiter.h>
97 /* forward declarations that have to be here to avoid including
100 typedef struct _GtkTextLine GtkTextLine;
101 typedef struct _GtkTextLineData GtkTextLineData;
103 #define GTK_TYPE_TEXT_LAYOUT (gtk_text_layout_get_type ())
104 #define GTK_TEXT_LAYOUT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayout))
105 #define GTK_TEXT_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
106 #define GTK_IS_TEXT_LAYOUT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_LAYOUT))
107 #define GTK_IS_TEXT_LAYOUT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_LAYOUT))
108 #define GTK_TEXT_LAYOUT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
110 typedef struct _GtkTextLayout GtkTextLayout;
111 typedef struct _GtkTextLayoutClass GtkTextLayoutClass;
112 typedef struct _GtkTextLineDisplay GtkTextLineDisplay;
113 typedef struct _GtkTextCursorDisplay GtkTextCursorDisplay;
114 typedef struct _GtkTextAttrAppearance GtkTextAttrAppearance;
116 struct _GtkTextLayout
118 GObject parent_instance;
120 /* width of the display area on-screen,
121 * i.e. pixels we should wrap to fit inside. */
124 /* width/height of the total logical area being layed out */
128 /* Pixel offsets from the left and from the top to be used when we
129 * draw; these allow us to create left/top margins. We don't need
130 * anything special for bottom/right margins, because those don't
133 /* gint left_edge; */
136 GtkTextBuffer *buffer;
138 /* Default style used if no tags override it */
139 GtkTextAttributes *default_style;
141 /* Pango contexts used for creating layouts */
142 PangoContext *ltr_context;
143 PangoContext *rtl_context;
145 /* A cache of one style; this is used to ensure
146 * we don't constantly regenerate the style
147 * over long runs with the same style. */
148 GtkTextAttributes *one_style_cache;
150 /* A cache of one line display. Getting the same line
151 * many times in a row is the most common case.
153 GtkTextLineDisplay *one_display_cache;
155 /* Whether we are allowed to wrap right now */
156 gint wrap_loop_count;
158 /* Whether to show the insertion cursor */
159 guint cursor_visible : 1;
161 /* For what GtkTextDirection to draw cursor GTK_TEXT_DIR_NONE -
162 * means draw both cursors.
164 guint cursor_direction : 2;
166 /* The keyboard direction is used to default the alignment when
167 there are no strong characters.
169 guint keyboard_direction : 2;
171 /* The preedit string and attributes, if any */
173 gchar *preedit_string;
174 PangoAttrList *preedit_attrs;
179 struct _GtkTextLayoutClass
181 GObjectClass parent_class;
183 /* Some portion of the layout was invalidated
185 void (*invalidated) (GtkTextLayout *layout);
187 /* A range of the layout changed appearance and possibly height
189 void (*changed) (GtkTextLayout *layout,
193 GtkTextLineData* (*wrap) (GtkTextLayout *layout,
195 GtkTextLineData *line_data); /* may be NULL */
196 void (*get_log_attrs) (GtkTextLayout *layout,
198 PangoLogAttr **attrs,
200 void (*invalidate) (GtkTextLayout *layout,
201 const GtkTextIter *start,
202 const GtkTextIter *end);
203 void (*free_line_data) (GtkTextLayout *layout,
205 GtkTextLineData *line_data);
207 void (*allocate_child) (GtkTextLayout *layout,
212 /* Padding for future expansion */
213 void (*_gtk_reserved1) (void);
214 void (*_gtk_reserved2) (void);
215 void (*_gtk_reserved3) (void);
216 void (*_gtk_reserved4) (void);
219 struct _GtkTextAttrAppearance
222 GtkTextAppearance appearance;
224 struct _GtkTextCursorDisplay
232 struct _GtkTextLineDisplay
236 GSList *shaped_objects; /* Only for backwards compatibility */
238 GtkTextDirection direction;
240 gint width; /* Width of layout */
241 gint total_width; /* width - margins, if no width set on layout, if width set on layout, -1 */
243 /* Amount layout is shifted from left edge - this is the left margin
244 * plus any other factors, such as alignment or indentation.
251 gint insert_index; /* Byte index of insert cursor within para or -1 */
256 GdkColor *pg_bg_color;
259 extern PangoAttrType gtk_text_attr_appearance_type;
261 GType gtk_text_layout_get_type (void) G_GNUC_CONST;
263 GtkTextLayout* gtk_text_layout_new (void);
264 void gtk_text_layout_set_buffer (GtkTextLayout *layout,
265 GtkTextBuffer *buffer);
266 GtkTextBuffer *gtk_text_layout_get_buffer (GtkTextLayout *layout);
267 void gtk_text_layout_set_default_style (GtkTextLayout *layout,
268 GtkTextAttributes *values);
269 void gtk_text_layout_set_contexts (GtkTextLayout *layout,
270 PangoContext *ltr_context,
271 PangoContext *rtl_context);
272 void gtk_text_layout_set_cursor_direction (GtkTextLayout *layout,
273 GtkTextDirection direction);
274 void gtk_text_layout_set_keyboard_direction (GtkTextLayout *layout,
275 GtkTextDirection keyboard_dir);
276 void gtk_text_layout_default_style_changed (GtkTextLayout *layout);
278 void gtk_text_layout_set_screen_width (GtkTextLayout *layout,
280 void gtk_text_layout_set_preedit_string (GtkTextLayout *layout,
281 const gchar *preedit_string,
282 PangoAttrList *preedit_attrs,
285 void gtk_text_layout_set_cursor_visible (GtkTextLayout *layout,
286 gboolean cursor_visible);
287 gboolean gtk_text_layout_get_cursor_visible (GtkTextLayout *layout);
289 /* Getting the size or the lines potentially results in a call to
290 * recompute, which is pretty massively expensive. Thus it should
291 * basically only be done in an idle handler.
293 * Long-term, we would really like to be able to do these without
294 * a full recompute so they may get cheaper over time.
296 void gtk_text_layout_get_size (GtkTextLayout *layout,
299 GSList* gtk_text_layout_get_lines (GtkTextLayout *layout,
300 /* [top_y, bottom_y) */
305 void gtk_text_layout_wrap_loop_start (GtkTextLayout *layout);
306 void gtk_text_layout_wrap_loop_end (GtkTextLayout *layout);
308 GtkTextLineDisplay* gtk_text_layout_get_line_display (GtkTextLayout *layout,
311 void gtk_text_layout_free_line_display (GtkTextLayout *layout,
312 GtkTextLineDisplay *display);
314 void gtk_text_layout_get_line_at_y (GtkTextLayout *layout,
315 GtkTextIter *target_iter,
318 void gtk_text_layout_get_iter_at_pixel (GtkTextLayout *layout,
322 void gtk_text_layout_get_iter_at_position (GtkTextLayout *layout,
327 void gtk_text_layout_invalidate (GtkTextLayout *layout,
328 const GtkTextIter *start,
329 const GtkTextIter *end);
330 void gtk_text_layout_free_line_data (GtkTextLayout *layout,
332 GtkTextLineData *line_data);
334 gboolean gtk_text_layout_is_valid (GtkTextLayout *layout);
335 void gtk_text_layout_validate_yrange (GtkTextLayout *layout,
336 GtkTextIter *anchor_line,
339 void gtk_text_layout_validate (GtkTextLayout *layout,
342 /* This function should return the passed-in line data,
343 * OR remove the existing line data from the line, and
344 * return a NEW line data after adding it to the line.
345 * That is, invariant after calling the callback is that
346 * there should be exactly one line data for this view
347 * stored on the btree line.
349 GtkTextLineData* gtk_text_layout_wrap (GtkTextLayout *layout,
351 GtkTextLineData *line_data); /* may be NULL */
352 void gtk_text_layout_changed (GtkTextLayout *layout,
356 void gtk_text_layout_get_iter_location (GtkTextLayout *layout,
357 const GtkTextIter *iter,
359 void gtk_text_layout_get_line_yrange (GtkTextLayout *layout,
360 const GtkTextIter *iter,
363 void _gtk_text_layout_get_line_xrange (GtkTextLayout *layout,
364 const GtkTextIter *iter,
367 void gtk_text_layout_get_cursor_locations (GtkTextLayout *layout,
369 GdkRectangle *strong_pos,
370 GdkRectangle *weak_pos);
371 gboolean gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout *layout,
376 gboolean gtk_text_layout_move_iter_to_line_end (GtkTextLayout *layout,
379 gboolean gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout,
381 gboolean gtk_text_layout_move_iter_to_next_line (GtkTextLayout *layout,
383 void gtk_text_layout_move_iter_to_x (GtkTextLayout *layout,
386 gboolean gtk_text_layout_move_iter_visually (GtkTextLayout *layout,
390 gboolean gtk_text_layout_iter_starts_line (GtkTextLayout *layout,
391 const GtkTextIter *iter);
393 void gtk_text_layout_get_iter_at_line (GtkTextLayout *layout,
398 /* Don't use these. Use gtk_text_view_add_child_at_anchor().
399 * These functions are defined in gtktextchild.c, but here
400 * since they are semi-public and require GtkTextLayout to
403 void gtk_text_child_anchor_register_child (GtkTextChildAnchor *anchor,
405 GtkTextLayout *layout);
406 void gtk_text_child_anchor_unregister_child (GtkTextChildAnchor *anchor,
409 void gtk_text_child_anchor_queue_resize (GtkTextChildAnchor *anchor,
410 GtkTextLayout *layout);
412 void gtk_text_anchored_child_set_layout (GtkWidget *child,
413 GtkTextLayout *layout);
415 void gtk_text_layout_spew (GtkTextLayout *layout);
419 #endif /* __GTK_TEXT_LAYOUT_H__ */