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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_ENTRY_H__
  32 #define __GTK_ENTRY_H__
  33
  34
  35 #include <gtk/gtkeditable.h>
  36 #include <gtk/gtkimcontext.h>
  37 #include <gtk/gtkmenu.h>
  38 #include <gtk/gtkentrycompletion.h>
  39
  40
  41 G_BEGIN_DECLS
  42
  43 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  44 #define GTK_ENTRY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  45 #define GTK_ENTRY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  46 #define GTK_IS_ENTRY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
  47 #define GTK_IS_ENTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  48 #define GTK_ENTRY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
  49
  50
  51 typedef struct _GtkEntry       GtkEntry;
  52 typedef struct _GtkEntryClass  GtkEntryClass;
  53
  54 struct _GtkEntry
  55 {
  56   GtkWidget  widget;
  57
  58   gchar       *GSEAL (text);
  59
  60   guint        GSEAL (editable) : 1;
  61   guint        GSEAL (visible)  : 1;
  62   guint        GSEAL (overwrite_mode) : 1;
  63   guint        GSEAL (in_drag) : 1;                 /* FIXME: Should be private?
  64                                                        Dragging within the selection */
  65
  66   guint16      GSEAL (text_length);                 /* length in use, in chars */
  67   guint16      GSEAL (text_max_length);
  68
  69   /*< private >*/
  70   GdkWindow    *GSEAL (text_area);
  71   GtkIMContext *GSEAL (im_context);
  72   GtkWidget    *GSEAL (popup_menu);
  73
  74   gint          GSEAL (current_pos);
  75   gint          GSEAL (selection_bound);
  76
  77   PangoLayout  *GSEAL (cached_layout);
  78
  79   guint         GSEAL (cache_includes_preedit) : 1;
  80   guint         GSEAL (need_im_reset)          : 1;
  81   guint         GSEAL (has_frame)              : 1;
  82   guint         GSEAL (activates_default)      : 1;
  83   guint         GSEAL (cursor_visible)         : 1;
  84   guint         GSEAL (in_click)               : 1; /* Flag so we don't select all when clicking in entry to focus in */
  85   guint         GSEAL (is_cell_renderer)       : 1;
  86   guint         GSEAL (editing_canceled)       : 1; /* Only used by GtkCellRendererText */
  87   guint         GSEAL (mouse_cursor_obscured)  : 1;
  88   guint         GSEAL (select_words)           : 1;
  89   guint         GSEAL (select_lines)           : 1;
  90   guint         GSEAL (resolved_dir)           : 4; /* PangoDirection */
  91   guint         GSEAL (truncate_multiline)     : 1;
  92
  93   guint         GSEAL (button);
  94   guint         GSEAL (blink_timeout);
  95   guint         GSEAL (recompute_idle);
  96   gint          GSEAL (scroll_offset);
  97   gint          GSEAL (ascent);                     /* font ascent in pango units  */
  98   gint          GSEAL (descent);                    /* font descent in pango units */
  99
 100   guint16       GSEAL (text_size);                  /* allocated size, in bytes */
 101   guint16       GSEAL (n_bytes);                    /* length in use, in bytes */
 102
 103   guint16       GSEAL (preedit_length);             /* length of preedit string, in bytes */
 104   guint16       GSEAL (preedit_cursor);             /* offset of cursor within preedit string, in chars */
 105
 106   gint          GSEAL (dnd_position);               /* In chars, -1 == no DND cursor */
 107
 108   gint          GSEAL (drag_start_x);
 109   gint          GSEAL (drag_start_y);
 110
 111   gunichar      GSEAL (invisible_char);
 112
 113   gint          GSEAL (width_chars);
 114 };
 115
 116 struct _GtkEntryClass
 117 {
 118   GtkWidgetClass parent_class;
 119
 120   /* Hook to customize right-click popup */
 121   void (* populate_popup)   (GtkEntry       *entry,
 122                              GtkMenu        *menu);
 123
 124   /* Action signals
 125    */
 126   void (* activate)           (GtkEntry       *entry);
 127   void (* move_cursor)        (GtkEntry       *entry,
 128                                GtkMovementStep step,
 129                                gint            count,
 130                                gboolean        extend_selection);
 131   void (* insert_at_cursor)   (GtkEntry       *entry,
 132                                const gchar    *str);
 133   void (* delete_from_cursor) (GtkEntry       *entry,
 134                                GtkDeleteType   type,
 135                                gint            count);
 136   void (* backspace)          (GtkEntry       *entry);
 137   void (* cut_clipboard)      (GtkEntry       *entry);
 138   void (* copy_clipboard)     (GtkEntry       *entry);
 139   void (* paste_clipboard)    (GtkEntry       *entry);
 140   void (* toggle_overwrite)   (GtkEntry       *entry);
 141
 142   /* hook to add other objects beside the entry (like in GtkSpinButton) */
 143   void (* get_text_area_size) (GtkEntry       *entry,
 144                                gint           *x,
 145                                gint           *y,
 146                                gint           *width,
 147                                gint           *height);
 148
 149   /* Padding for future expansion */
 150   void (*_gtk_reserved2) (void);
 151   void (*_gtk_reserved3) (void);
 152 };
 153
 154 GType      gtk_entry_get_type                   (void) G_GNUC_CONST;
 155 GtkWidget* gtk_entry_new                        (void);
 156 void       gtk_entry_set_visibility             (GtkEntry      *entry,
 157                                                  gboolean       visible);
 158 gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
 159 void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
 160                                                  gunichar       ch);
 161 gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
 162 void       gtk_entry_unset_invisible_char       (GtkEntry      *entry);
 163 void       gtk_entry_set_has_frame              (GtkEntry      *entry,
 164                                                  gboolean       setting);
 165 gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
 166 void       gtk_entry_set_inner_border                (GtkEntry        *entry,
 167                                                       const GtkBorder *border);
 168 G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry        *entry);
 169 void       gtk_entry_set_overwrite_mode         (GtkEntry      *entry,
 170                                                  gboolean       overwrite);
 171 gboolean   gtk_entry_get_overwrite_mode         (GtkEntry      *entry);
 172 /* text is truncated if needed */
 173 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 174                                                  gint           max);
 175 gint       gtk_entry_get_max_length             (GtkEntry      *entry);
 176 guint16    gtk_entry_get_text_length            (GtkEntry      *entry);
 177 void       gtk_entry_set_activates_default      (GtkEntry      *entry,
 178                                                  gboolean       setting);
 179 gboolean   gtk_entry_get_activates_default      (GtkEntry      *entry);
 180
 181 void       gtk_entry_set_width_chars            (GtkEntry      *entry,
 182                                                  gint           n_chars);
 183 gint       gtk_entry_get_width_chars            (GtkEntry      *entry);
 184
 185 /* Somewhat more convenient than the GtkEditable generic functions
 186  */
 187 void       gtk_entry_set_text                   (GtkEntry      *entry,
 188                                                  const gchar   *text);
 189 /* returns a reference to the text */
 190 G_CONST_RETURN gchar* gtk_entry_get_text        (GtkEntry      *entry);
 191
 192 PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
 193 void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
 194                                                  gint          *x,
 195                                                  gint          *y);
 196 void       gtk_entry_set_alignment              (GtkEntry      *entry,
 197                                                  gfloat         xalign);
 198 gfloat     gtk_entry_get_alignment              (GtkEntry      *entry);
 199
 200 void                gtk_entry_set_completion (GtkEntry           *entry,
 201                                               GtkEntryCompletion *completion);
 202 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry           *entry);
 203
 204 gint       gtk_entry_layout_index_to_text_index (GtkEntry      *entry,
 205                                                  gint           layout_index);
 206 gint       gtk_entry_text_index_to_layout_index (GtkEntry      *entry,
 207                                                  gint           text_index);
 208
 209 /* For scrolling cursor appropriately
 210  */
 211 void           gtk_entry_set_cursor_hadjustment (GtkEntry      *entry,
 212                                                  GtkAdjustment *adjustment);
 213 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry      *entry);
 214
 215 /* Deprecated compatibility functions
 216  */
 217
 218 #ifndef GTK_DISABLE_DEPRECATED
 219 GtkWidget* gtk_entry_new_with_max_length        (gint           max);
 220 void       gtk_entry_append_text                (GtkEntry      *entry,
 221                                                  const gchar   *text);
 222 void       gtk_entry_prepend_text               (GtkEntry      *entry,
 223                                                  const gchar   *text);
 224 void       gtk_entry_set_position               (GtkEntry      *entry,
 225                                                  gint           position);
 226 void       gtk_entry_select_region              (GtkEntry      *entry,
 227                                                  gint           start,
 228                                                  gint           end);
 229 void       gtk_entry_set_editable               (GtkEntry      *entry,
 230                                                  gboolean       editable);
 231 #endif /* GTK_DISABLE_DEPRECATED */
 232
 233 G_END_DECLS
 234
 235 #endif /* __GTK_ENTRY_H__ */