Pileus Git - ~andy/gtk/blob - gtk/gtkentry.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_ENTRY_H__
  28 #define __GTK_ENTRY_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkeditable.h>
  33 #include <gtk/gtkimcontext.h>
  34 #include <pango/pango.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif /* __cplusplus */
  39
  40
  41 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  42 #define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  43 #define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  44 #define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
  45 #define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  46 #define GTK_ENTRY_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
  47
  48
  49 typedef struct _GtkEntry       GtkEntry;
  50 typedef struct _GtkEntryClass  GtkEntryClass;
  51
  52 struct _GtkEntry
  53 {
  54   GtkWidget  widget;
  55
  56   gchar     *text;
  57
  58   guint      editable : 1;
  59   guint      visible  : 1;
  60   guint      overwrite_mode : 1;
  61   guint      in_drag : 1;       /* Dragging within the selection */
  62
  63   guint16 text_length;  /* length in use, in chars */
  64   guint16 text_max_length;
  65
  66   /*< private >*/
  67   GdkWindow *text_area;
  68   GtkIMContext *im_context;
  69   GtkWidget   *popup_menu;
  70
  71   gint         current_pos;
  72   gint         selection_bound;
  73
  74   PangoLayout *cached_layout;
  75   guint        cache_includes_preedit : 1;
  76
  77   guint        need_im_reset : 1;
  78
  79   guint   button;
  80   guint   timer;
  81   guint   recompute_idle;
  82   gint    scroll_offset;
  83   gint    ascent;       /* font ascent, in pango units  */
  84   gint    descent;      /* font descent, in pango units  */
  85
  86   guint16 text_size;    /* allocated size, in bytes */
  87   guint16 n_bytes;      /* length in use, in bytes */
  88
  89   guint16 preedit_length;       /* length of preedit string, in bytes */
  90   guint16 preedit_cursor;       /* offset of cursor within preedit string, in chars */
  91
  92   gint dnd_position;            /* In chars, -1 == no DND cursor */
  93
  94   gint drag_start_x;
  95   gint drag_start_y;
  96
  97   gunichar invisible_char;
  98 };
  99
 100 struct _GtkEntryClass
 101 {
 102   GtkWidgetClass parent_class;
 103
 104   /* Notification of changes
 105    */
 106   void (* changed)          (GtkEntry       *entry);
 107   void (* insert_text)      (GtkEntry       *entry,
 108                              const gchar    *text,
 109                              gint            length,
 110                              gint           *position);
 111   void (* delete_text)      (GtkEntry       *entry,
 112                              gint            start_pos,
 113                              gint            end_pos);
 114
 115   /* Action signals
 116    */
 117   void (* activate)           (GtkEntry       *entry);
 118   void (* move_cursor)        (GtkEntry       *entry,
 119                                GtkMovementStep step,
 120                                gint            count,
 121                                gboolean        extend_selection);
 122   void (* insert_at_cursor)   (GtkEntry       *entry,
 123                                const gchar    *str);
 124   void (* delete_from_cursor) (GtkEntry       *entry,
 125                                GtkDeleteType   type,
 126                                gint            count);
 127   void (* cut_clipboard)      (GtkEntry       *entry);
 128   void (* copy_clipboard)     (GtkEntry       *entry);
 129   void (* paste_clipboard)    (GtkEntry       *entry);
 130   void (* toggle_overwrite)   (GtkEntry       *entry);
 131 };
 132
 133 GtkType    gtk_entry_get_type                   (void) G_GNUC_CONST;
 134 GtkWidget* gtk_entry_new                        (void);
 135 void       gtk_entry_set_visibility             (GtkEntry      *entry,
 136                                                  gboolean       visible);
 137 void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
 138                                                  gunichar       ch);
 139 void       gtk_entry_set_editable               (GtkEntry      *entry,
 140                                                  gboolean       editable);
 141 /* text is truncated if needed */
 142 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 143                                                  guint16        max);
 144
 145 /* Somewhat more convenient than the GtkEditable generic functions
 146  */
 147 void       gtk_entry_set_text                   (GtkEntry      *entry,
 148                                                  const gchar   *text);
 149 /* returns a reference to the text */
 150 gchar*     gtk_entry_get_text                   (GtkEntry      *entry);
 151
 152 /* Deprecated compatibility functions
 153  */
 154 GtkWidget* gtk_entry_new_with_max_length        (guint16       max);
 155 void       gtk_entry_append_text                (GtkEntry      *entry,
 156                                                  const gchar   *text);
 157 void       gtk_entry_prepend_text               (GtkEntry      *entry,
 158                                                  const gchar   *text);
 159 void       gtk_entry_set_position               (GtkEntry      *entry,
 160                                                  gint           position);
 161 void       gtk_entry_select_region              (GtkEntry      *entry,
 162                                                  gint           start,
 163                                                  gint           end);
 164
 165 #ifdef __cplusplus
 166 }
 167 #endif /* __cplusplus */
 168
 169
 170 #endif /* __GTK_ENTRY_H__ */