gtktextview.h 17.7 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2 3 4 5 6 7 8 9 10
 * gtktextview.h Copyright (C) 2000 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 13 14 15 16 17 18 19 20 21 22 23
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

31 32
#ifndef __GTK_TEXT_VIEW_H__
#define __GTK_TEXT_VIEW_H__
33 34 35 36

#include <gtk/gtkcontainer.h>
#include <gtk/gtkimcontext.h>
#include <gtk/gtktextbuffer.h>
Owen Taylor's avatar
Owen Taylor committed
37
#include <gtk/gtkmenu.h>
38

39
G_BEGIN_DECLS
40

41
#define GTK_TYPE_TEXT_VIEW             (gtk_text_view_get_type ())
Manish Singh's avatar
Manish Singh committed
42 43 44 45 46
#define GTK_TEXT_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_VIEW, GtkTextView))
#define GTK_TEXT_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
#define GTK_IS_TEXT_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_VIEW))
#define GTK_IS_TEXT_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_VIEW))
#define GTK_TEXT_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
47

48 49
typedef enum
{
50
  GTK_TEXT_WINDOW_PRIVATE,
51 52 53 54 55 56 57 58
  GTK_TEXT_WINDOW_WIDGET,
  GTK_TEXT_WINDOW_TEXT,
  GTK_TEXT_WINDOW_LEFT,
  GTK_TEXT_WINDOW_RIGHT,
  GTK_TEXT_WINDOW_TOP,
  GTK_TEXT_WINDOW_BOTTOM
} GtkTextWindowType;

Havoc Pennington's avatar
Havoc Pennington committed
59 60
#define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)

61 62 63
typedef struct _GtkTextView GtkTextView;
typedef struct _GtkTextViewClass GtkTextViewClass;

64
/* Internal private types. */
65
typedef struct _GtkTextWindow GtkTextWindow;
66
typedef struct _GtkTextPendingScroll GtkTextPendingScroll;
67

68 69
struct _GtkTextView
{
70 71
  GtkContainer parent_instance;

Tim Janik's avatar
Tim Janik committed
72 73
  struct _GtkTextLayout *GSEAL (layout);
  GtkTextBuffer *GSEAL (buffer);
74

Tim Janik's avatar
Tim Janik committed
75 76
  guint GSEAL (selection_drag_handler);
  guint GSEAL (scroll_timeout);
77

78
  /* Default style settings */
Tim Janik's avatar
Tim Janik committed
79 80 81 82 83 84 85 86 87
  gint GSEAL (pixels_above_lines);
  gint GSEAL (pixels_below_lines);
  gint GSEAL (pixels_inside_wrap);
  GtkWrapMode GSEAL (wrap_mode);
  GtkJustification GSEAL (justify);
  gint GSEAL (left_margin);
  gint GSEAL (right_margin);
  gint GSEAL (indent);
  PangoTabArray *GSEAL (tabs);
88
  guint GSEAL (editable) : 1;
89

90 91
  guint GSEAL (overwrite_mode) : 1;
  guint GSEAL (cursor_visible) : 1;
92

Tim Janik's avatar
Tim Janik committed
93
  /* if we have reset the IM since the last character entered */  
94
  guint GSEAL (need_im_reset) : 1;
95

96
  guint GSEAL (accepts_tab) : 1;
97

98
  guint GSEAL (width_changed) : 1;
99

100 101 102
  /* debug flag - means that we've validated onscreen since the
   * last "invalidate" signal from the layout
   */
103
  guint GSEAL (onscreen_validated) : 1;
Anders Carlsson's avatar
Anders Carlsson committed
104

105
  guint GSEAL (mouse_cursor_obscured) : 1;
106

Tim Janik's avatar
Tim Janik committed
107 108 109 110 111
  GtkTextWindow *GSEAL (text_window);
  GtkTextWindow *GSEAL (left_window);
  GtkTextWindow *GSEAL (right_window);
  GtkTextWindow *GSEAL (top_window);
  GtkTextWindow *GSEAL (bottom_window);
112

Tim Janik's avatar
Tim Janik committed
113 114
  GtkAdjustment *GSEAL (hadjustment);
  GtkAdjustment *GSEAL (vadjustment);
115

Tim Janik's avatar
Tim Janik committed
116 117 118 119
  gint GSEAL (xoffset);         /* Offsets between widget coordinates and buffer coordinates */
  gint GSEAL (yoffset);
  gint GSEAL (width);           /* Width and height of the buffer */
  gint GSEAL (height);
120

121 122 123 124 125 126 127 128 129
  /* The virtual cursor position is normally the same as the
   * actual (strong) cursor position, except in two circumstances:
   *
   * a) When the cursor is moved vertically with the keyboard
   * b) When the text view is scrolled with the keyboard
   *
   * In case a), virtual_cursor_x is preserved, but not virtual_cursor_y
   * In case b), both virtual_cursor_x and virtual_cursor_y are preserved.
   */
Tim Janik's avatar
Tim Janik committed
130 131
  gint GSEAL (virtual_cursor_x);   /* -1 means use actual cursor position */
  gint GSEAL (virtual_cursor_y);   /* -1 means use actual cursor position */
132

Tim Janik's avatar
Tim Janik committed
133 134
  GtkTextMark *GSEAL (first_para_mark); /* Mark at the beginning of the first onscreen paragraph */
  gint GSEAL (first_para_pixels);       /* Offset of top of screen in the first onscreen paragraph */
135

Tim Janik's avatar
Tim Janik committed
136 137
  GtkTextMark *GSEAL (dnd_mark);
  guint GSEAL (blink_timeout);
138

Tim Janik's avatar
Tim Janik committed
139 140
  guint GSEAL (first_validate_idle);        /* Idle to revalidate onscreen portion, runs before resize */
  guint GSEAL (incremental_validate_idle);  /* Idle to revalidate offscreen portions, runs after redraw */
141

Tim Janik's avatar
Tim Janik committed
142 143
  GtkIMContext *GSEAL (im_context);
  GtkWidget *GSEAL (popup_menu);
Havoc Pennington's avatar
Havoc Pennington committed
144

Tim Janik's avatar
Tim Janik committed
145 146
  gint GSEAL (drag_start_x);
  gint GSEAL (drag_start_y);
147

Tim Janik's avatar
Tim Janik committed
148
  GSList *GSEAL (children);
149

Tim Janik's avatar
Tim Janik committed
150
  GtkTextPendingScroll *GSEAL (pending_scroll);
Havoc Pennington's avatar
Havoc Pennington committed
151

Tim Janik's avatar
Tim Janik committed
152
  gint GSEAL (pending_place_cursor_button);
153 154
};

155 156
struct _GtkTextViewClass
{
157 158
  GtkContainerClass parent_class;

Owen Taylor's avatar
Owen Taylor committed
159 160 161 162 163 164
  void (* set_scroll_adjustments)   (GtkTextView    *text_view,
                                     GtkAdjustment  *hadjustment,
                                     GtkAdjustment  *vadjustment);

  void (* populate_popup)           (GtkTextView    *text_view,
                                     GtkMenu        *menu);
165

166 167 168
  /* These are all RUN_ACTION signals for keybindings */

  /* move insertion point */
169 170 171 172
  void (* move_cursor) (GtkTextView    *text_view,
                        GtkMovementStep step,
                        gint            count,
                        gboolean        extend_selection);
173 174 175 176 177 178 179 180

  /* FIXME should be deprecated in favor of adding GTK_MOVEMENT_HORIZONTAL_PAGES
   * or something in GTK 2.2, was put in to avoid adding enum values during
   * the freeze.
   */
  void (* page_horizontally) (GtkTextView *text_view,
                              gint         count,
                              gboolean     extend_selection);
181

182
  /* move the "anchor" (what Emacs calls the mark) to the cursor position */
183
  void (* set_anchor)  (GtkTextView    *text_view);
184 185

  /* Edits */
186 187 188 189 190
  void (* insert_at_cursor)      (GtkTextView *text_view,
                                  const gchar *str);
  void (* delete_from_cursor)    (GtkTextView  *text_view,
                                  GtkDeleteType type,
                                  gint          count);
191
  void (* backspace)             (GtkTextView *text_view);
192

193
  /* cut copy paste */
194 195 196
  void (* cut_clipboard)   (GtkTextView *text_view);
  void (* copy_clipboard)  (GtkTextView *text_view);
  void (* paste_clipboard) (GtkTextView *text_view);
197 198
  /* overwrite */
  void (* toggle_overwrite) (GtkTextView *text_view);
199

200 201 202 203
  /* as of GTK+ 2.12 the "move-focus" signal has been moved to GtkWidget,
   * so this is merley a virtual function now. Overriding it in subclasses
   * continues to work though.
   */
204
  void (* move_focus)       (GtkTextView     *text_view,
205 206
                             GtkDirectionType direction);

207 208 209 210 211 212 213 214
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
  void (*_gtk_reserved4) (void);
  void (*_gtk_reserved5) (void);
  void (*_gtk_reserved6) (void);
  void (*_gtk_reserved7) (void);
215 216
};

Manish Singh's avatar
Manish Singh committed
217
GType          gtk_text_view_get_type              (void) G_GNUC_CONST;
218 219 220
GtkWidget *    gtk_text_view_new                   (void);
GtkWidget *    gtk_text_view_new_with_buffer       (GtkTextBuffer *buffer);
void           gtk_text_view_set_buffer            (GtkTextView   *text_view,
221
                                                    GtkTextBuffer *buffer);
222
GtkTextBuffer *gtk_text_view_get_buffer            (GtkTextView   *text_view);
223 224 225 226 227 228 229
gboolean       gtk_text_view_scroll_to_iter        (GtkTextView   *text_view,
                                                    GtkTextIter   *iter,
                                                    gdouble        within_margin,
                                                    gboolean       use_align,
                                                    gdouble        xalign,
                                                    gdouble        yalign);
void           gtk_text_view_scroll_to_mark        (GtkTextView   *text_view,
230
                                                    GtkTextMark   *mark,
231 232 233 234
                                                    gdouble        within_margin,
                                                    gboolean       use_align,
                                                    gdouble        xalign,
                                                    gdouble        yalign);
235
void           gtk_text_view_scroll_mark_onscreen  (GtkTextView   *text_view,
236
                                                    GtkTextMark   *mark);
237
gboolean       gtk_text_view_move_mark_onscreen    (GtkTextView   *text_view,
238
                                                    GtkTextMark   *mark);
239 240 241
gboolean       gtk_text_view_place_cursor_onscreen (GtkTextView   *text_view);

void           gtk_text_view_get_visible_rect      (GtkTextView   *text_view,
242
                                                    GdkRectangle  *visible_rect);
243 244 245 246 247 248 249
void           gtk_text_view_set_cursor_visible    (GtkTextView   *text_view,
                                                    gboolean       setting);
gboolean       gtk_text_view_get_cursor_visible    (GtkTextView   *text_view);

void           gtk_text_view_get_iter_location     (GtkTextView   *text_view,
                                                    const GtkTextIter *iter,
                                                    GdkRectangle  *location);
250
void           gtk_text_view_get_iter_at_location  (GtkTextView   *text_view,
251 252 253
                                                    GtkTextIter   *iter,
                                                    gint           x,
                                                    gint           y);
254 255 256 257 258
void           gtk_text_view_get_iter_at_position  (GtkTextView   *text_view,
                                                    GtkTextIter   *iter,
						    gint          *trailing,
                                                    gint           x,
                                                    gint           y);
Havoc Pennington's avatar
Havoc Pennington committed
259 260 261 262
void           gtk_text_view_get_line_yrange       (GtkTextView       *text_view,
                                                    const GtkTextIter *iter,
                                                    gint              *y,
                                                    gint              *height);
263

Havoc Pennington's avatar
Havoc Pennington committed
264 265 266 267
void           gtk_text_view_get_line_at_y         (GtkTextView       *text_view,
                                                    GtkTextIter       *target_iter,
                                                    gint               y,
                                                    gint              *line_top);
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286

void gtk_text_view_buffer_to_window_coords (GtkTextView       *text_view,
                                            GtkTextWindowType  win,
                                            gint               buffer_x,
                                            gint               buffer_y,
                                            gint              *window_x,
                                            gint              *window_y);
void gtk_text_view_window_to_buffer_coords (GtkTextView       *text_view,
                                            GtkTextWindowType  win,
                                            gint               window_x,
                                            gint               window_y,
                                            gint              *buffer_x,
                                            gint              *buffer_y);

GdkWindow*        gtk_text_view_get_window      (GtkTextView       *text_view,
                                                 GtkTextWindowType  win);
GtkTextWindowType gtk_text_view_get_window_type (GtkTextView       *text_view,
                                                 GdkWindow         *window);

Havoc Pennington's avatar
Havoc Pennington committed
287 288 289
void gtk_text_view_set_border_window_size (GtkTextView       *text_view,
                                           GtkTextWindowType  type,
                                           gint               size);
290 291
gint gtk_text_view_get_border_window_size (GtkTextView       *text_view,
					   GtkTextWindowType  type);
Havoc Pennington's avatar
Havoc Pennington committed
292

293 294 295 296 297 298 299 300 301 302 303 304 305
gboolean gtk_text_view_forward_display_line           (GtkTextView       *text_view,
                                                       GtkTextIter       *iter);
gboolean gtk_text_view_backward_display_line          (GtkTextView       *text_view,
                                                       GtkTextIter       *iter);
gboolean gtk_text_view_forward_display_line_end       (GtkTextView       *text_view,
                                                       GtkTextIter       *iter);
gboolean gtk_text_view_backward_display_line_start    (GtkTextView       *text_view,
                                                       GtkTextIter       *iter);
gboolean gtk_text_view_starts_display_line            (GtkTextView       *text_view,
                                                       const GtkTextIter *iter);
gboolean gtk_text_view_move_visually                  (GtkTextView       *text_view,
                                                       GtkTextIter       *iter,
                                                       gint               count);
306

307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
/* Adding child widgets */
void gtk_text_view_add_child_at_anchor (GtkTextView          *text_view,
                                        GtkWidget            *child,
                                        GtkTextChildAnchor   *anchor);

void gtk_text_view_add_child_in_window (GtkTextView          *text_view,
                                        GtkWidget            *child,
                                        GtkTextWindowType     which_window,
                                        /* window coordinates */
                                        gint                  xpos,
                                        gint                  ypos);

void gtk_text_view_move_child          (GtkTextView          *text_view,
                                        GtkWidget            *child,
                                        /* window coordinates */
                                        gint                  xpos,
                                        gint                  ypos);

325 326 327 328 329 330 331 332
/* Default style settings (fallbacks if no tag affects the property) */

void             gtk_text_view_set_wrap_mode          (GtkTextView      *text_view,
                                                       GtkWrapMode       wrap_mode);
GtkWrapMode      gtk_text_view_get_wrap_mode          (GtkTextView      *text_view);
void             gtk_text_view_set_editable           (GtkTextView      *text_view,
                                                       gboolean          setting);
gboolean         gtk_text_view_get_editable           (GtkTextView      *text_view);
333 334 335
void             gtk_text_view_set_overwrite          (GtkTextView      *text_view,
						       gboolean          overwrite);
gboolean         gtk_text_view_get_overwrite          (GtkTextView      *text_view);
336 337 338
void		 gtk_text_view_set_accepts_tab        (GtkTextView	*text_view,
						       gboolean		 accepts_tab);
gboolean	 gtk_text_view_get_accepts_tab        (GtkTextView	*text_view);
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
void             gtk_text_view_set_pixels_above_lines (GtkTextView      *text_view,
                                                       gint              pixels_above_lines);
gint             gtk_text_view_get_pixels_above_lines (GtkTextView      *text_view);
void             gtk_text_view_set_pixels_below_lines (GtkTextView      *text_view,
                                                       gint              pixels_below_lines);
gint             gtk_text_view_get_pixels_below_lines (GtkTextView      *text_view);
void             gtk_text_view_set_pixels_inside_wrap (GtkTextView      *text_view,
                                                       gint              pixels_inside_wrap);
gint             gtk_text_view_get_pixels_inside_wrap (GtkTextView      *text_view);
void             gtk_text_view_set_justification      (GtkTextView      *text_view,
                                                       GtkJustification  justification);
GtkJustification gtk_text_view_get_justification      (GtkTextView      *text_view);
void             gtk_text_view_set_left_margin        (GtkTextView      *text_view,
                                                       gint              left_margin);
gint             gtk_text_view_get_left_margin        (GtkTextView      *text_view);
void             gtk_text_view_set_right_margin       (GtkTextView      *text_view,
                                                       gint              right_margin);
gint             gtk_text_view_get_right_margin       (GtkTextView      *text_view);
void             gtk_text_view_set_indent             (GtkTextView      *text_view,
                                                       gint              indent);
gint             gtk_text_view_get_indent             (GtkTextView      *text_view);
void             gtk_text_view_set_tabs               (GtkTextView      *text_view,
                                                       PangoTabArray    *tabs);
PangoTabArray*   gtk_text_view_get_tabs               (GtkTextView      *text_view);

Havoc Pennington's avatar
Havoc Pennington committed
364 365
/* note that the return value of this changes with the theme */
GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView    *text_view);
366

367
G_END_DECLS
368

369
#endif /* __GTK_TEXT_VIEW_H__ */