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
84 #endif /* __cplusplus */
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
93 #include <gtk/gtktextbuffer.h>
94 #include <gtk/gtktextiter.h>
96 /* forward declarations that have to be here to avoid including
99 typedef struct _GtkTextLine GtkTextLine;
100 typedef struct _GtkTextLineData GtkTextLineData;
102 #define GTK_TYPE_TEXT_LAYOUT (gtk_text_layout_get_type())
103 #define GTK_TEXT_LAYOUT(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayout))
104 #define GTK_TEXT_LAYOUT_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
105 #define GTK_IS_TEXT_LAYOUT(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TEXT_LAYOUT))
106 #define GTK_IS_TEXT_LAYOUT_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_LAYOUT))
107 #define GTK_TEXT_LAYOUT_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TEXT_LAYOUT, GtkTextLayoutClass))
109 typedef struct _GtkTextLayout GtkTextLayout;
110 typedef struct _GtkTextLayoutClass GtkTextLayoutClass;
111 typedef struct _GtkTextLineDisplay GtkTextLineDisplay;
112 typedef struct _GtkTextCursorDisplay GtkTextCursorDisplay;
113 typedef struct _GtkTextAttrAppearance GtkTextAttrAppearance;
115 struct _GtkTextLayout
117 GtkObject parent_instance;
119 /* width of the display area on-screen,
120 * i.e. pixels we should wrap to fit inside. */
123 /* width/height of the total logical area being layed out */
127 /* Pixel offsets from the left and from the top to be used when we
128 * draw; these allow us to create left/top margins. We don't need
129 * anything special for bottom/right margins, because those don't
132 /* gint left_edge; */
135 GtkTextBuffer *buffer;
137 /* Default style used if no tags override it */
138 GtkTextAttributes *default_style;
140 /* Pango contexts used for creating layouts */
141 PangoContext *ltr_context;
142 PangoContext *rtl_context;
144 /* A cache of one style; this is used to ensure
145 * we don't constantly regenerate the style
146 * over long runs with the same style. */
147 GtkTextAttributes *one_style_cache;
149 /* A cache of one line display. Getting the same line
150 * many times in a row is the most common case.
152 GtkTextLineDisplay *one_display_cache;
154 /* Whether we are allowed to wrap right now */
155 gint wrap_loop_count;
157 /* Whether to show the insertion cursor */
158 guint cursor_visible : 1;
161 struct _GtkTextLayoutClass
163 GtkObjectClass parent_class;
165 /* Some portion of the layout was invalidated
167 void (*invalidated) (GtkTextLayout *layout);
169 /* A range of the layout changed appearance and possibly height
171 void (*changed) (GtkTextLayout *layout,
175 GtkTextLineData* (*wrap) (GtkTextLayout *layout,
177 GtkTextLineData *line_data); /* may be NULL */
178 void (*get_log_attrs) (GtkTextLayout *layout,
180 PangoLogAttr **attrs,
182 void (*invalidate) (GtkTextLayout *layout,
183 const GtkTextIter *start,
184 const GtkTextIter *end);
185 void (*free_line_data) (GtkTextLayout *layout,
187 GtkTextLineData *line_data);
189 struct _GtkTextAttrAppearance
192 GtkTextAppearance appearance;
194 struct _GtkTextCursorDisplay
202 struct _GtkTextLineDisplay
208 GtkTextDirection direction;
210 gint width; /* Width of layout */
211 gint total_width; /* width - margins, if no width set on layout, if width set on layout, -1 */
213 gint x_offset; /* Amount layout is shifted from left edge */
223 extern PangoAttrType gtk_text_attr_appearance_type;
225 GtkType gtk_text_layout_get_type (void) G_GNUC_CONST;
226 GtkTextLayout* gtk_text_layout_new (void);
227 void gtk_text_layout_set_buffer (GtkTextLayout *layout,
228 GtkTextBuffer *buffer);
229 void gtk_text_layout_set_default_style (GtkTextLayout *layout,
230 GtkTextAttributes *values);
231 void gtk_text_layout_set_contexts (GtkTextLayout *layout,
232 PangoContext *ltr_context,
233 PangoContext *rtl_context);
234 void gtk_text_layout_default_style_changed (GtkTextLayout *layout);
235 void gtk_text_layout_set_screen_width (GtkTextLayout *layout,
237 void gtk_text_layout_set_cursor_visible (GtkTextLayout *layout,
238 gboolean cursor_visible);
239 gboolean gtk_text_layout_get_cursor_visible (GtkTextLayout *layout);
241 /* Getting the size or the lines potentially results in a call to
242 * recompute, which is pretty massively expensive. Thus it should
243 * basically only be done in an idle handler.
245 * Long-term, we would really like to be able to do these without
246 * a full recompute so they may get cheaper over time.
248 void gtk_text_layout_get_size (GtkTextLayout *layout,
251 GSList* gtk_text_layout_get_lines (GtkTextLayout *layout,
252 /* [top_y, bottom_y) */
257 void gtk_text_layout_wrap_loop_start (GtkTextLayout *layout);
258 void gtk_text_layout_wrap_loop_end (GtkTextLayout *layout);
260 GtkTextLineDisplay* gtk_text_layout_get_line_display (GtkTextLayout *layout,
263 void gtk_text_layout_free_line_display (GtkTextLayout *layout,
264 GtkTextLineDisplay *display);
266 void gtk_text_layout_get_line_at_y (GtkTextLayout *layout,
267 GtkTextIter *target_iter,
270 void gtk_text_layout_get_iter_at_pixel (GtkTextLayout *layout,
274 void gtk_text_layout_invalidate (GtkTextLayout *layout,
275 const GtkTextIter *start,
276 const GtkTextIter *end);
277 void gtk_text_layout_free_line_data (GtkTextLayout *layout,
279 GtkTextLineData *line_data);
281 gboolean gtk_text_layout_is_valid (GtkTextLayout *layout);
282 void gtk_text_layout_validate_yrange (GtkTextLayout *layout,
283 GtkTextIter *anchor_line,
286 void gtk_text_layout_validate (GtkTextLayout *layout,
289 /* This function should return the passed-in line data,
290 * OR remove the existing line data from the line, and
291 * return a NEW line data after adding it to the line.
292 * That is, invariant after calling the callback is that
293 * there should be exactly one line data for this view
294 * stored on the btree line.
296 GtkTextLineData* gtk_text_layout_wrap (GtkTextLayout *layout,
298 GtkTextLineData *line_data); /* may be NULL */
299 void gtk_text_layout_get_log_attrs (GtkTextLayout *layout,
301 PangoLogAttr **attrs,
303 void gtk_text_layout_changed (GtkTextLayout *layout,
307 void gtk_text_layout_get_iter_location (GtkTextLayout *layout,
308 const GtkTextIter *iter,
310 void gtk_text_layout_get_line_yrange (GtkTextLayout *layout,
311 const GtkTextIter *iter,
314 void gtk_text_layout_get_cursor_locations (GtkTextLayout *layout,
316 GdkRectangle *strong_pos,
317 GdkRectangle *weak_pos);
318 gboolean gtk_text_layout_clamp_iter_to_vrange (GtkTextLayout *layout,
323 void gtk_text_layout_move_iter_to_line_end (GtkTextLayout *layout,
326 void gtk_text_layout_move_iter_to_previous_line (GtkTextLayout *layout,
328 void gtk_text_layout_move_iter_to_next_line (GtkTextLayout *layout,
330 void gtk_text_layout_move_iter_to_x (GtkTextLayout *layout,
333 void gtk_text_layout_move_iter_visually (GtkTextLayout *layout,
337 void gtk_text_layout_spew (GtkTextLayout *layout);
343 #endif /* __cplusplus */
345 #endif /* GTK_TEXT_LAYOUT_H */