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 (* set_scroll_adjustments)   (GtkTextView    *text_view,
  77                                      GtkAdjustment  *hadjustment,
  78                                      GtkAdjustment  *vadjustment);
  79
  80   void (* populate_popup)           (GtkTextView    *text_view,
  81                                      GtkMenu        *menu);
  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   /* FIXME should be deprecated in favor of adding GTK_MOVEMENT_HORIZONTAL_PAGES
  92    * or something in GTK 2.2, was put in to avoid adding enum values during
  93    * the freeze.
  94    */
  95   void (* page_horizontally) (GtkTextView *text_view,
  96                               gint         count,
  97                               gboolean     extend_selection);
  98
  99   /* move the "anchor" (what Emacs calls the mark) to the cursor position */
 100   void (* set_anchor)  (GtkTextView    *text_view);
 101
 102   /* Edits */
 103   void (* insert_at_cursor)      (GtkTextView *text_view,
 104                                   const gchar *str);
 105   void (* delete_from_cursor)    (GtkTextView  *text_view,
 106                                   GtkDeleteType type,
 107                                   gint          count);
 108   void (* backspace)             (GtkTextView *text_view);
 109
 110   /* cut copy paste */
 111   void (* cut_clipboard)   (GtkTextView *text_view);
 112   void (* copy_clipboard)  (GtkTextView *text_view);
 113   void (* paste_clipboard) (GtkTextView *text_view);
 114   /* overwrite */
 115   void (* toggle_overwrite) (GtkTextView *text_view);
 116
 117   /* as of GTK+ 2.12 the "move-focus" signal has been moved to GtkWidget,
 118    * so this is merley a virtual function now. Overriding it in subclasses
 119    * continues to work though.
 120    */
 121   void (* move_focus)       (GtkTextView     *text_view,
 122                              GtkDirectionType direction);
 123
 124   /* Padding for future expansion */
 125   void (*_gtk_reserved1) (void);
 126   void (*_gtk_reserved2) (void);
 127   void (*_gtk_reserved3) (void);
 128   void (*_gtk_reserved4) (void);
 129   void (*_gtk_reserved5) (void);
 130   void (*_gtk_reserved6) (void);
 131   void (*_gtk_reserved7) (void);
 132 };
 133
 134 GType          gtk_text_view_get_type              (void) G_GNUC_CONST;
 135 GtkWidget *    gtk_text_view_new                   (void);
 136 GtkWidget *    gtk_text_view_new_with_buffer       (GtkTextBuffer *buffer);
 137 void           gtk_text_view_set_buffer            (GtkTextView   *text_view,
 138                                                     GtkTextBuffer *buffer);
 139 GtkTextBuffer *gtk_text_view_get_buffer            (GtkTextView   *text_view);
 140 gboolean       gtk_text_view_scroll_to_iter        (GtkTextView   *text_view,
 141                                                     GtkTextIter   *iter,
 142                                                     gdouble        within_margin,
 143                                                     gboolean       use_align,
 144                                                     gdouble        xalign,
 145                                                     gdouble        yalign);
 146 void           gtk_text_view_scroll_to_mark        (GtkTextView   *text_view,
 147                                                     GtkTextMark   *mark,
 148                                                     gdouble        within_margin,
 149                                                     gboolean       use_align,
 150                                                     gdouble        xalign,
 151                                                     gdouble        yalign);
 152 void           gtk_text_view_scroll_mark_onscreen  (GtkTextView   *text_view,
 153                                                     GtkTextMark   *mark);
 154 gboolean       gtk_text_view_move_mark_onscreen    (GtkTextView   *text_view,
 155                                                     GtkTextMark   *mark);
 156 gboolean       gtk_text_view_place_cursor_onscreen (GtkTextView   *text_view);
 157
 158 void           gtk_text_view_get_visible_rect      (GtkTextView   *text_view,
 159                                                     GdkRectangle  *visible_rect);
 160 void           gtk_text_view_set_cursor_visible    (GtkTextView   *text_view,
 161                                                     gboolean       setting);
 162 gboolean       gtk_text_view_get_cursor_visible    (GtkTextView   *text_view);
 163
 164 void           gtk_text_view_get_iter_location     (GtkTextView   *text_view,
 165                                                     const GtkTextIter *iter,
 166                                                     GdkRectangle  *location);
 167 void           gtk_text_view_get_iter_at_location  (GtkTextView   *text_view,
 168                                                     GtkTextIter   *iter,
 169                                                     gint           x,
 170                                                     gint           y);
 171 void           gtk_text_view_get_iter_at_position  (GtkTextView   *text_view,
 172                                                     GtkTextIter   *iter,
 173                                                     gint          *trailing,
 174                                                     gint           x,
 175                                                     gint           y);
 176 void           gtk_text_view_get_line_yrange       (GtkTextView       *text_view,
 177                                                     const GtkTextIter *iter,
 178                                                     gint              *y,
 179                                                     gint              *height);
 180
 181 void           gtk_text_view_get_line_at_y         (GtkTextView       *text_view,
 182                                                     GtkTextIter       *target_iter,
 183                                                     gint               y,
 184                                                     gint              *line_top);
 185
 186 void gtk_text_view_buffer_to_window_coords (GtkTextView       *text_view,
 187                                             GtkTextWindowType  win,
 188                                             gint               buffer_x,
 189                                             gint               buffer_y,
 190                                             gint              *window_x,
 191                                             gint              *window_y);
 192 void gtk_text_view_window_to_buffer_coords (GtkTextView       *text_view,
 193                                             GtkTextWindowType  win,
 194                                             gint               window_x,
 195                                             gint               window_y,
 196                                             gint              *buffer_x,
 197                                             gint              *buffer_y);
 198
 199 GtkAdjustment* gtk_text_view_get_hadjustment (GtkTextView *text_view);
 200 GtkAdjustment* gtk_text_view_get_vadjustment (GtkTextView *text_view);
 201
 202 GdkWindow*        gtk_text_view_get_window      (GtkTextView       *text_view,
 203                                                  GtkTextWindowType  win);
 204 GtkTextWindowType gtk_text_view_get_window_type (GtkTextView       *text_view,
 205                                                  GdkWindow         *window);
 206
 207 void gtk_text_view_set_border_window_size (GtkTextView       *text_view,
 208                                            GtkTextWindowType  type,
 209                                            gint               size);
 210 gint gtk_text_view_get_border_window_size (GtkTextView       *text_view,
 211                                            GtkTextWindowType  type);
 212
 213 gboolean gtk_text_view_forward_display_line           (GtkTextView       *text_view,
 214                                                        GtkTextIter       *iter);
 215 gboolean gtk_text_view_backward_display_line          (GtkTextView       *text_view,
 216                                                        GtkTextIter       *iter);
 217 gboolean gtk_text_view_forward_display_line_end       (GtkTextView       *text_view,
 218                                                        GtkTextIter       *iter);
 219 gboolean gtk_text_view_backward_display_line_start    (GtkTextView       *text_view,
 220                                                        GtkTextIter       *iter);
 221 gboolean gtk_text_view_starts_display_line            (GtkTextView       *text_view,
 222                                                        const GtkTextIter *iter);
 223 gboolean gtk_text_view_move_visually                  (GtkTextView       *text_view,
 224                                                        GtkTextIter       *iter,
 225                                                        gint               count);
 226
 227 gboolean        gtk_text_view_im_context_filter_keypress        (GtkTextView       *text_view,
 228                                                                  GdkEventKey       *event);
 229 void            gtk_text_view_reset_im_context                  (GtkTextView       *text_view);
 230
 231 /* Adding child widgets */
 232 void gtk_text_view_add_child_at_anchor (GtkTextView          *text_view,
 233                                         GtkWidget            *child,
 234                                         GtkTextChildAnchor   *anchor);
 235
 236 void gtk_text_view_add_child_in_window (GtkTextView          *text_view,
 237                                         GtkWidget            *child,
 238                                         GtkTextWindowType     which_window,
 239                                         /* window coordinates */
 240                                         gint                  xpos,
 241                                         gint                  ypos);
 242
 243 void gtk_text_view_move_child          (GtkTextView          *text_view,
 244                                         GtkWidget            *child,
 245                                         /* window coordinates */
 246                                         gint                  xpos,
 247                                         gint                  ypos);
 248
 249 /* Default style settings (fallbacks if no tag affects the property) */
 250
 251 void             gtk_text_view_set_wrap_mode          (GtkTextView      *text_view,
 252                                                        GtkWrapMode       wrap_mode);
 253 GtkWrapMode      gtk_text_view_get_wrap_mode          (GtkTextView      *text_view);
 254 void             gtk_text_view_set_editable           (GtkTextView      *text_view,
 255                                                        gboolean          setting);
 256 gboolean         gtk_text_view_get_editable           (GtkTextView      *text_view);
 257 void             gtk_text_view_set_overwrite          (GtkTextView      *text_view,
 258                                                        gboolean          overwrite);
 259 gboolean         gtk_text_view_get_overwrite          (GtkTextView      *text_view);
 260 void             gtk_text_view_set_accepts_tab        (GtkTextView      *text_view,
 261                                                        gboolean          accepts_tab);
 262 gboolean         gtk_text_view_get_accepts_tab        (GtkTextView      *text_view);
 263 void             gtk_text_view_set_pixels_above_lines (GtkTextView      *text_view,
 264                                                        gint              pixels_above_lines);
 265 gint             gtk_text_view_get_pixels_above_lines (GtkTextView      *text_view);
 266 void             gtk_text_view_set_pixels_below_lines (GtkTextView      *text_view,
 267                                                        gint              pixels_below_lines);
 268 gint             gtk_text_view_get_pixels_below_lines (GtkTextView      *text_view);
 269 void             gtk_text_view_set_pixels_inside_wrap (GtkTextView      *text_view,
 270                                                        gint              pixels_inside_wrap);
 271 gint             gtk_text_view_get_pixels_inside_wrap (GtkTextView      *text_view);
 272 void             gtk_text_view_set_justification      (GtkTextView      *text_view,
 273                                                        GtkJustification  justification);
 274 GtkJustification gtk_text_view_get_justification      (GtkTextView      *text_view);
 275 void             gtk_text_view_set_left_margin        (GtkTextView      *text_view,
 276                                                        gint              left_margin);
 277 gint             gtk_text_view_get_left_margin        (GtkTextView      *text_view);
 278 void             gtk_text_view_set_right_margin       (GtkTextView      *text_view,
 279                                                        gint              right_margin);
 280 gint             gtk_text_view_get_right_margin       (GtkTextView      *text_view);
 281 void             gtk_text_view_set_indent             (GtkTextView      *text_view,
 282                                                        gint              indent);
 283 gint             gtk_text_view_get_indent             (GtkTextView      *text_view);
 284 void             gtk_text_view_set_tabs               (GtkTextView      *text_view,
 285                                                        PangoTabArray    *tabs);
 286 PangoTabArray*   gtk_text_view_get_tabs               (GtkTextView      *text_view);
 287
 288 /* note that the return value of this changes with the theme */
 289 GtkTextAttributes* gtk_text_view_get_default_attributes (GtkTextView    *text_view);
 290
 291 G_END_DECLS
 292
 293 #endif /* __GTK_TEXT_VIEW_H__ */