1 /* GTK - The GIMP Toolkit
2 * gtktextview.h Copyright (C) 2000 Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_TEXT_VIEW_H__
32 #define __GTK_TEXT_VIEW_H__
34 #include <gtk/gtkcontainer.h>
35 #include <gtk/gtkimcontext.h>
36 #include <gtk/gtktextbuffer.h>
37 #include <gtk/gtkmenu.h>
41 #define GTK_TYPE_TEXT_VIEW (gtk_text_view_get_type ())
42 #define GTK_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_VIEW, GtkTextView))
43 #define GTK_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
44 #define GTK_IS_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_VIEW))
45 #define GTK_IS_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_VIEW))
46 #define GTK_TEXT_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
50 GTK_TEXT_WINDOW_PRIVATE,
51 GTK_TEXT_WINDOW_WIDGET,
54 GTK_TEXT_WINDOW_RIGHT,
56 GTK_TEXT_WINDOW_BOTTOM
60 * GTK_TEXT_VIEW_PRIORITY_VALIDATE:
62 * The priority at which the text view validates onscreen lines
63 * in an idle job in the background.
65 #define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)
67 typedef struct _GtkTextView GtkTextView;
68 typedef struct _GtkTextViewPrivate GtkTextViewPrivate;
69 typedef struct _GtkTextViewClass GtkTextViewClass;
73 GtkContainer parent_instance;
75 GtkTextViewPrivate *priv;
78 struct _GtkTextViewClass
80 GtkContainerClass parent_class;
82 void (* populate_popup) (GtkTextView *text_view,
85 /* These are all RUN_ACTION signals for keybindings */
87 /* move insertion point */
88 void (* move_cursor) (GtkTextView *text_view,
91 gboolean extend_selection);
93 /* move the "anchor" (what Emacs calls the mark) to the cursor position */
94 void (* set_anchor) (GtkTextView *text_view);
97 void (* insert_at_cursor) (GtkTextView *text_view,
99 void (* delete_from_cursor) (GtkTextView *text_view,
102 void (* backspace) (GtkTextView *text_view);
105 void (* cut_clipboard) (GtkTextView *text_view);
106 void (* copy_clipboard) (GtkTextView *text_view);
107 void (* paste_clipboard) (GtkTextView *text_view);
109 void (* toggle_overwrite) (GtkTextView *text_view);
111 /* Padding for future expansion */
112 void (*_gtk_reserved1) (void);
113 void (*_gtk_reserved2) (void);
114 void (*_gtk_reserved3) (void);
115 void (*_gtk_reserved4) (void);
116 void (*_gtk_reserved5) (void);
117 void (*_gtk_reserved6) (void);
118 void (*_gtk_reserved7) (void);
119 void (*_gtk_reserved8) (void);
122 GType gtk_text_view_get_type (void) G_GNUC_CONST;
123 GtkWidget * gtk_text_view_new (void);
124 GtkWidget * gtk_text_view_new_with_buffer (GtkTextBuffer *buffer);
125 void gtk_text_view_set_buffer (GtkTextView *text_view,
126 GtkTextBuffer *buffer);
127 GtkTextBuffer *gtk_text_view_get_buffer (GtkTextView *text_view);
128 gboolean gtk_text_view_scroll_to_iter (GtkTextView *text_view,
130 gdouble within_margin,
134 void gtk_text_view_scroll_to_mark (GtkTextView *text_view,
136 gdouble within_margin,
140 void gtk_text_view_scroll_mark_onscreen (GtkTextView *text_view,
142 gboolean gtk_text_view_move_mark_onscreen (GtkTextView *text_view,
144 gboolean gtk_text_view_place_cursor_onscreen (GtkTextView *text_view);
146 void gtk_text_view_get_visible_rect (GtkTextView *text_view,
147 GdkRectangle *visible_rect);
148 void gtk_text_view_set_cursor_visible (GtkTextView *text_view,
150 gboolean gtk_text_view_get_cursor_visible (GtkTextView *text_view);
152 void gtk_text_view_get_cursor_locations (GtkTextView *text_view,
153 const GtkTextIter *iter,
154 GdkRectangle *strong,
156 void gtk_text_view_get_iter_location (GtkTextView *text_view,
157 const GtkTextIter *iter,
158 GdkRectangle *location);
159 void gtk_text_view_get_iter_at_location (GtkTextView *text_view,
163 void gtk_text_view_get_iter_at_position (GtkTextView *text_view,
168 void gtk_text_view_get_line_yrange (GtkTextView *text_view,
169 const GtkTextIter *iter,
173 void gtk_text_view_get_line_at_y (GtkTextView *text_view,
174 GtkTextIter *target_iter,
178 void gtk_text_view_buffer_to_window_coords (GtkTextView *text_view,
179 GtkTextWindowType win,
184 void gtk_text_view_window_to_buffer_coords (GtkTextView *text_view,
185 GtkTextWindowType win,
191 #ifndef GTK_DISABLE_DEPRECATED
192 GtkAdjustment* gtk_text_view_get_hadjustment (GtkTextView *text_view);
193 GtkAdjustment* gtk_text_view_get_vadjustment (GtkTextView *text_view);
196 GdkWindow* gtk_text_view_get_window (GtkTextView *text_view,
197 GtkTextWindowType win);
198 GtkTextWindowType gtk_text_view_get_window_type (GtkTextView *text_view,
201 void gtk_text_view_set_border_window_size (GtkTextView *text_view,
202 GtkTextWindowType type,
204 gint gtk_text_view_get_border_window_size (GtkTextView *text_view,
205 GtkTextWindowType type);
207 gboolean gtk_text_view_forward_display_line (GtkTextView *text_view,
209 gboolean gtk_text_view_backward_display_line (GtkTextView *text_view,
211 gboolean gtk_text_view_forward_display_line_end (GtkTextView *text_view,
213 gboolean gtk_text_view_backward_display_line_start (GtkTextView *text_view,
215 gboolean gtk_text_view_starts_display_line (GtkTextView *text_view,
216 const GtkTextIter *iter);
217 gboolean gtk_text_view_move_visually (GtkTextView *text_view,
221 gboolean gtk_text_view_im_context_filter_keypress (GtkTextView *text_view,
223 void gtk_text_view_reset_im_context (GtkTextView *text_view);
225 /* Adding child widgets */
226 void gtk_text_view_add_child_at_anchor (GtkTextView *text_view,
228 GtkTextChildAnchor *anchor);
230 void gtk_text_view_add_child_in_window (GtkTextView *text_view,
232 GtkTextWindowType which_window,
233 /* window coordinates */
237 void gtk_text_view_move_child (GtkTextView *text_view,
239 /* window coordinates */
243 /* Default style settings (fallbacks if no tag affects the property) */
245 void gtk_text_view_set_wrap_mode (GtkTextView *text_view,
246 GtkWrapMode wrap_mode);
247 GtkWrapMode gtk_text_view_get_wrap_mode (GtkTextView *text_view);
248 void gtk_text_view_set_editable (GtkTextView *text_view,
250 gboolean gtk_text_view_get_editable (GtkTextView *text_view);
251 void gtk_text_view_set_overwrite (GtkTextView *text_view,
253 gboolean gtk_text_view_get_overwrite (GtkTextView *text_view);
254 void gtk_text_view_set_accepts_tab (GtkTextView *text_view,
255 gboolean accepts_tab);
256 gboolean gtk_text_view_get_accepts_tab (GtkTextView *text_view);
257 void gtk_text_view_set_pixels_above_lines (GtkTextView *text_view,
258 gint pixels_above_lines);
259 gint gtk_text_view_get_pixels_above_lines (GtkTextView *text_view);
260 void gtk_text_view_set_pixels_below_lines (GtkTextView *text_view,
261 gint pixels_below_lines);
262 gint gtk_text_view_get_pixels_below_lines (GtkTextView *text_view);
263 void gtk_text_view_set_pixels_inside_wrap (GtkTextView *text_view,
264 gint pixels_inside_wrap);
265 gint gtk_text_view_get_pixels_inside_wrap (GtkTextView *text_view);
266 void gtk_text_view_set_justification (GtkTextView *text_view,
267 GtkJustification justification);
268 GtkJustification gtk_text_view_get_justification (GtkTextView *text_view);
269 void gtk_text_view_set_left_margin (GtkTextView *text_view,
271 gint gtk_text_view_get_left_margin (GtkTextView *text_view);
272 void gtk_text_view_set_right_margin (GtkTextView *text_view,
274 gint gtk_text_view_get_right_margin (GtkTextView *text_view);
275 void gtk_text_view_set_indent (GtkTextView *text_view,
277 gint gtk_text_view_get_indent (GtkTextView *text_view);
278 void gtk_text_view_set_tabs (GtkTextView *text_view,
279 PangoTabArray *tabs);
280 PangoTabArray* gtk_text_view_get_tabs (GtkTextView *text_view);
282 /* note that the return value of this changes with the theme */
283 GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView *text_view);
287 #endif /* __GTK_TEXT_VIEW_H__ */