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_DISABLE_SINGLE_INCLUDES) && !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))
59 GTK_ENTRY_ICON_PRIMARY,
60 GTK_ENTRY_ICON_SECONDARY
61 } GtkEntryIconPosition;
63 typedef struct _GtkEntry GtkEntry;
64 typedef struct _GtkEntryClass GtkEntryClass;
70 gchar *GSEAL (text); /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
72 guint GSEAL (editable) : 1;
73 guint GSEAL (visible) : 1;
74 guint GSEAL (overwrite_mode) : 1;
75 guint GSEAL (in_drag) : 1; /* FIXME: Should be private?
76 Dragging within the selection */
78 guint16 GSEAL (text_length); /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
79 guint16 GSEAL (text_max_length); /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
82 GdkWindow *GSEAL (text_area);
83 GtkIMContext *GSEAL (im_context);
84 GtkWidget *GSEAL (popup_menu);
86 gint GSEAL (current_pos);
87 gint GSEAL (selection_bound);
89 PangoLayout *GSEAL (cached_layout);
91 guint GSEAL (cache_includes_preedit) : 1;
92 guint GSEAL (need_im_reset) : 1;
93 guint GSEAL (has_frame) : 1;
94 guint GSEAL (activates_default) : 1;
95 guint GSEAL (cursor_visible) : 1;
96 guint GSEAL (in_click) : 1; /* Flag so we don't select all when clicking in entry to focus in */
97 guint GSEAL (is_cell_renderer) : 1;
98 guint GSEAL (editing_canceled) : 1; /* Only used by GtkCellRendererText */
99 guint GSEAL (mouse_cursor_obscured) : 1;
100 guint GSEAL (select_words) : 1;
101 guint GSEAL (select_lines) : 1;
102 guint GSEAL (resolved_dir) : 4; /* PangoDirection */
103 guint GSEAL (truncate_multiline) : 1;
105 guint GSEAL (button);
106 guint GSEAL (blink_timeout);
107 guint GSEAL (recompute_idle);
108 gint GSEAL (scroll_offset);
109 gint GSEAL (ascent); /* font ascent in pango units */
110 gint GSEAL (descent); /* font descent in pango units */
112 guint16 GSEAL (x_text_size); /* allocated size, in bytes */
113 guint16 GSEAL (x_n_bytes); /* length in use, in bytes */
115 guint16 GSEAL (preedit_length); /* length of preedit string, in bytes */
116 guint16 GSEAL (preedit_cursor); /* offset of cursor within preedit string, in chars */
118 gint GSEAL (dnd_position); /* In chars, -1 == no DND cursor */
120 gint GSEAL (drag_start_x);
121 gint GSEAL (drag_start_y);
123 gunichar GSEAL (invisible_char);
125 gint GSEAL (width_chars);
128 struct _GtkEntryClass
130 GtkWidgetClass parent_class;
132 /* Hook to customize right-click popup */
133 void (* populate_popup) (GtkEntry *entry,
138 void (* activate) (GtkEntry *entry);
139 void (* move_cursor) (GtkEntry *entry,
140 GtkMovementStep step,
142 gboolean extend_selection);
143 void (* insert_at_cursor) (GtkEntry *entry,
145 void (* delete_from_cursor) (GtkEntry *entry,
148 void (* backspace) (GtkEntry *entry);
149 void (* cut_clipboard) (GtkEntry *entry);
150 void (* copy_clipboard) (GtkEntry *entry);
151 void (* paste_clipboard) (GtkEntry *entry);
152 void (* toggle_overwrite) (GtkEntry *entry);
154 /* hook to add other objects beside the entry (like in GtkSpinButton) */
155 void (* get_text_area_size) (GtkEntry *entry,
161 /* Padding for future expansion */
162 void (*_gtk_reserved1) (void);
163 void (*_gtk_reserved2) (void);
166 GType gtk_entry_get_type (void) G_GNUC_CONST;
167 GtkWidget* gtk_entry_new (void);
168 GtkWidget* gtk_entry_new_with_buffer (GtkEntryBuffer *buffer);
169 GtkEntryBuffer* gtk_entry_get_buffer (GtkEntry *entry);
170 void gtk_entry_set_buffer (GtkEntry *entry,
171 GtkEntryBuffer *buffer);
172 void gtk_entry_set_visibility (GtkEntry *entry,
174 gboolean gtk_entry_get_visibility (GtkEntry *entry);
175 void gtk_entry_set_invisible_char (GtkEntry *entry,
177 gunichar gtk_entry_get_invisible_char (GtkEntry *entry);
178 void gtk_entry_unset_invisible_char (GtkEntry *entry);
179 void gtk_entry_set_has_frame (GtkEntry *entry,
181 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
182 void gtk_entry_set_inner_border (GtkEntry *entry,
183 const GtkBorder *border);
184 G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry *entry);
185 void gtk_entry_set_overwrite_mode (GtkEntry *entry,
187 gboolean gtk_entry_get_overwrite_mode (GtkEntry *entry);
188 /* text is truncated if needed */
189 void gtk_entry_set_max_length (GtkEntry *entry,
191 gint gtk_entry_get_max_length (GtkEntry *entry);
192 guint16 gtk_entry_get_text_length (GtkEntry *entry);
193 void gtk_entry_set_activates_default (GtkEntry *entry,
195 gboolean gtk_entry_get_activates_default (GtkEntry *entry);
197 void gtk_entry_set_width_chars (GtkEntry *entry,
199 gint gtk_entry_get_width_chars (GtkEntry *entry);
201 /* Somewhat more convenient than the GtkEditable generic functions
203 void gtk_entry_set_text (GtkEntry *entry,
205 /* returns a reference to the text */
206 G_CONST_RETURN gchar* gtk_entry_get_text (GtkEntry *entry);
208 PangoLayout* gtk_entry_get_layout (GtkEntry *entry);
209 void gtk_entry_get_layout_offsets (GtkEntry *entry,
212 void gtk_entry_set_alignment (GtkEntry *entry,
214 gfloat gtk_entry_get_alignment (GtkEntry *entry);
216 void gtk_entry_set_completion (GtkEntry *entry,
217 GtkEntryCompletion *completion);
218 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry *entry);
220 gint gtk_entry_layout_index_to_text_index (GtkEntry *entry,
222 gint gtk_entry_text_index_to_layout_index (GtkEntry *entry,
225 /* For scrolling cursor appropriately
227 void gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
228 GtkAdjustment *adjustment);
229 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry *entry);
233 void gtk_entry_set_progress_fraction (GtkEntry *entry,
235 gdouble gtk_entry_get_progress_fraction (GtkEntry *entry);
237 void gtk_entry_set_progress_pulse_step (GtkEntry *entry,
239 gdouble gtk_entry_get_progress_pulse_step (GtkEntry *entry);
241 void gtk_entry_progress_pulse (GtkEntry *entry);
243 /* Setting and managing icons
245 void gtk_entry_set_icon_from_pixbuf (GtkEntry *entry,
246 GtkEntryIconPosition icon_pos,
248 void gtk_entry_set_icon_from_stock (GtkEntry *entry,
249 GtkEntryIconPosition icon_pos,
250 const gchar *stock_id);
251 void gtk_entry_set_icon_from_icon_name (GtkEntry *entry,
252 GtkEntryIconPosition icon_pos,
253 const gchar *icon_name);
254 void gtk_entry_set_icon_from_gicon (GtkEntry *entry,
255 GtkEntryIconPosition icon_pos,
257 GtkImageType gtk_entry_get_icon_storage_type (GtkEntry *entry,
258 GtkEntryIconPosition icon_pos);
259 GdkPixbuf* gtk_entry_get_icon_pixbuf (GtkEntry *entry,
260 GtkEntryIconPosition icon_pos);
261 const gchar* gtk_entry_get_icon_stock (GtkEntry *entry,
262 GtkEntryIconPosition icon_pos);
263 const gchar* gtk_entry_get_icon_name (GtkEntry *entry,
264 GtkEntryIconPosition icon_pos);
265 GIcon* gtk_entry_get_icon_gicon (GtkEntry *entry,
266 GtkEntryIconPosition icon_pos);
267 void gtk_entry_set_icon_activatable (GtkEntry *entry,
268 GtkEntryIconPosition icon_pos,
269 gboolean activatable);
270 gboolean gtk_entry_get_icon_activatable (GtkEntry *entry,
271 GtkEntryIconPosition icon_pos);
272 void gtk_entry_set_icon_sensitive (GtkEntry *entry,
273 GtkEntryIconPosition icon_pos,
275 gboolean gtk_entry_get_icon_sensitive (GtkEntry *entry,
276 GtkEntryIconPosition icon_pos);
277 gint gtk_entry_get_icon_at_pos (GtkEntry *entry,
280 void gtk_entry_set_icon_tooltip_text (GtkEntry *entry,
281 GtkEntryIconPosition icon_pos,
282 const gchar *tooltip);
283 gchar * gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
284 GtkEntryIconPosition icon_pos);
285 void gtk_entry_set_icon_tooltip_markup (GtkEntry *entry,
286 GtkEntryIconPosition icon_pos,
287 const gchar *tooltip);
288 gchar * gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
289 GtkEntryIconPosition icon_pos);
290 void gtk_entry_set_icon_drag_source (GtkEntry *entry,
291 GtkEntryIconPosition icon_pos,
292 GtkTargetList *target_list,
293 GdkDragAction actions);
294 gint gtk_entry_get_current_icon_drag_source (GtkEntry *entry);
297 /* Deprecated compatibility functions
300 #ifndef GTK_DISABLE_DEPRECATED
301 GtkWidget* gtk_entry_new_with_max_length (gint max);
302 void gtk_entry_append_text (GtkEntry *entry,
304 void gtk_entry_prepend_text (GtkEntry *entry,
306 void gtk_entry_set_position (GtkEntry *entry,
308 void gtk_entry_select_region (GtkEntry *entry,
311 void gtk_entry_set_editable (GtkEntry *entry,
313 #endif /* GTK_DISABLE_DEPRECATED */
317 #endif /* __GTK_ENTRY_H__ */