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 /**
  60  * GTK_TEXT_VIEW_PRIORITY_VALIDATE:
  61  *
  62  * The priority at which the text view validates onscreen lines
  63  * in an idle job in the background.
  64  */
  65 #define GTK_TEXT_VIEW_PRIORITY_VALIDATE (GDK_PRIORITY_REDRAW + 5)
  66
  67 typedef struct _GtkTextView        GtkTextView;
  68 typedef struct _GtkTextViewPrivate GtkTextViewPrivate;
  69 typedef struct _GtkTextViewClass   GtkTextViewClass;
  70
  71 struct _GtkTextView
  72 {
  73   GtkContainer parent_instance;
  74
  75   GtkTextViewPrivate *priv;
  76 };
  77
  78 struct _GtkTextViewClass
  79 {
  80   GtkContainerClass parent_class;
  81
  82   void (* populate_popup)           (GtkTextView    *text_view,
  83                                      GtkMenu        *menu);
  84
  85   /* These are all RUN_ACTION signals for keybindings */
  86
  87   /* move insertion point */
  88   void (* move_cursor) (GtkTextView    *text_view,
  89                         GtkMovementStep step,
  90                         gint            count,
  91                         gboolean        extend_selection);
  92
  93   /* move the "anchor" (what Emacs calls the mark) to the cursor position */
  94   void (* set_anchor)  (GtkTextView    *text_view);
  95
  96   /* Edits */
  97   void (* insert_at_cursor)      (GtkTextView *text_view,
  98                                   const gchar *str);
  99   void (* delete_from_cursor)    (GtkTextView  *text_view,
 100                                   GtkDeleteType type,
 101                                   gint          count);
 102   void (* backspace)             (GtkTextView *text_view);
 103
 104   /* cut copy paste */
 105   void (* cut_clipboard)   (GtkTextView *text_view);
 106   void (* copy_clipboard)  (GtkTextView *text_view);
 107   void (* paste_clipboard) (GtkTextView *text_view);
 108   /* overwrite */
 109   void (* toggle_overwrite) (GtkTextView *text_view);
 110
 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);
 120 };
 121
 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,
 129                                                     GtkTextIter   *iter,
 130                                                     gdouble        within_margin,
 131                                                     gboolean       use_align,
 132                                                     gdouble        xalign,
 133                                                     gdouble        yalign);
 134 void           gtk_text_view_scroll_to_mark        (GtkTextView   *text_view,
 135                                                     GtkTextMark   *mark,
 136                                                     gdouble        within_margin,
 137                                                     gboolean       use_align,
 138                                                     gdouble        xalign,
 139                                                     gdouble        yalign);
 140 void           gtk_text_view_scroll_mark_onscreen  (GtkTextView   *text_view,
 141                                                     GtkTextMark   *mark);
 142 gboolean       gtk_text_view_move_mark_onscreen    (GtkTextView   *text_view,
 143                                                     GtkTextMark   *mark);
 144 gboolean       gtk_text_view_place_cursor_onscreen (GtkTextView   *text_view);
 145
 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,
 149                                                     gboolean       setting);
 150 gboolean       gtk_text_view_get_cursor_visible    (GtkTextView   *text_view);
 151
 152 void           gtk_text_view_get_cursor_locations  (GtkTextView       *text_view,
 153                                                     const GtkTextIter *iter,
 154                                                     GdkRectangle      *strong,
 155                                                     GdkRectangle      *weak);
 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,
 160                                                     GtkTextIter   *iter,
 161                                                     gint           x,
 162                                                     gint           y);
 163 void           gtk_text_view_get_iter_at_position  (GtkTextView   *text_view,
 164                                                     GtkTextIter   *iter,
 165                                                     gint          *trailing,
 166                                                     gint           x,
 167                                                     gint           y);
 168 void           gtk_text_view_get_line_yrange       (GtkTextView       *text_view,
 169                                                     const GtkTextIter *iter,
 170                                                     gint              *y,
 171                                                     gint              *height);
 172
 173 void           gtk_text_view_get_line_at_y         (GtkTextView       *text_view,
 174                                                     GtkTextIter       *target_iter,
 175                                                     gint               y,
 176                                                     gint              *line_top);
 177
 178 void gtk_text_view_buffer_to_window_coords (GtkTextView       *text_view,
 179                                             GtkTextWindowType  win,
 180                                             gint               buffer_x,
 181                                             gint               buffer_y,
 182                                             gint              *window_x,
 183                                             gint              *window_y);
 184 void gtk_text_view_window_to_buffer_coords (GtkTextView       *text_view,
 185                                             GtkTextWindowType  win,
 186                                             gint               window_x,
 187                                             gint               window_y,
 188                                             gint              *buffer_x,
 189                                             gint              *buffer_y);
 190
 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);
 194 #endif
 195
 196 GdkWindow*        gtk_text_view_get_window      (GtkTextView       *text_view,
 197                                                  GtkTextWindowType  win);
 198 GtkTextWindowType gtk_text_view_get_window_type (GtkTextView       *text_view,
 199                                                  GdkWindow         *window);
 200
 201 void gtk_text_view_set_border_window_size (GtkTextView       *text_view,
 202                                            GtkTextWindowType  type,
 203                                            gint               size);
 204 gint gtk_text_view_get_border_window_size (GtkTextView       *text_view,
 205                                            GtkTextWindowType  type);
 206
 207 gboolean gtk_text_view_forward_display_line           (GtkTextView       *text_view,
 208                                                        GtkTextIter       *iter);
 209 gboolean gtk_text_view_backward_display_line          (GtkTextView       *text_view,
 210                                                        GtkTextIter       *iter);
 211 gboolean gtk_text_view_forward_display_line_end       (GtkTextView       *text_view,
 212                                                        GtkTextIter       *iter);
 213 gboolean gtk_text_view_backward_display_line_start    (GtkTextView       *text_view,
 214                                                        GtkTextIter       *iter);
 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,
 218                                                        GtkTextIter       *iter,
 219                                                        gint               count);
 220
 221 gboolean        gtk_text_view_im_context_filter_keypress        (GtkTextView       *text_view,
 222                                                                  GdkEventKey       *event);
 223 void            gtk_text_view_reset_im_context                  (GtkTextView       *text_view);
 224
 225 /* Adding child widgets */
 226 void gtk_text_view_add_child_at_anchor (GtkTextView          *text_view,
 227                                         GtkWidget            *child,
 228                                         GtkTextChildAnchor   *anchor);
 229
 230 void gtk_text_view_add_child_in_window (GtkTextView          *text_view,
 231                                         GtkWidget            *child,
 232                                         GtkTextWindowType     which_window,
 233                                         /* window coordinates */
 234                                         gint                  xpos,
 235                                         gint                  ypos);
 236
 237 void gtk_text_view_move_child          (GtkTextView          *text_view,
 238                                         GtkWidget            *child,
 239                                         /* window coordinates */
 240                                         gint                  xpos,
 241                                         gint                  ypos);
 242
 243 /* Default style settings (fallbacks if no tag affects the property) */
 244
 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,
 249                                                        gboolean          setting);
 250 gboolean         gtk_text_view_get_editable           (GtkTextView      *text_view);
 251 void             gtk_text_view_set_overwrite          (GtkTextView      *text_view,
 252                                                        gboolean          overwrite);
 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,
 270                                                        gint              left_margin);
 271 gint             gtk_text_view_get_left_margin        (GtkTextView      *text_view);
 272 void             gtk_text_view_set_right_margin       (GtkTextView      *text_view,
 273                                                        gint              right_margin);
 274 gint             gtk_text_view_get_right_margin       (GtkTextView      *text_view);
 275 void             gtk_text_view_set_indent             (GtkTextView      *text_view,
 276                                                        gint              indent);
 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);
 281
 282 /* note that the return value of this changes with the theme */
 283 GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView    *text_view);
 284
 285 G_END_DECLS
 286
 287 #endif /* __GTK_TEXT_VIEW_H__ */