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 <gtk/gtkmenu.h>
  35 #include <pango/pango.h>
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif /* __cplusplus */
  40
  41
  42 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  43 #define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  44 #define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  45 #define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
  46 #define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  47 #define GTK_ENTRY_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
  48
  49
  50 typedef struct _GtkEntry       GtkEntry;
  51 typedef struct _GtkEntryClass  GtkEntryClass;
  52
  53 struct _GtkEntry
  54 {
  55   GtkWidget  widget;
  56
  57   gchar     *text;
  58
  59   guint      editable : 1;
  60   guint      visible  : 1;
  61   guint      overwrite_mode : 1;
  62   guint      in_drag : 1;       /* Dragging within the selection */
  63
  64   guint16 text_length;  /* length in use, in chars */
  65   guint16 text_max_length;
  66
  67   /*< private >*/
  68   GdkWindow *text_area;
  69   GtkIMContext *im_context;
  70   GtkWidget   *popup_menu;
  71
  72   gint         current_pos;
  73   gint         selection_bound;
  74
  75   PangoLayout *cached_layout;
  76   guint        cache_includes_preedit : 1;
  77
  78   guint        need_im_reset : 1;
  79
  80   guint        has_frame : 1;
  81
  82   guint        activates_default : 1;
  83
  84   guint        cursor_visible : 1;
  85
  86   guint        in_click : 1;    /* Flag so we don't select all when clicking in entry to focus in */
  87
  88   guint        is_cell_renderer : 1;
  89   guint        editing_canceled : 1; /* Only used by GtkCellRendererText */
  90
  91   guint        mouse_cursor_obscured : 1;
  92
  93   guint   button;
  94   guint   blink_timeout;
  95   guint   recompute_idle;
  96   gint    scroll_offset;
  97   gint    ascent;       /* font ascent, in pango units  */
  98   gint    descent;      /* font descent, in pango units  */
  99
 100   guint16 text_size;    /* allocated size, in bytes */
 101   guint16 n_bytes;      /* length in use, in bytes */
 102
 103   guint16 preedit_length;       /* length of preedit string, in bytes */
 104   guint16 preedit_cursor;       /* offset of cursor within preedit string, in chars */
 105
 106   gint dnd_position;            /* In chars, -1 == no DND cursor */
 107
 108   gint drag_start_x;
 109   gint drag_start_y;
 110
 111   gunichar invisible_char;
 112
 113   gint width_chars;
 114
 115   GdkGC *cursor_gc;
 116 };
 117
 118 struct _GtkEntryClass
 119 {
 120   GtkWidgetClass parent_class;
 121
 122   /* Hook to customize right-click popup */
 123   void (* populate_popup)   (GtkEntry       *entry,
 124                              GtkMenu        *menu);
 125
 126   /* Action signals
 127    */
 128   void (* activate)           (GtkEntry       *entry);
 129   void (* move_cursor)        (GtkEntry       *entry,
 130                                GtkMovementStep step,
 131                                gint            count,
 132                                gboolean        extend_selection);
 133   void (* insert_at_cursor)   (GtkEntry       *entry,
 134                                const gchar    *str);
 135   void (* delete_from_cursor) (GtkEntry       *entry,
 136                                GtkDeleteType   type,
 137                                gint            count);
 138   void (* cut_clipboard)      (GtkEntry       *entry);
 139   void (* copy_clipboard)     (GtkEntry       *entry);
 140   void (* paste_clipboard)    (GtkEntry       *entry);
 141   void (* toggle_overwrite)   (GtkEntry       *entry);
 142 };
 143
 144 GtkType    gtk_entry_get_type                   (void) G_GNUC_CONST;
 145 GtkWidget* gtk_entry_new                        (void);
 146 void       gtk_entry_set_visibility             (GtkEntry      *entry,
 147                                                  gboolean       visible);
 148 gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
 149 void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
 150                                                  gunichar       ch);
 151 gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
 152 void       gtk_entry_set_has_frame              (GtkEntry      *entry,
 153                                                  gboolean       setting);
 154 gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
 155 /* text is truncated if needed */
 156 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 157                                                  gint           max);
 158 gint       gtk_entry_get_max_length             (GtkEntry      *entry);
 159 void       gtk_entry_set_activates_default      (GtkEntry      *entry,
 160                                                  gboolean       setting);
 161 gboolean   gtk_entry_get_activates_default      (GtkEntry      *entry);
 162
 163 void       gtk_entry_set_width_chars            (GtkEntry      *entry,
 164                                                  gint           n_chars);
 165 gint       gtk_entry_get_width_chars            (GtkEntry      *entry);
 166
 167 /* Somewhat more convenient than the GtkEditable generic functions
 168  */
 169 void                  gtk_entry_set_text        (GtkEntry      *entry,
 170                                                  const gchar   *text);
 171 /* returns a reference to the text */
 172 G_CONST_RETURN gchar* gtk_entry_get_text        (GtkEntry      *entry);
 173
 174 PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
 175 void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
 176                                                  gint          *x,
 177                                                  gint          *y);
 178
 179 /* Deprecated compatibility functions
 180  */
 181
 182 #ifndef GTK_DISABLE_DEPRECATED
 183 GtkWidget* gtk_entry_new_with_max_length        (gint           max);
 184 void       gtk_entry_append_text                (GtkEntry      *entry,
 185                                                  const gchar   *text);
 186 void       gtk_entry_prepend_text               (GtkEntry      *entry,
 187                                                  const gchar   *text);
 188 void       gtk_entry_set_position               (GtkEntry      *entry,
 189                                                  gint           position);
 190 void       gtk_entry_select_region              (GtkEntry      *entry,
 191                                                  gint           start,
 192                                                  gint           end);
 193 void       gtk_entry_set_editable               (GtkEntry      *entry,
 194                                                  gboolean       editable);
 195 #endif /* GTK_DISABLE_DEPRECATED */
 196
 197 #ifdef __cplusplus
 198 }
 199 #endif /* __cplusplus */
 200
 201
 202 #endif /* __GTK_ENTRY_H__ */