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  * Copyright (C) 2004-2006 Christian Hammond
   5  * Copyright (C) 2008 Cody Russell
   6  * Copyright (C) 2008 Red Hat, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /*
  25  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  26  * file for a list of people on the GTK+ Team.  See the ChangeLog
  27  * files for a list of changes.  These files are distributed with
  28  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  29  */
  30
  31 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  32 #error "Only <gtk/gtk.h> can be included directly."
  33 #endif
  34
  35 #ifndef __GTK_ENTRY_H__
  36 #define __GTK_ENTRY_H__
  37
  38
  39 #include <gtk/gtkeditable.h>
  40 #include <gtk/gtkimcontext.h>
  41 #include <gtk/gtkmenu.h>
  42 #include <gtk/gtkentrybuffer.h>
  43 #include <gtk/gtkentrycompletion.h>
  44 #include <gtk/gtkimage.h>
  45 #include <gtk/gtkselection.h>
  46
  47
  48 G_BEGIN_DECLS
  49
  50 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  51 #define GTK_ENTRY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  52 #define GTK_ENTRY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  53 #define GTK_IS_ENTRY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
  54 #define GTK_IS_ENTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  55 #define GTK_ENTRY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
  56
  57 /**
  58  * GtkEntryIconPosition:
  59  * @GTK_ENTRY_ICON_PRIMARY: At the beginning of the entry (depending on the text direction).
  60  * @GTK_ENTRY_ICON_SECONDARY: At the end of the entry (depending on the text direction).
  61  *
  62  * Specifies the side of the entry at which an icon is placed.
  63  *
  64  * Since: 2.16
  65  */
  66 typedef enum
  67 {
  68   GTK_ENTRY_ICON_PRIMARY,
  69   GTK_ENTRY_ICON_SECONDARY
  70 } GtkEntryIconPosition;
  71
  72 typedef struct _GtkEntry              GtkEntry;
  73 typedef struct _GtkEntryPrivate       GtkEntryPrivate;
  74 typedef struct _GtkEntryClass         GtkEntryClass;
  75
  76 struct _GtkEntry
  77 {
  78   /*< private >*/
  79   GtkWidget  parent_instance;
  80
  81   GtkEntryPrivate *priv;
  82 };
  83
  84 struct _GtkEntryClass
  85 {
  86   GtkWidgetClass parent_class;
  87
  88   /* Hook to customize right-click popup */
  89   void (* populate_popup)   (GtkEntry       *entry,
  90                              GtkMenu        *menu);
  91
  92   /* Action signals
  93    */
  94   void (* activate)           (GtkEntry             *entry);
  95   void (* move_cursor)        (GtkEntry             *entry,
  96                                GtkMovementStep       step,
  97                                gint                  count,
  98                                gboolean              extend_selection);
  99   void (* insert_at_cursor)   (GtkEntry             *entry,
 100                                const gchar          *str);
 101   void (* delete_from_cursor) (GtkEntry             *entry,
 102                                GtkDeleteType         type,
 103                                gint                  count);
 104   void (* backspace)          (GtkEntry             *entry);
 105   void (* cut_clipboard)      (GtkEntry             *entry);
 106   void (* copy_clipboard)     (GtkEntry             *entry);
 107   void (* paste_clipboard)    (GtkEntry             *entry);
 108   void (* toggle_overwrite)   (GtkEntry             *entry);
 109
 110   /* hook to add other objects beside the entry (like in GtkSpinButton) */
 111   void (* get_text_area_size) (GtkEntry       *entry,
 112                                gint           *x,
 113                                gint           *y,
 114                                gint           *width,
 115                                gint           *height);
 116
 117   /* Padding for future expansion */
 118   void (*_gtk_reserved1)      (void);
 119   void (*_gtk_reserved2)      (void);
 120   void (*_gtk_reserved3)      (void);
 121   void (*_gtk_reserved4)      (void);
 122   void (*_gtk_reserved5)      (void);
 123   void (*_gtk_reserved6)      (void);
 124   void (*_gtk_reserved7)      (void);
 125   void (*_gtk_reserved8)      (void);
 126 };
 127
 128 GType      gtk_entry_get_type                   (void) G_GNUC_CONST;
 129 GtkWidget* gtk_entry_new                        (void);
 130 GtkWidget* gtk_entry_new_with_buffer            (GtkEntryBuffer *buffer);
 131
 132 GtkEntryBuffer* gtk_entry_get_buffer            (GtkEntry       *entry);
 133 void       gtk_entry_set_buffer                 (GtkEntry       *entry,
 134                                                  GtkEntryBuffer *buffer);
 135
 136 void       gtk_entry_get_text_area              (GtkEntry       *entry,
 137                                                  GdkRectangle   *text_area);
 138
 139 void       gtk_entry_set_visibility             (GtkEntry      *entry,
 140                                                  gboolean       visible);
 141 gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
 142
 143 void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
 144                                                  gunichar       ch);
 145 gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
 146 void       gtk_entry_unset_invisible_char       (GtkEntry      *entry);
 147
 148 void       gtk_entry_set_has_frame              (GtkEntry      *entry,
 149                                                  gboolean       setting);
 150 gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
 151
 152 void       gtk_entry_set_inner_border                (GtkEntry        *entry,
 153                                                       const GtkBorder *border);
 154 G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry        *entry);
 155
 156 void       gtk_entry_set_overwrite_mode         (GtkEntry      *entry,
 157                                                  gboolean       overwrite);
 158 gboolean   gtk_entry_get_overwrite_mode         (GtkEntry      *entry);
 159
 160 /* text is truncated if needed */
 161 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 162                                                  gint           max);
 163 gint       gtk_entry_get_max_length             (GtkEntry      *entry);
 164 guint16    gtk_entry_get_text_length            (GtkEntry      *entry);
 165
 166 void       gtk_entry_set_activates_default      (GtkEntry      *entry,
 167                                                  gboolean       setting);
 168 gboolean   gtk_entry_get_activates_default      (GtkEntry      *entry);
 169
 170 void       gtk_entry_set_width_chars            (GtkEntry      *entry,
 171                                                  gint           n_chars);
 172 gint       gtk_entry_get_width_chars            (GtkEntry      *entry);
 173
 174 /* Somewhat more convenient than the GtkEditable generic functions
 175  */
 176 void       gtk_entry_set_text                   (GtkEntry      *entry,
 177                                                  const gchar   *text);
 178 /* returns a reference to the text */
 179 G_CONST_RETURN gchar* gtk_entry_get_text        (GtkEntry      *entry);
 180
 181 PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
 182 void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
 183                                                  gint          *x,
 184                                                  gint          *y);
 185 void       gtk_entry_set_alignment              (GtkEntry      *entry,
 186                                                  gfloat         xalign);
 187 gfloat     gtk_entry_get_alignment              (GtkEntry      *entry);
 188
 189 void                gtk_entry_set_completion (GtkEntry           *entry,
 190                                               GtkEntryCompletion *completion);
 191 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry           *entry);
 192
 193 gint       gtk_entry_layout_index_to_text_index (GtkEntry      *entry,
 194                                                  gint           layout_index);
 195 gint       gtk_entry_text_index_to_layout_index (GtkEntry      *entry,
 196                                                  gint           text_index);
 197
 198 /* For scrolling cursor appropriately
 199  */
 200 void           gtk_entry_set_cursor_hadjustment (GtkEntry      *entry,
 201                                                  GtkAdjustment *adjustment);
 202 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry      *entry);
 203
 204 /* Progress API
 205  */
 206 void           gtk_entry_set_progress_fraction   (GtkEntry     *entry,
 207                                                   gdouble       fraction);
 208 gdouble        gtk_entry_get_progress_fraction   (GtkEntry     *entry);
 209
 210 void           gtk_entry_set_progress_pulse_step (GtkEntry     *entry,
 211                                                   gdouble       fraction);
 212 gdouble        gtk_entry_get_progress_pulse_step (GtkEntry     *entry);
 213
 214 void           gtk_entry_progress_pulse          (GtkEntry     *entry);
 215
 216 G_CONST_RETURN gchar* gtk_entry_get_placeholder_text     (GtkEntry             *entry);
 217
 218 void           gtk_entry_set_placeholder_text            (GtkEntry             *entry,
 219                                                           const gchar          *text);
 220 /* Setting and managing icons
 221  */
 222 void           gtk_entry_set_icon_from_pixbuf            (GtkEntry             *entry,
 223                                                           GtkEntryIconPosition  icon_pos,
 224                                                           GdkPixbuf            *pixbuf);
 225 void           gtk_entry_set_icon_from_stock             (GtkEntry             *entry,
 226                                                           GtkEntryIconPosition  icon_pos,
 227                                                           const gchar          *stock_id);
 228 void           gtk_entry_set_icon_from_icon_name         (GtkEntry             *entry,
 229                                                           GtkEntryIconPosition  icon_pos,
 230                                                           const gchar          *icon_name);
 231 void           gtk_entry_set_icon_from_gicon             (GtkEntry             *entry,
 232                                                           GtkEntryIconPosition  icon_pos,
 233                                                           GIcon                *icon);
 234 GtkImageType gtk_entry_get_icon_storage_type             (GtkEntry             *entry,
 235                                                           GtkEntryIconPosition  icon_pos);
 236 GdkPixbuf*   gtk_entry_get_icon_pixbuf                   (GtkEntry             *entry,
 237                                                           GtkEntryIconPosition  icon_pos);
 238 const gchar* gtk_entry_get_icon_stock                    (GtkEntry             *entry,
 239                                                           GtkEntryIconPosition  icon_pos);
 240 const gchar* gtk_entry_get_icon_name                     (GtkEntry             *entry,
 241                                                           GtkEntryIconPosition  icon_pos);
 242 GIcon*       gtk_entry_get_icon_gicon                    (GtkEntry             *entry,
 243                                                           GtkEntryIconPosition  icon_pos);
 244 void         gtk_entry_set_icon_activatable              (GtkEntry             *entry,
 245                                                           GtkEntryIconPosition  icon_pos,
 246                                                           gboolean              activatable);
 247 gboolean     gtk_entry_get_icon_activatable              (GtkEntry             *entry,
 248                                                           GtkEntryIconPosition  icon_pos);
 249 void         gtk_entry_set_icon_sensitive                (GtkEntry             *entry,
 250                                                           GtkEntryIconPosition  icon_pos,
 251                                                           gboolean              sensitive);
 252 gboolean     gtk_entry_get_icon_sensitive                (GtkEntry             *entry,
 253                                                           GtkEntryIconPosition  icon_pos);
 254 gint         gtk_entry_get_icon_at_pos                   (GtkEntry             *entry,
 255                                                           gint                  x,
 256                                                           gint                  y);
 257 void         gtk_entry_set_icon_tooltip_text             (GtkEntry             *entry,
 258                                                           GtkEntryIconPosition  icon_pos,
 259                                                           const gchar          *tooltip);
 260 gchar *      gtk_entry_get_icon_tooltip_text             (GtkEntry             *entry,
 261                                                           GtkEntryIconPosition  icon_pos);
 262 void         gtk_entry_set_icon_tooltip_markup           (GtkEntry             *entry,
 263                                                           GtkEntryIconPosition  icon_pos,
 264                                                           const gchar          *tooltip);
 265 gchar *      gtk_entry_get_icon_tooltip_markup           (GtkEntry             *entry,
 266                                                           GtkEntryIconPosition  icon_pos);
 267 void         gtk_entry_set_icon_drag_source              (GtkEntry             *entry,
 268                                                           GtkEntryIconPosition  icon_pos,
 269                                                           GtkTargetList        *target_list,
 270                                                           GdkDragAction         actions);
 271 gint         gtk_entry_get_current_icon_drag_source      (GtkEntry             *entry);
 272 void         gtk_entry_get_icon_area                     (GtkEntry             *entry,
 273                                                           GtkEntryIconPosition  icon_pos,
 274                                                           GdkRectangle         *icon_area);
 275
 276 gboolean    gtk_entry_im_context_filter_keypress         (GtkEntry             *entry,
 277                                                           GdkEventKey          *event);
 278 void        gtk_entry_reset_im_context                   (GtkEntry             *entry);
 279
 280
 281 G_END_DECLS
 282
 283 #endif /* __GTK_ENTRY_H__ */