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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   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 #ifndef __GTK_TEXT_H__
  28 #define __GTK_TEXT_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkadjustment.h>
  33 #include <gtk/gtkoldeditable.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39
  40 #define GTK_TYPE_TEXT                  (gtk_text_get_type ())
  41 #define GTK_TEXT(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_TEXT, GtkText))
  42 #define GTK_TEXT_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TEXT, GtkTextClass))
  43 #define GTK_IS_TEXT(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_TEXT))
  44 #define GTK_IS_TEXT_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TEXT))
  45 #define GTK_TEXT_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TEXT, GtkTextClass))
  46
  47
  48 typedef struct _GtkTextFont       GtkTextFont;
  49 typedef struct _GtkPropertyMark   GtkPropertyMark;
  50 typedef struct _GtkText           GtkText;
  51 typedef struct _GtkTextClass      GtkTextClass;
  52
  53 struct _GtkPropertyMark
  54 {
  55   /* Position in list. */
  56   GList* property;
  57
  58   /* Offset into that property. */
  59   guint offset;
  60
  61   /* Current index. */
  62   guint index;
  63 };
  64
  65 struct _GtkText
  66 {
  67   GtkOldEditable old_editable;
  68
  69   GdkWindow *text_area;
  70
  71   GtkAdjustment *hadj;
  72   GtkAdjustment *vadj;
  73
  74   GdkGC *gc;
  75
  76   GdkPixmap* line_wrap_bitmap;
  77   GdkPixmap* line_arrow_bitmap;
  78
  79                       /* GAPPED TEXT SEGMENT */
  80
  81   /* The text, a single segment of text a'la emacs, with a gap
  82    * where insertion occurs. */
  83   union { GdkWChar *wc; guchar  *ch; } text;
  84   /* The allocated length of the text segment. */
  85   guint text_len;
  86   /* The gap position, index into address where a char
  87    * should be inserted. */
  88   guint gap_position;
  89   /* The gap size, s.t. *(text + gap_position + gap_size) is
  90    * the first valid character following the gap. */
  91   guint gap_size;
  92   /* The last character position, index into address where a
  93    * character should be appeneded.  Thus, text_end - gap_size
  94    * is the length of the actual data. */
  95   guint text_end;
  96                         /* LINE START CACHE */
  97
  98   /* A cache of line-start information.  Data is a LineParam*. */
  99   GList *line_start_cache;
 100   /* Index to the start of the first visible line. */
 101   guint first_line_start_index;
 102   /* The number of pixels cut off of the top line. */
 103   guint first_cut_pixels;
 104   /* First visible horizontal pixel. */
 105   guint first_onscreen_hor_pixel;
 106   /* First visible vertical pixel. */
 107   guint first_onscreen_ver_pixel;
 108
 109                              /* FLAGS */
 110
 111   /* True iff this buffer is wrapping lines, otherwise it is using a
 112    * horizontal scrollbar. */
 113   guint line_wrap : 1;
 114   guint word_wrap : 1;
 115  /* If a fontset is supplied for the widget, use_wchar become true,
 116    * and we use GdkWchar as the encoding of text. */
 117   guint use_wchar : 1;
 118
 119   /* Frozen, don't do updates. @@@ fixme */
 120   guint freeze_count;
 121                         /* TEXT PROPERTIES */
 122
 123   /* A doubly-linked-list containing TextProperty objects. */
 124   GList *text_properties;
 125   /* The end of this list. */
 126   GList *text_properties_end;
 127   /* The first node before or on the point along with its offset to
 128    * the point and the buffer's current point.  This is the only
 129    * PropertyMark whose index is guaranteed to remain correct
 130    * following a buffer insertion or deletion. */
 131   GtkPropertyMark point;
 132
 133                           /* SCRATCH AREA */
 134
 135   union { GdkWChar *wc; guchar *ch; } scratch_buffer;
 136   guint   scratch_buffer_len;
 137
 138                            /* SCROLLING */
 139
 140   gint last_ver_value;
 141
 142                              /* CURSOR */
 143
 144   gint            cursor_pos_x;       /* Position of cursor. */
 145   gint            cursor_pos_y;       /* Baseline of line cursor is drawn on. */
 146   GtkPropertyMark cursor_mark;        /* Where it is in the buffer. */
 147   GdkWChar        cursor_char;        /* Character to redraw. */
 148   gchar           cursor_char_offset; /* Distance from baseline of the font. */
 149   gint            cursor_virtual_x;   /* Where it would be if it could be. */
 150   gint            cursor_drawn_level; /* How many people have undrawn. */
 151
 152                           /* Current Line */
 153
 154   GList *current_line;
 155
 156                            /* Tab Stops */
 157
 158   GList *tab_stops;
 159   gint default_tab_width;
 160
 161   GtkTextFont *current_font;    /* Text font for current style */
 162
 163   /* Timer used for auto-scrolling off ends */
 164   gint timer;
 165
 166   guint button;                 /* currently pressed mouse button */
 167   GdkGC *bg_gc;                 /* gc for drawing background pixmap */
 168 };
 169
 170 struct _GtkTextClass
 171 {
 172   GtkOldEditableClass parent_class;
 173
 174   void  (*set_scroll_adjustments)   (GtkText        *text,
 175                                      GtkAdjustment  *hadjustment,
 176                                      GtkAdjustment  *vadjustment);
 177 };
 178
 179
 180 GtkType    gtk_text_get_type        (void) G_GNUC_CONST;
 181 GtkWidget* gtk_text_new             (GtkAdjustment *hadj,
 182                                      GtkAdjustment *vadj);
 183 void       gtk_text_set_editable    (GtkText       *text,
 184                                      gboolean       editable);
 185 void       gtk_text_set_word_wrap   (GtkText       *text,
 186                                      gint           word_wrap);
 187 void       gtk_text_set_line_wrap   (GtkText       *text,
 188                                      gint           line_wrap);
 189 void       gtk_text_set_adjustments (GtkText       *text,
 190                                      GtkAdjustment *hadj,
 191                                      GtkAdjustment *vadj);
 192 void       gtk_text_set_point       (GtkText       *text,
 193                                      guint          index);
 194 guint      gtk_text_get_point       (GtkText       *text);
 195 guint      gtk_text_get_length      (GtkText       *text);
 196 void       gtk_text_freeze          (GtkText       *text);
 197 void       gtk_text_thaw            (GtkText       *text);
 198 void       gtk_text_insert          (GtkText       *text,
 199                                      GdkFont       *font,
 200                                      GdkColor      *fore,
 201                                      GdkColor      *back,
 202                                      const char    *chars,
 203                                      gint           length);
 204 gint       gtk_text_backward_delete (GtkText       *text,
 205                                      guint          nchars);
 206 gint       gtk_text_forward_delete  (GtkText       *text,
 207                                      guint          nchars);
 208
 209 #define GTK_TEXT_INDEX(t, index)        (((t)->use_wchar) \
 210         ? ((index) < (t)->gap_position ? (t)->text.wc[index] : \
 211                                         (t)->text.wc[(index)+(t)->gap_size]) \
 212         : ((index) < (t)->gap_position ? (t)->text.ch[index] : \
 213                                         (t)->text.ch[(index)+(t)->gap_size]))
 214
 215 #ifdef __cplusplus
 216 }
 217 #endif /* __cplusplus */
 218
 219
 220 #endif /* __GTK_TEXT_H__ */