Pileus Git - ~andy/gtk/blob - gtk/gtkeditable.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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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-1999.  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_EDITABLE_H__
  28 #define __GTK_EDITABLE_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkwidget.h>
  33
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif /* __cplusplus */
  38
  39
  40 #define GTK_TYPE_EDITABLE            (gtk_editable_get_type ())
  41 #define GTK_EDITABLE(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_EDITABLE, GtkEditable))
  42 #define GTK_EDITABLE_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_EDITABLE, GtkEditableClass))
  43 #define GTK_IS_EDITABLE(obj)         (GTK_CHECK_TYPE ((obj), GTK_TYPE_EDITABLE))
  44 #define GTK_IS_EDITABLE_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_EDITABLE))
  45
  46
  47 typedef struct _GtkEditable       GtkEditable;
  48 typedef struct _GtkEditableClass  GtkEditableClass;
  49
  50 typedef void (*GtkTextFunction) (GtkEditable  *editable, guint32 time);
  51
  52 struct _GtkEditable
  53 {
  54   GtkWidget widget;
  55
  56   guint      current_pos;
  57
  58   guint      selection_start_pos;
  59   guint      selection_end_pos;
  60   guint      has_selection : 1;
  61   guint      editable : 1;
  62   guint      visible : 1;
  63   GdkIC     *ic;
  64   GdkICAttr *ic_attr;
  65
  66   gchar *clipboard_text;
  67 };
  68
  69 struct _GtkEditableClass
  70 {
  71   GtkWidgetClass parent_class;
  72
  73   /* Signals for notification/filtering of changes */
  74   void (* changed)      (GtkEditable    *editable);
  75   void (* insert_text)  (GtkEditable    *editable,
  76                          const gchar    *text,
  77                          gint            length,
  78                          gint           *position);
  79   void (* delete_text)  (GtkEditable    *editable,
  80                          gint            start_pos,
  81                          gint            end_pos);
  82
  83   /* Bindings actions */
  84   void (* activate)        (GtkEditable *editable);
  85   void (* set_editable)    (GtkEditable *editable,
  86                             gboolean     is_editable);
  87   void (* move_cursor)     (GtkEditable *editable,
  88                             gint         x,
  89                             gint         y);
  90   void (* move_word)       (GtkEditable *editable,
  91                             gint         n);
  92   void (* move_page)       (GtkEditable *editable,
  93                             gint         x,
  94                             gint         y);
  95   void (* move_to_row)     (GtkEditable *editable,
  96                             gint         row);
  97   void (* move_to_column)  (GtkEditable *editable,
  98                             gint         row);
  99   void (* kill_char)       (GtkEditable *editable,
 100                             gint         direction);
 101   void (* kill_word)       (GtkEditable *editable,
 102                             gint         direction);
 103   void (* kill_line)       (GtkEditable *editable,
 104                             gint         direction);
 105   void (* cut_clipboard)   (GtkEditable *editable);
 106   void (* copy_clipboard)  (GtkEditable *editable);
 107   void (* paste_clipboard) (GtkEditable *editable);
 108
 109   /* Virtual functions. get_chars is in paricular not a signal because
 110    * it returns malloced memory. The others are not signals because
 111    * they would not be particularly useful as such. (All changes to
 112    * selection and position do not go through these functions)
 113    */
 114   void (* update_text)  (GtkEditable    *editable,
 115                          gint            start_pos,
 116                          gint            end_pos);
 117   gchar* (* get_chars)  (GtkEditable    *editable,
 118                          gint            start_pos,
 119                          gint            end_pos);
 120   void (* set_selection)(GtkEditable    *editable,
 121                          gint            start_pos,
 122                          gint            end_pos);
 123   void (* set_position) (GtkEditable    *editable,
 124                          gint            position);
 125 };
 126
 127 GtkType    gtk_editable_get_type       (void);
 128 void       gtk_editable_select_region  (GtkEditable      *editable,
 129                                         gint              start,
 130                                         gint              end);
 131 void       gtk_editable_insert_text   (GtkEditable       *editable,
 132                                         const gchar      *new_text,
 133                                         gint              new_text_length,
 134                                         gint             *position);
 135 void       gtk_editable_delete_text    (GtkEditable      *editable,
 136                                         gint              start_pos,
 137                                         gint              end_pos);
 138 gchar*     gtk_editable_get_chars      (GtkEditable      *editable,
 139                                         gint              start_pos,
 140                                         gint              end_pos);
 141 void       gtk_editable_cut_clipboard  (GtkEditable      *editable);
 142 void       gtk_editable_copy_clipboard (GtkEditable      *editable);
 143 void       gtk_editable_paste_clipboard (GtkEditable     *editable);
 144 void       gtk_editable_claim_selection (GtkEditable     *editable,
 145                                          gboolean         claim,
 146                                          guint32          time);
 147 void       gtk_editable_delete_selection (GtkEditable    *editable);
 148
 149 void       gtk_editable_changed         (GtkEditable    *editable);
 150 void       gtk_editable_set_position    (GtkEditable    *editable,
 151                                          gint            position);
 152 gint       gtk_editable_get_position    (GtkEditable    *editable);
 153 void       gtk_editable_set_editable    (GtkEditable    *editable,
 154                                          gboolean        is_editable);
 155
 156
 157 #ifdef __cplusplus
 158 }
 159 #endif /* __cplusplus */
 160
 161
 162 #endif /* __GTK_EDITABLE_H__ */