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, see <http://www.gnu.org/licenses/>.
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/.
29 #ifndef __GTK_ENTRY_H__
30 #define __GTK_ENTRY_H__
33 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
34 #error "Only <gtk/gtk.h> can be included directly."
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>
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))
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).
60 * Specifies the side of the entry at which an icon is placed.
66 GTK_ENTRY_ICON_PRIMARY,
67 GTK_ENTRY_ICON_SECONDARY
68 } GtkEntryIconPosition;
70 typedef struct _GtkEntry GtkEntry;
71 typedef struct _GtkEntryPrivate GtkEntryPrivate;
72 typedef struct _GtkEntryClass GtkEntryClass;
77 GtkWidget parent_instance;
79 GtkEntryPrivate *priv;
84 GtkWidgetClass parent_class;
86 /* Hook to customize right-click popup */
87 void (* populate_popup) (GtkEntry *entry,
92 void (* activate) (GtkEntry *entry);
93 void (* move_cursor) (GtkEntry *entry,
96 gboolean extend_selection);
97 void (* insert_at_cursor) (GtkEntry *entry,
99 void (* delete_from_cursor) (GtkEntry *entry,
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);
108 /* hooks to add other objects beside the entry (like in GtkSpinButton) */
109 void (* get_text_area_size) (GtkEntry *entry,
114 void (* get_frame_size) (GtkEntry *entry,
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);
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);
134 GtkEntryBuffer* gtk_entry_get_buffer (GtkEntry *entry);
135 void gtk_entry_set_buffer (GtkEntry *entry,
136 GtkEntryBuffer *buffer);
138 void gtk_entry_get_text_area (GtkEntry *entry,
139 GdkRectangle *text_area);
141 void gtk_entry_set_visibility (GtkEntry *entry,
143 gboolean gtk_entry_get_visibility (GtkEntry *entry);
145 void gtk_entry_set_invisible_char (GtkEntry *entry,
147 gunichar gtk_entry_get_invisible_char (GtkEntry *entry);
148 void gtk_entry_unset_invisible_char (GtkEntry *entry);
150 void gtk_entry_set_has_frame (GtkEntry *entry,
152 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
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);
160 void gtk_entry_set_overwrite_mode (GtkEntry *entry,
162 gboolean gtk_entry_get_overwrite_mode (GtkEntry *entry);
164 /* text is truncated if needed */
165 void gtk_entry_set_max_length (GtkEntry *entry,
167 gint gtk_entry_get_max_length (GtkEntry *entry);
168 guint16 gtk_entry_get_text_length (GtkEntry *entry);
170 void gtk_entry_set_activates_default (GtkEntry *entry,
172 gboolean gtk_entry_get_activates_default (GtkEntry *entry);
174 void gtk_entry_set_width_chars (GtkEntry *entry,
176 gint gtk_entry_get_width_chars (GtkEntry *entry);
178 /* Somewhat more convenient than the GtkEditable generic functions
180 void gtk_entry_set_text (GtkEntry *entry,
182 /* returns a reference to the text */
183 const gchar* gtk_entry_get_text (GtkEntry *entry);
185 PangoLayout* gtk_entry_get_layout (GtkEntry *entry);
186 void gtk_entry_get_layout_offsets (GtkEntry *entry,
189 void gtk_entry_set_alignment (GtkEntry *entry,
191 gfloat gtk_entry_get_alignment (GtkEntry *entry);
193 void gtk_entry_set_completion (GtkEntry *entry,
194 GtkEntryCompletion *completion);
195 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry *entry);
197 gint gtk_entry_layout_index_to_text_index (GtkEntry *entry,
199 gint gtk_entry_text_index_to_layout_index (GtkEntry *entry,
202 /* For scrolling cursor appropriately
204 void gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
205 GtkAdjustment *adjustment);
206 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry *entry);
210 void gtk_entry_set_progress_fraction (GtkEntry *entry,
212 gdouble gtk_entry_get_progress_fraction (GtkEntry *entry);
214 void gtk_entry_set_progress_pulse_step (GtkEntry *entry,
216 gdouble gtk_entry_get_progress_pulse_step (GtkEntry *entry);
218 void gtk_entry_progress_pulse (GtkEntry *entry);
220 const gchar* gtk_entry_get_placeholder_text (GtkEntry *entry);
222 void gtk_entry_set_placeholder_text (GtkEntry *entry,
224 /* Setting and managing icons
226 void gtk_entry_set_icon_from_pixbuf (GtkEntry *entry,
227 GtkEntryIconPosition icon_pos,
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,
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,
256 gboolean gtk_entry_get_icon_sensitive (GtkEntry *entry,
257 GtkEntryIconPosition icon_pos);
258 gint gtk_entry_get_icon_at_pos (GtkEntry *entry,
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);
280 gboolean gtk_entry_im_context_filter_keypress (GtkEntry *entry,
282 void gtk_entry_reset_im_context (GtkEntry *entry);
285 void gtk_entry_set_input_purpose (GtkEntry *entry,
286 GtkInputPurpose purpose);
288 GtkInputPurpose gtk_entry_get_input_purpose (GtkEntry *entry);
291 void gtk_entry_set_input_hints (GtkEntry *entry,
292 GtkInputHints hints);
294 GtkInputHints gtk_entry_get_input_hints (GtkEntry *entry);
297 void gtk_entry_set_attributes (GtkEntry *entry,
298 PangoAttrList *attrs);
300 PangoAttrList *gtk_entry_get_attributes (GtkEntry *entry);
304 #endif /* __GTK_ENTRY_H__ */