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

   1 /* GTK - The GIMP Toolkit
   2  * gtktextview.h Copyright (C) 2000 Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library. If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  20  * file for a list of people on the GTK+ Team.  See the ChangeLog
  21  * files for a list of changes.  These files are distributed with
  22  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  23  */
  24
  25 #ifndef __GTK_TEXT_VIEW_H__
  26 #define __GTK_TEXT_VIEW_H__
  27
  28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #include <gtk/gtkcontainer.h>
  33 #include <gtk/gtkimcontext.h>
  34 #include <gtk/gtktextbuffer.h>
  35 #include <gtk/gtkmenu.h>
  36
  37 G_BEGIN_DECLS
  38
  39 #define GTK_TYPE_TEXT_VIEW             (gtk_text_view_get_type ())
  40 #define GTK_TEXT_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TEXT_VIEW, GtkTextView))
  41 #define GTK_TEXT_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
  42 #define GTK_IS_TEXT_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TEXT_VIEW))
  43 #define GTK_IS_TEXT_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT_VIEW))
  44 #define GTK_TEXT_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TEXT_VIEW, GtkTextViewClass))
  45
  46 typedef enum
  47 {
  48   GTK_TEXT_WINDOW_PRIVATE,
  49   GTK_TEXT_WINDOW_WIDGET,
  50   GTK_TEXT_WINDOW_TEXT,
  51   GTK_TEXT_WINDOW_LEFT,
  52   GTK_TEXT_WINDOW_RIGHT,
  53   GTK_TEXT_WINDOW_TOP,
  54   GTK_TEXT_WINDOW_BOTTOM
  55 } GtkTextWindowType;
  56
  57 /**
  58  * GTK_TEXT_VIEW_PRIORITY_VALIDATE:
  59  *
  60  * The priority at which the text view validates onscreen lines
  61  * in an idle job in the background.
  62  */
  63 #define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)
  64
  65 typedef struct _GtkTextView        GtkTextView;
  66 typedef struct _GtkTextViewPrivate GtkTextViewPrivate;
  67 typedef struct _GtkTextViewClass   GtkTextViewClass;
  68
  69 struct _GtkTextView
  70 {
  71   GtkContainer parent_instance;
  72
  73   GtkTextViewPrivate *priv;
  74 };
  75
  76 struct _GtkTextViewClass
  77 {
  78   GtkContainerClass parent_class;
  79
  80   void (* populate_popup)           (GtkTextView    *text_view,
  81                                      GtkWidget      *popup);
  82
  83   /* These are all RUN_ACTION signals for keybindings */
  84
  85   /* move insertion point */
  86   void (* move_cursor) (GtkTextView    *text_view,
  87                         GtkMovementStep step,
  88                         gint            count,
  89                         gboolean        extend_selection);
  90
  91   /* move the "anchor" (what Emacs calls the mark) to the cursor position */
  92   void (* set_anchor)  (GtkTextView    *text_view);
  93
  94   /* Edits */
  95   void (* insert_at_cursor)      (GtkTextView *text_view,
  96                                   const gchar *str);
  97   void (* delete_from_cursor)    (GtkTextView  *text_view,
  98                                   GtkDeleteType type,
  99                                   gint          count);
 100   void (* backspace)             (GtkTextView *text_view);
 101
 102   /* cut copy paste */
 103   void (* cut_clipboard)   (GtkTextView *text_view);
 104   void (* copy_clipboard)  (GtkTextView *text_view);
 105   void (* paste_clipboard) (GtkTextView *text_view);
 106   /* overwrite */
 107   void (* toggle_overwrite) (GtkTextView *text_view);
 108
 109   /* Padding for future expansion */
 110   void (*_gtk_reserved1) (void);
 111   void (*_gtk_reserved2) (void);
 112   void (*_gtk_reserved3) (void);
 113   void (*_gtk_reserved4) (void);
 114   void (*_gtk_reserved5) (void);
 115   void (*_gtk_reserved6) (void);
 116   void (*_gtk_reserved7) (void);
 117   void (*_gtk_reserved8) (void);
 118 };
 119
 120 GType          gtk_text_view_get_type              (void) G_GNUC_CONST;
 121 GtkWidget *    gtk_text_view_new                   (void);
 122 GtkWidget *    gtk_text_view_new_with_buffer       (GtkTextBuffer *buffer);
 123 void           gtk_text_view_set_buffer            (GtkTextView   *text_view,
 124                                                     GtkTextBuffer *buffer);
 125 GtkTextBuffer *gtk_text_view_get_buffer            (GtkTextView   *text_view);
 126 gboolean       gtk_text_view_scroll_to_iter        (GtkTextView   *text_view,
 127                                                     GtkTextIter   *iter,
 128                                                     gdouble        within_margin,
 129                                                     gboolean       use_align,
 130                                                     gdouble        xalign,
 131                                                     gdouble        yalign);
 132 void           gtk_text_view_scroll_to_mark        (GtkTextView   *text_view,
 133                                                     GtkTextMark   *mark,
 134                                                     gdouble        within_margin,
 135                                                     gboolean       use_align,
 136                                                     gdouble        xalign,
 137                                                     gdouble        yalign);
 138 void           gtk_text_view_scroll_mark_onscreen  (GtkTextView   *text_view,
 139                                                     GtkTextMark   *mark);
 140 gboolean       gtk_text_view_move_mark_onscreen    (GtkTextView   *text_view,
 141                                                     GtkTextMark   *mark);
 142 gboolean       gtk_text_view_place_cursor_onscreen (GtkTextView   *text_view);
 143
 144 void           gtk_text_view_get_visible_rect      (GtkTextView   *text_view,
 145                                                     GdkRectangle  *visible_rect);
 146 void           gtk_text_view_set_cursor_visible    (GtkTextView   *text_view,
 147                                                     gboolean       setting);
 148 gboolean       gtk_text_view_get_cursor_visible    (GtkTextView   *text_view);
 149
 150 void           gtk_text_view_get_cursor_locations  (GtkTextView       *text_view,
 151                                                     const GtkTextIter *iter,
 152                                                     GdkRectangle      *strong,
 153                                                     GdkRectangle      *weak);
 154 void           gtk_text_view_get_iter_location     (GtkTextView   *text_view,
 155                                                     const GtkTextIter *iter,
 156                                                     GdkRectangle  *location);
 157 void           gtk_text_view_get_iter_at_location  (GtkTextView   *text_view,
 158                                                     GtkTextIter   *iter,
 159                                                     gint           x,
 160                                                     gint           y);
 161 void           gtk_text_view_get_iter_at_position  (GtkTextView   *text_view,
 162                                                     GtkTextIter   *iter,
 163                                                     gint          *trailing,
 164                                                     gint           x,
 165                                                     gint           y);
 166 void           gtk_text_view_get_line_yrange       (GtkTextView       *text_view,
 167                                                     const GtkTextIter *iter,
 168                                                     gint              *y,
 169                                                     gint              *height);
 170
 171 void           gtk_text_view_get_line_at_y         (GtkTextView       *text_view,
 172                                                     GtkTextIter       *target_iter,
 173                                                     gint               y,
 174                                                     gint              *line_top);
 175
 176 void gtk_text_view_buffer_to_window_coords (GtkTextView       *text_view,
 177                                             GtkTextWindowType  win,
 178                                             gint               buffer_x,
 179                                             gint               buffer_y,
 180                                             gint              *window_x,
 181                                             gint              *window_y);
 182 void gtk_text_view_window_to_buffer_coords (GtkTextView       *text_view,
 183                                             GtkTextWindowType  win,
 184                                             gint               window_x,
 185                                             gint               window_y,
 186                                             gint              *buffer_x,
 187                                             gint              *buffer_y);
 188
 189 GDK_DEPRECATED_IN_3_0_FOR(gtk_scrollable_get_hadjustment)
 190 GtkAdjustment*   gtk_text_view_get_hadjustment (GtkTextView   *text_view);
 191 GDK_DEPRECATED_IN_3_0_FOR(gtk_scrollable_get_vadjustment)
 192 GtkAdjustment*   gtk_text_view_get_vadjustment (GtkTextView   *text_view);
 193
 194 GdkWindow*        gtk_text_view_get_window      (GtkTextView       *text_view,
 195                                                  GtkTextWindowType  win);
 196 GtkTextWindowType gtk_text_view_get_window_type (GtkTextView       *text_view,
 197                                                  GdkWindow         *window);
 198
 199 void gtk_text_view_set_border_window_size (GtkTextView       *text_view,
 200                                            GtkTextWindowType  type,
 201                                            gint               size);
 202 gint gtk_text_view_get_border_window_size (GtkTextView       *text_view,
 203                                            GtkTextWindowType  type);
 204
 205 gboolean gtk_text_view_forward_display_line           (GtkTextView       *text_view,
 206                                                        GtkTextIter       *iter);
 207 gboolean gtk_text_view_backward_display_line          (GtkTextView       *text_view,
 208                                                        GtkTextIter       *iter);
 209 gboolean gtk_text_view_forward_display_line_end       (GtkTextView       *text_view,
 210                                                        GtkTextIter       *iter);
 211 gboolean gtk_text_view_backward_display_line_start    (GtkTextView       *text_view,
 212                                                        GtkTextIter       *iter);
 213 gboolean gtk_text_view_starts_display_line            (GtkTextView       *text_view,
 214                                                        const GtkTextIter *iter);
 215 gboolean gtk_text_view_move_visually                  (GtkTextView       *text_view,
 216                                                        GtkTextIter       *iter,
 217                                                        gint               count);
 218
 219 gboolean        gtk_text_view_im_context_filter_keypress        (GtkTextView       *text_view,
 220                                                                  GdkEventKey       *event);
 221 void            gtk_text_view_reset_im_context                  (GtkTextView       *text_view);
 222
 223 /* Adding child widgets */
 224 void gtk_text_view_add_child_at_anchor (GtkTextView          *text_view,
 225                                         GtkWidget            *child,
 226                                         GtkTextChildAnchor   *anchor);
 227
 228 void gtk_text_view_add_child_in_window (GtkTextView          *text_view,
 229                                         GtkWidget            *child,
 230                                         GtkTextWindowType     which_window,
 231                                         /* window coordinates */
 232                                         gint                  xpos,
 233                                         gint                  ypos);
 234
 235 void gtk_text_view_move_child          (GtkTextView          *text_view,
 236                                         GtkWidget            *child,
 237                                         /* window coordinates */
 238                                         gint                  xpos,
 239                                         gint                  ypos);
 240
 241 /* Default style settings (fallbacks if no tag affects the property) */
 242
 243 void             gtk_text_view_set_wrap_mode          (GtkTextView      *text_view,
 244                                                        GtkWrapMode       wrap_mode);
 245 GtkWrapMode      gtk_text_view_get_wrap_mode          (GtkTextView      *text_view);
 246 void             gtk_text_view_set_editable           (GtkTextView      *text_view,
 247                                                        gboolean          setting);
 248 gboolean         gtk_text_view_get_editable           (GtkTextView      *text_view);
 249 void             gtk_text_view_set_overwrite          (GtkTextView      *text_view,
 250                                                        gboolean          overwrite);
 251 gboolean         gtk_text_view_get_overwrite          (GtkTextView      *text_view);
 252 void             gtk_text_view_set_accepts_tab        (GtkTextView      *text_view,
 253                                                        gboolean          accepts_tab);
 254 gboolean         gtk_text_view_get_accepts_tab        (GtkTextView      *text_view);
 255 void             gtk_text_view_set_pixels_above_lines (GtkTextView      *text_view,
 256                                                        gint              pixels_above_lines);
 257 gint             gtk_text_view_get_pixels_above_lines (GtkTextView      *text_view);
 258 void             gtk_text_view_set_pixels_below_lines (GtkTextView      *text_view,
 259                                                        gint              pixels_below_lines);
 260 gint             gtk_text_view_get_pixels_below_lines (GtkTextView      *text_view);
 261 void             gtk_text_view_set_pixels_inside_wrap (GtkTextView      *text_view,
 262                                                        gint              pixels_inside_wrap);
 263 gint             gtk_text_view_get_pixels_inside_wrap (GtkTextView      *text_view);
 264 void             gtk_text_view_set_justification      (GtkTextView      *text_view,
 265                                                        GtkJustification  justification);
 266 GtkJustification gtk_text_view_get_justification      (GtkTextView      *text_view);
 267 void             gtk_text_view_set_left_margin        (GtkTextView      *text_view,
 268                                                        gint              left_margin);
 269 gint             gtk_text_view_get_left_margin        (GtkTextView      *text_view);
 270 void             gtk_text_view_set_right_margin       (GtkTextView      *text_view,
 271                                                        gint              right_margin);
 272 gint             gtk_text_view_get_right_margin       (GtkTextView      *text_view);
 273 void             gtk_text_view_set_indent             (GtkTextView      *text_view,
 274                                                        gint              indent);
 275 gint             gtk_text_view_get_indent             (GtkTextView      *text_view);
 276 void             gtk_text_view_set_tabs               (GtkTextView      *text_view,
 277                                                        PangoTabArray    *tabs);
 278 PangoTabArray*   gtk_text_view_get_tabs               (GtkTextView      *text_view);
 279
 280 /* note that the return value of this changes with the theme */
 281 GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView    *text_view);
 282
 283 GDK_AVAILABLE_IN_3_6
 284 void             gtk_text_view_set_input_purpose      (GtkTextView      *text_view,
 285                                                        GtkInputPurpose   purpose);
 286 GDK_AVAILABLE_IN_3_6
 287 GtkInputPurpose  gtk_text_view_get_input_purpose      (GtkTextView      *text_view);
 288
 289 GDK_AVAILABLE_IN_3_6
 290 void             gtk_text_view_set_input_hints        (GtkTextView      *text_view,
 291                                                        GtkInputHints     hints);
 292 GDK_AVAILABLE_IN_3_6
 293 GtkInputHints    gtk_text_view_get_input_hints        (GtkTextView      *text_view);
 294
 295
 296 G_END_DECLS
 297
 298 #endif /* __GTK_TEXT_VIEW_H__ */