gtkentry.h 13.7 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
4 5 6 7
 * Copyright (C) 2004-2006 Christian Hammond
 * Copyright (C) 2008 Cody Russell
 * Copyright (C) 2008 Red Hat, Inc.
 *
Elliot Lee's avatar
Elliot Lee committed
8
 * This library is free software; you can redistribute it and/or
9
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
10 11 12 13 14 15
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
17
 *
18
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
19
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
20
 */
21 22

/*
23
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
24 25
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
26
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 28
 */

Elliot Lee's avatar
Elliot Lee committed
29 30 31 32
#ifndef __GTK_ENTRY_H__
#define __GTK_ENTRY_H__


33 34 35 36
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

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 43
#include <gtk/gtkimage.h>
#include <gtk/gtkselection.h>
Elliot Lee's avatar
Elliot Lee committed
44

45

46
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
47

48
#define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
Manish Singh's avatar
Manish Singh committed
49 50 51 52 53
#define GTK_ENTRY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
#define GTK_ENTRY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
#define GTK_IS_ENTRY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
#define GTK_IS_ENTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
#define GTK_ENTRY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
Elliot Lee's avatar
Elliot Lee committed
54

55 56 57 58 59 60 61 62 63
/**
 * GtkEntryIconPosition:
 * @GTK_ENTRY_ICON_PRIMARY: At the beginning of the entry (depending on the text direction).
 * @GTK_ENTRY_ICON_SECONDARY: At the end of the entry (depending on the text direction).
 *
 * Specifies the side of the entry at which an icon is placed.
 *
 * Since: 2.16
 */
64 65 66 67 68
typedef enum
{
  GTK_ENTRY_ICON_PRIMARY,
  GTK_ENTRY_ICON_SECONDARY
} GtkEntryIconPosition;
Elliot Lee's avatar
Elliot Lee committed
69

70 71 72
typedef struct _GtkEntry              GtkEntry;
typedef struct _GtkEntryPrivate       GtkEntryPrivate;
typedef struct _GtkEntryClass         GtkEntryClass;
Elliot Lee's avatar
Elliot Lee committed
73 74 75

struct _GtkEntry
{
76
  /*< private >*/
77
  GtkWidget  parent_instance;
Tim Janik's avatar
Tim Janik committed
78

79
  GtkEntryPrivate *priv;
Elliot Lee's avatar
Elliot Lee committed
80 81 82 83
};

struct _GtkEntryClass
{
Owen Taylor's avatar
Owen Taylor committed
84 85
  GtkWidgetClass parent_class;

86 87
  /* Hook to customize right-click popup */
  void (* populate_popup)   (GtkEntry       *entry,
88
                             GtkWidget      *popup);
89

Owen Taylor's avatar
Owen Taylor committed
90 91
  /* Action signals
   */
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
  void (* activate)           (GtkEntry             *entry);
  void (* move_cursor)        (GtkEntry             *entry,
			       GtkMovementStep       step,
			       gint                  count,
			       gboolean              extend_selection);
  void (* insert_at_cursor)   (GtkEntry             *entry,
			       const gchar          *str);
  void (* delete_from_cursor) (GtkEntry             *entry,
			       GtkDeleteType         type,
			       gint                  count);
  void (* backspace)          (GtkEntry             *entry);
  void (* cut_clipboard)      (GtkEntry             *entry);
  void (* copy_clipboard)     (GtkEntry             *entry);
  void (* paste_clipboard)    (GtkEntry             *entry);
  void (* toggle_overwrite)   (GtkEntry             *entry);
107

108
  /* hooks to add other objects beside the entry (like in GtkSpinButton) */
109 110 111 112 113
  void (* get_text_area_size) (GtkEntry       *entry,
			       gint           *x,
			       gint           *y,
			       gint           *width,
			       gint           *height);
114 115 116 117 118
  void (* get_frame_size)     (GtkEntry       *entry,
                               gint           *x,
                               gint           *y,
			       gint           *width,
			       gint           *height);
119

120
  /* Padding for future expansion */
121 122
  void (*_gtk_reserved1)      (void);
  void (*_gtk_reserved2)      (void);
123 124 125 126 127
  void (*_gtk_reserved3)      (void);
  void (*_gtk_reserved4)      (void);
  void (*_gtk_reserved5)      (void);
  void (*_gtk_reserved6)      (void);
  void (*_gtk_reserved7)      (void);
Elliot Lee's avatar
Elliot Lee committed
128 129
};

Manish Singh's avatar
Manish Singh committed
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 135 136
GtkEntryBuffer* gtk_entry_get_buffer            (GtkEntry       *entry);
void       gtk_entry_set_buffer                 (GtkEntry       *entry,
                                                 GtkEntryBuffer *buffer);
137

138 139 140
void       gtk_entry_get_text_area              (GtkEntry       *entry,
                                                 GdkRectangle   *text_area);

Owen Taylor's avatar
Owen Taylor committed
141 142
void       gtk_entry_set_visibility 		(GtkEntry      *entry,
						 gboolean       visible);
143
gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
144

145 146
void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
                                                 gunichar       ch);
147
gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
148
void       gtk_entry_unset_invisible_char       (GtkEntry      *entry);
149

150 151 152
void       gtk_entry_set_has_frame              (GtkEntry      *entry,
                                                 gboolean       setting);
gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
153

154
GDK_DEPRECATED_IN_3_4
155 156
void             gtk_entry_set_inner_border     (GtkEntry        *entry,
                                                 const GtkBorder *border);
157
GDK_DEPRECATED_IN_3_4
158
const GtkBorder* gtk_entry_get_inner_border     (GtkEntry        *entry);
159

Tim Janik's avatar
Tim Janik committed
160 161 162
void       gtk_entry_set_overwrite_mode         (GtkEntry      *entry,
                                                 gboolean       overwrite);
gboolean   gtk_entry_get_overwrite_mode         (GtkEntry      *entry);
163

Owen Taylor's avatar
Owen Taylor committed
164 165
/* text is truncated if needed */
void       gtk_entry_set_max_length 		(GtkEntry      *entry,
Havoc Pennington's avatar
Havoc Pennington committed
166
						 gint           max);
167
gint       gtk_entry_get_max_length             (GtkEntry      *entry);
Tim Janik's avatar
Tim Janik committed
168
guint16    gtk_entry_get_text_length            (GtkEntry      *entry);
169

170 171 172
void       gtk_entry_set_activates_default      (GtkEntry      *entry,
                                                 gboolean       setting);
gboolean   gtk_entry_get_activates_default      (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
173

174 175 176 177
void       gtk_entry_set_width_chars            (GtkEntry      *entry,
                                                 gint           n_chars);
gint       gtk_entry_get_width_chars            (GtkEntry      *entry);

Owen Taylor's avatar
Owen Taylor committed
178 179
/* Somewhat more convenient than the GtkEditable generic functions
 */
180
void       gtk_entry_set_text                   (GtkEntry      *entry,
181
                                                 const gchar   *text);
Owen Taylor's avatar
Owen Taylor committed
182
/* returns a reference to the text */
183
const gchar* gtk_entry_get_text        (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
184

185 186 187 188
PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
                                                 gint          *x,
                                                 gint          *y);
189 190 191
void       gtk_entry_set_alignment              (GtkEntry      *entry,
                                                 gfloat         xalign);
gfloat     gtk_entry_get_alignment              (GtkEntry      *entry);
192

193 194 195 196
void                gtk_entry_set_completion (GtkEntry           *entry,
                                              GtkEntryCompletion *completion);
GtkEntryCompletion *gtk_entry_get_completion (GtkEntry           *entry);

197 198 199 200 201
gint       gtk_entry_layout_index_to_text_index (GtkEntry      *entry,
                                                 gint           layout_index);
gint       gtk_entry_text_index_to_layout_index (GtkEntry      *entry,
                                                 gint           text_index);

202
/* For scrolling cursor appropriately
203 204 205 206
 */
void           gtk_entry_set_cursor_hadjustment (GtkEntry      *entry,
                                                 GtkAdjustment *adjustment);
GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry      *entry);
207

208 209 210 211 212 213 214 215 216 217 218
/* Progress API
 */
void           gtk_entry_set_progress_fraction   (GtkEntry     *entry,
                                                  gdouble       fraction);
gdouble        gtk_entry_get_progress_fraction   (GtkEntry     *entry);

void           gtk_entry_set_progress_pulse_step (GtkEntry     *entry,
                                                  gdouble       fraction);
gdouble        gtk_entry_get_progress_pulse_step (GtkEntry     *entry);

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 223
void           gtk_entry_set_placeholder_text    (GtkEntry             *entry,
                                                  const gchar          *text);
224 225 226 227 228 229 230 231 232 233 234 235 236 237
/* Setting and managing icons
 */
void           gtk_entry_set_icon_from_pixbuf            (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  GdkPixbuf            *pixbuf);
void           gtk_entry_set_icon_from_stock             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *stock_id);
void           gtk_entry_set_icon_from_icon_name         (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *icon_name);
void           gtk_entry_set_icon_from_gicon             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  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 244 245
							  GtkEntryIconPosition  icon_pos);
const gchar* gtk_entry_get_icon_name                     (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
246
GIcon*       gtk_entry_get_icon_gicon                    (GtkEntry             *entry,
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
							  GtkEntryIconPosition  icon_pos);
void         gtk_entry_set_icon_activatable              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  gboolean              activatable);
gboolean     gtk_entry_get_icon_activatable              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
void         gtk_entry_set_icon_sensitive                (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  gboolean              sensitive);
gboolean     gtk_entry_get_icon_sensitive                (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
gint         gtk_entry_get_icon_at_pos                   (GtkEntry             *entry,
							  gint                  x,
							  gint                  y);
void         gtk_entry_set_icon_tooltip_text             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *tooltip);
264 265
gchar *      gtk_entry_get_icon_tooltip_text             (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos);
266 267 268
void         gtk_entry_set_icon_tooltip_markup           (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *tooltip);
269 270
gchar *      gtk_entry_get_icon_tooltip_markup           (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos);
271 272 273 274 275
void         gtk_entry_set_icon_drag_source              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  GtkTargetList        *target_list,
							  GdkDragAction         actions);
gint         gtk_entry_get_current_icon_drag_source      (GtkEntry             *entry);
276 277 278
void         gtk_entry_get_icon_area                     (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos,
                                                          GdkRectangle         *icon_area);
279

280
gboolean    gtk_entry_im_context_filter_keypress         (GtkEntry             *entry,
281
                                                          GdkEventKey          *event);
282 283
void        gtk_entry_reset_im_context                   (GtkEntry             *entry);

284 285 286 287 288 289 290 291 292 293 294 295
GDK_AVAILABLE_IN_3_6
void            gtk_entry_set_input_purpose                  (GtkEntry             *entry,
                                                              GtkInputPurpose       purpose);
GDK_AVAILABLE_IN_3_6
GtkInputPurpose gtk_entry_get_input_purpose                  (GtkEntry             *entry);

GDK_AVAILABLE_IN_3_6
void            gtk_entry_set_input_hints                    (GtkEntry             *entry,
                                                              GtkInputHints         hints);
GDK_AVAILABLE_IN_3_6
GtkInputHints   gtk_entry_get_input_hints                    (GtkEntry             *entry);

296 297 298 299 300
GDK_AVAILABLE_IN_3_6
void            gtk_entry_set_attributes                     (GtkEntry             *entry,
                                                              PangoAttrList        *attrs);
GDK_AVAILABLE_IN_3_6
PangoAttrList  *gtk_entry_get_attributes                     (GtkEntry             *entry);
301

302
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
303 304

#endif /* __GTK_ENTRY_H__ */