1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * Copyright (C) 2004-2006 Christian Hammond
5 * Copyright (C) 2008 Cody Russell
6 * Copyright (C) 2008 Red Hat, Inc.
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.
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.
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.
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/.
31 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
32 #error "Only <gtk/gtk.h> can be included directly."
35 #ifndef __GTK_ENTRY_H__
36 #define __GTK_ENTRY_H__
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>
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))
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).
62 * Specifies the side of the entry at which an icon is placed.
68 GTK_ENTRY_ICON_PRIMARY,
69 GTK_ENTRY_ICON_SECONDARY
70 } GtkEntryIconPosition;
72 typedef struct _GtkEntry GtkEntry;
73 typedef struct _GtkEntryPrivate GtkEntryPrivate;
74 typedef struct _GtkEntryClass GtkEntryClass;
79 GtkWidget parent_instance;
81 GtkEntryPrivate *priv;
86 GtkWidgetClass parent_class;
88 /* Hook to customize right-click popup */
89 void (* populate_popup) (GtkEntry *entry,
94 void (* activate) (GtkEntry *entry);
95 void (* move_cursor) (GtkEntry *entry,
98 gboolean extend_selection);
99 void (* insert_at_cursor) (GtkEntry *entry,
101 void (* delete_from_cursor) (GtkEntry *entry,
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);
110 /* hook to add other objects beside the entry (like in GtkSpinButton) */
111 void (* get_text_area_size) (GtkEntry *entry,
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);
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);
132 GtkEntryBuffer* gtk_entry_get_buffer (GtkEntry *entry);
133 void gtk_entry_set_buffer (GtkEntry *entry,
134 GtkEntryBuffer *buffer);
136 void gtk_entry_get_text_area (GtkEntry *entry,
137 GdkRectangle *text_area);
139 void gtk_entry_set_visibility (GtkEntry *entry,
141 gboolean gtk_entry_get_visibility (GtkEntry *entry);
143 void gtk_entry_set_invisible_char (GtkEntry *entry,
145 gunichar gtk_entry_get_invisible_char (GtkEntry *entry);
146 void gtk_entry_unset_invisible_char (GtkEntry *entry);
148 void gtk_entry_set_has_frame (GtkEntry *entry,
150 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
152 GDK_DEPRECATED_IN_3_4
153 void gtk_entry_set_inner_border (GtkEntry *entry,
154 const GtkBorder *border);
155 GDK_DEPRECATED_IN_3_4
156 const GtkBorder* gtk_entry_get_inner_border (GtkEntry *entry);
158 void gtk_entry_set_overwrite_mode (GtkEntry *entry,
160 gboolean gtk_entry_get_overwrite_mode (GtkEntry *entry);
162 /* text is truncated if needed */
163 void gtk_entry_set_max_length (GtkEntry *entry,
165 gint gtk_entry_get_max_length (GtkEntry *entry);
166 guint16 gtk_entry_get_text_length (GtkEntry *entry);
168 void gtk_entry_set_activates_default (GtkEntry *entry,
170 gboolean gtk_entry_get_activates_default (GtkEntry *entry);
172 void gtk_entry_set_width_chars (GtkEntry *entry,
174 gint gtk_entry_get_width_chars (GtkEntry *entry);
176 /* Somewhat more convenient than the GtkEditable generic functions
178 void gtk_entry_set_text (GtkEntry *entry,
180 /* returns a reference to the text */
181 const gchar* gtk_entry_get_text (GtkEntry *entry);
183 PangoLayout* gtk_entry_get_layout (GtkEntry *entry);
184 void gtk_entry_get_layout_offsets (GtkEntry *entry,
187 void gtk_entry_set_alignment (GtkEntry *entry,
189 gfloat gtk_entry_get_alignment (GtkEntry *entry);
191 void gtk_entry_set_completion (GtkEntry *entry,
192 GtkEntryCompletion *completion);
193 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry *entry);
195 gint gtk_entry_layout_index_to_text_index (GtkEntry *entry,
197 gint gtk_entry_text_index_to_layout_index (GtkEntry *entry,
200 /* For scrolling cursor appropriately
202 void gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
203 GtkAdjustment *adjustment);
204 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry *entry);
208 void gtk_entry_set_progress_fraction (GtkEntry *entry,
210 gdouble gtk_entry_get_progress_fraction (GtkEntry *entry);
212 void gtk_entry_set_progress_pulse_step (GtkEntry *entry,
214 gdouble gtk_entry_get_progress_pulse_step (GtkEntry *entry);
216 void gtk_entry_progress_pulse (GtkEntry *entry);
218 const gchar* gtk_entry_get_placeholder_text (GtkEntry *entry);
220 void gtk_entry_set_placeholder_text (GtkEntry *entry,
222 /* Setting and managing icons
224 void gtk_entry_set_icon_from_pixbuf (GtkEntry *entry,
225 GtkEntryIconPosition icon_pos,
227 void gtk_entry_set_icon_from_stock (GtkEntry *entry,
228 GtkEntryIconPosition icon_pos,
229 const gchar *stock_id);
230 void gtk_entry_set_icon_from_icon_name (GtkEntry *entry,
231 GtkEntryIconPosition icon_pos,
232 const gchar *icon_name);
233 void gtk_entry_set_icon_from_gicon (GtkEntry *entry,
234 GtkEntryIconPosition icon_pos,
236 GtkImageType gtk_entry_get_icon_storage_type (GtkEntry *entry,
237 GtkEntryIconPosition icon_pos);
238 GdkPixbuf* gtk_entry_get_icon_pixbuf (GtkEntry *entry,
239 GtkEntryIconPosition icon_pos);
240 const gchar* gtk_entry_get_icon_stock (GtkEntry *entry,
241 GtkEntryIconPosition icon_pos);
242 const gchar* gtk_entry_get_icon_name (GtkEntry *entry,
243 GtkEntryIconPosition icon_pos);
244 GIcon* gtk_entry_get_icon_gicon (GtkEntry *entry,
245 GtkEntryIconPosition icon_pos);
246 void gtk_entry_set_icon_activatable (GtkEntry *entry,
247 GtkEntryIconPosition icon_pos,
248 gboolean activatable);
249 gboolean gtk_entry_get_icon_activatable (GtkEntry *entry,
250 GtkEntryIconPosition icon_pos);
251 void gtk_entry_set_icon_sensitive (GtkEntry *entry,
252 GtkEntryIconPosition icon_pos,
254 gboolean gtk_entry_get_icon_sensitive (GtkEntry *entry,
255 GtkEntryIconPosition icon_pos);
256 gint gtk_entry_get_icon_at_pos (GtkEntry *entry,
259 void gtk_entry_set_icon_tooltip_text (GtkEntry *entry,
260 GtkEntryIconPosition icon_pos,
261 const gchar *tooltip);
262 gchar * gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
263 GtkEntryIconPosition icon_pos);
264 void gtk_entry_set_icon_tooltip_markup (GtkEntry *entry,
265 GtkEntryIconPosition icon_pos,
266 const gchar *tooltip);
267 gchar * gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
268 GtkEntryIconPosition icon_pos);
269 void gtk_entry_set_icon_drag_source (GtkEntry *entry,
270 GtkEntryIconPosition icon_pos,
271 GtkTargetList *target_list,
272 GdkDragAction actions);
273 gint gtk_entry_get_current_icon_drag_source (GtkEntry *entry);
274 void gtk_entry_get_icon_area (GtkEntry *entry,
275 GtkEntryIconPosition icon_pos,
276 GdkRectangle *icon_area);
278 gboolean gtk_entry_im_context_filter_keypress (GtkEntry *entry,
280 void gtk_entry_reset_im_context (GtkEntry *entry);
285 #endif /* __GTK_ENTRY_H__ */