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