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