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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  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/.
  25  */
  26
  27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_TEXT_VIEW_H__
  32 #define __GTK_TEXT_VIEW_H__
  33
  34 #include <gtk/gtkcontainer.h>
  35 #include <gtk/gtkimcontext.h>
  36 #include <gtk/gtktextbuffer.h>
  37 #include <gtk/gtkmenu.h>
  38
  39 G_BEGIN_DECLS
  40
  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))
  47
  48 typedef enum
  49 {
  50   GTK_TEXT_WINDOW_PRIVATE,
  51   GTK_TEXT_WINDOW_WIDGET,
  52   GTK_TEXT_WINDOW_TEXT,
  53   GTK_TEXT_WINDOW_LEFT,
  54   GTK_TEXT_WINDOW_RIGHT,
  55   GTK_TEXT_WINDOW_TOP,
  56   GTK_TEXT_WINDOW_BOTTOM
  57 } GtkTextWindowType;
  58
  59 #define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)
  60
  61 typedef struct _GtkTextView        GtkTextView;
  62 typedef struct _GtkTextViewPrivate GtkTextViewPrivate;
  63 typedef struct _GtkTextViewClass   GtkTextViewClass;
  64
  65 struct _GtkTextView
  66 {
  67   GtkContainer parent_instance;
  68
  69   GtkTextViewPrivate *priv;
  70 };
  71
  72 struct _GtkTextViewClass
  73 {
  74   GtkContainerClass parent_class;
  75
  76   void (* populate_popup)           (GtkTextView    *text_view,
  77                                      GtkMenu        *menu);
  78
  79   /* These are all RUN_ACTION signals for keybindings */
  80
  81   /* move insertion point */
  82   void (* move_cursor) (GtkTextView    *text_view,
  83                         GtkMovementStep step,
  84                         gint            count,
  85                         gboolean        extend_selection);
  86
  87   /* move the "anchor" (what Emacs calls the mark) to the cursor position */
  88   void (* set_anchor)  (GtkTextView    *text_view);
  89
  90   /* Edits */
  91   void (* insert_at_cursor)      (GtkTextView *text_view,
  92                                   const gchar *str);
  93   void (* delete_from_cursor)    (GtkTextView  *text_view,
  94                                   GtkDeleteType type,
  95                                   gint          count);
  96   void (* backspace)             (GtkTextView *text_view);
  97
  98   /* cut copy paste */
  99   void (* cut_clipboard)   (GtkTextView *text_view);
 100   void (* copy_clipboard)  (GtkTextView *text_view);
 101   void (* paste_clipboard) (GtkTextView *text_view);
 102   /* overwrite */
 103   void (* toggle_overwrite) (GtkTextView *text_view);
 104
 105   /* Padding for future expansion */
 106   void (*_gtk_reserved1) (void);
 107   void (*_gtk_reserved2) (void);
 108   void (*_gtk_reserved3) (void);
 109   void (*_gtk_reserved4) (void);
 110   void (*_gtk_reserved5) (void);
 111   void (*_gtk_reserved6) (void);
 112   void (*_gtk_reserved7) (void);
 113   void (*_gtk_reserved8) (void);
 114 };
 115
 116 GType          gtk_text_view_get_type              (void) G_GNUC_CONST;
 117 GtkWidget *    gtk_text_view_new                   (void);
 118 GtkWidget *    gtk_text_view_new_with_buffer       (GtkTextBuffer *buffer);
 119 void           gtk_text_view_set_buffer            (GtkTextView   *text_view,
 120                                                     GtkTextBuffer *buffer);
 121 GtkTextBuffer *gtk_text_view_get_buffer            (GtkTextView   *text_view);
 122 gboolean       gtk_text_view_scroll_to_iter        (GtkTextView   *text_view,
 123                                                     GtkTextIter   *iter,
 124                                                     gdouble        within_margin,
 125                                                     gboolean       use_align,
 126                                                     gdouble        xalign,
 127                                                     gdouble        yalign);
 128 void           gtk_text_view_scroll_to_mark        (GtkTextView   *text_view,
 129                                                     GtkTextMark   *mark,
 130                                                     gdouble        within_margin,
 131                                                     gboolean       use_align,
 132                                                     gdouble        xalign,
 133                                                     gdouble        yalign);
 134 void           gtk_text_view_scroll_mark_onscreen  (GtkTextView   *text_view,
 135                                                     GtkTextMark   *mark);
 136 gboolean       gtk_text_view_move_mark_onscreen    (GtkTextView   *text_view,
 137                                                     GtkTextMark   *mark);
 138 gboolean       gtk_text_view_place_cursor_onscreen (GtkTextView   *text_view);
 139
 140 void           gtk_text_view_get_visible_rect      (GtkTextView   *text_view,
 141                                                     GdkRectangle  *visible_rect);
 142 void           gtk_text_view_set_cursor_visible    (GtkTextView   *text_view,
 143                                                     gboolean       setting);
 144 gboolean       gtk_text_view_get_cursor_visible    (GtkTextView   *text_view);
 145
 146 void           gtk_text_view_get_iter_location     (GtkTextView   *text_view,
 147                                                     const GtkTextIter *iter,
 148                                                     GdkRectangle  *location);
 149 void           gtk_text_view_get_iter_at_location  (GtkTextView   *text_view,
 150                                                     GtkTextIter   *iter,
 151                                                     gint           x,
 152                                                     gint           y);
 153 void           gtk_text_view_get_iter_at_position  (GtkTextView   *text_view,
 154                                                     GtkTextIter   *iter,
 155                                                     gint          *trailing,
 156                                                     gint           x,
 157                                                     gint           y);
 158 void           gtk_text_view_get_line_yrange       (GtkTextView       *text_view,
 159                                                     const GtkTextIter *iter,
 160                                                     gint              *y,
 161                                                     gint              *height);
 162
 163 void           gtk_text_view_get_line_at_y         (GtkTextView       *text_view,
 164                                                     GtkTextIter       *target_iter,
 165                                                     gint               y,
 166                                                     gint              *line_top);
 167
 168 void gtk_text_view_buffer_to_window_coords (GtkTextView       *text_view,
 169                                             GtkTextWindowType  win,
 170                                             gint               buffer_x,
 171                                             gint               buffer_y,
 172                                             gint              *window_x,
 173                                             gint              *window_y);
 174 void gtk_text_view_window_to_buffer_coords (GtkTextView       *text_view,
 175                                             GtkTextWindowType  win,
 176                                             gint               window_x,
 177                                             gint               window_y,
 178                                             gint              *buffer_x,
 179                                             gint              *buffer_y);
 180
 181 #ifndef GTK_DISABLE_DEPRECATED
 182 GtkAdjustment*   gtk_text_view_get_hadjustment (GtkTextView   *text_view);
 183 GtkAdjustment*   gtk_text_view_get_vadjustment (GtkTextView   *text_view);
 184 #endif
 185
 186 GdkWindow*        gtk_text_view_get_window      (GtkTextView       *text_view,
 187                                                  GtkTextWindowType  win);
 188 GtkTextWindowType gtk_text_view_get_window_type (GtkTextView       *text_view,
 189                                                  GdkWindow         *window);
 190
 191 void gtk_text_view_set_border_window_size (GtkTextView       *text_view,
 192                                            GtkTextWindowType  type,
 193                                            gint               size);
 194 gint gtk_text_view_get_border_window_size (GtkTextView       *text_view,
 195                                            GtkTextWindowType  type);
 196
 197 gboolean gtk_text_view_forward_display_line           (GtkTextView       *text_view,
 198                                                        GtkTextIter       *iter);
 199 gboolean gtk_text_view_backward_display_line          (GtkTextView       *text_view,
 200                                                        GtkTextIter       *iter);
 201 gboolean gtk_text_view_forward_display_line_end       (GtkTextView       *text_view,
 202                                                        GtkTextIter       *iter);
 203 gboolean gtk_text_view_backward_display_line_start    (GtkTextView       *text_view,
 204                                                        GtkTextIter       *iter);
 205 gboolean gtk_text_view_starts_display_line            (GtkTextView       *text_view,
 206                                                        const GtkTextIter *iter);
 207 gboolean gtk_text_view_move_visually                  (GtkTextView       *text_view,
 208                                                        GtkTextIter       *iter,
 209                                                        gint               count);
 210
 211 gboolean        gtk_text_view_im_context_filter_keypress        (GtkTextView       *text_view,
 212                                                                  GdkEventKey       *event);
 213 void            gtk_text_view_reset_im_context                  (GtkTextView       *text_view);
 214
 215 /* Adding child widgets */
 216 void gtk_text_view_add_child_at_anchor (GtkTextView          *text_view,
 217                                         GtkWidget            *child,
 218                                         GtkTextChildAnchor   *anchor);
 219
 220 void gtk_text_view_add_child_in_window (GtkTextView          *text_view,
 221                                         GtkWidget            *child,
 222                                         GtkTextWindowType     which_window,
 223                                         /* window coordinates */
 224                                         gint                  xpos,
 225                                         gint                  ypos);
 226
 227 void gtk_text_view_move_child          (GtkTextView          *text_view,
 228                                         GtkWidget            *child,
 229                                         /* window coordinates */
 230                                         gint                  xpos,
 231                                         gint                  ypos);
 232
 233 /* Default style settings (fallbacks if no tag affects the property) */
 234
 235 void             gtk_text_view_set_wrap_mode          (GtkTextView      *text_view,
 236                                                        GtkWrapMode       wrap_mode);
 237 GtkWrapMode      gtk_text_view_get_wrap_mode          (GtkTextView      *text_view);
 238 void             gtk_text_view_set_editable           (GtkTextView      *text_view,
 239                                                        gboolean          setting);
 240 gboolean         gtk_text_view_get_editable           (GtkTextView      *text_view);
 241 void             gtk_text_view_set_overwrite          (GtkTextView      *text_view,
 242                                                        gboolean          overwrite);
 243 gboolean         gtk_text_view_get_overwrite          (GtkTextView      *text_view);
 244 void             gtk_text_view_set_accepts_tab        (GtkTextView      *text_view,
 245                                                        gboolean          accepts_tab);
 246 gboolean         gtk_text_view_get_accepts_tab        (GtkTextView      *text_view);
 247 void             gtk_text_view_set_pixels_above_lines (GtkTextView      *text_view,
 248                                                        gint              pixels_above_lines);
 249 gint             gtk_text_view_get_pixels_above_lines (GtkTextView      *text_view);
 250 void             gtk_text_view_set_pixels_below_lines (GtkTextView      *text_view,
 251                                                        gint              pixels_below_lines);
 252 gint             gtk_text_view_get_pixels_below_lines (GtkTextView      *text_view);
 253 void             gtk_text_view_set_pixels_inside_wrap (GtkTextView      *text_view,
 254                                                        gint              pixels_inside_wrap);
 255 gint             gtk_text_view_get_pixels_inside_wrap (GtkTextView      *text_view);
 256 void             gtk_text_view_set_justification      (GtkTextView      *text_view,
 257                                                        GtkJustification  justification);
 258 GtkJustification gtk_text_view_get_justification      (GtkTextView      *text_view);
 259 void             gtk_text_view_set_left_margin        (GtkTextView      *text_view,
 260                                                        gint              left_margin);
 261 gint             gtk_text_view_get_left_margin        (GtkTextView      *text_view);
 262 void             gtk_text_view_set_right_margin       (GtkTextView      *text_view,
 263                                                        gint              right_margin);
 264 gint             gtk_text_view_get_right_margin       (GtkTextView      *text_view);
 265 void             gtk_text_view_set_indent             (GtkTextView      *text_view,
 266                                                        gint              indent);
 267 gint             gtk_text_view_get_indent             (GtkTextView      *text_view);
 268 void             gtk_text_view_set_tabs               (GtkTextView      *text_view,
 269                                                        PangoTabArray    *tabs);
 270 PangoTabArray*   gtk_text_view_get_tabs               (GtkTextView      *text_view);
 271
 272 /* note that the return value of this changes with the theme */
 273 GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView    *text_view);
 274
 275 G_END_DECLS
 276
 277 #endif /* __GTK_TEXT_VIEW_H__ */