1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
27 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
28 #error "Only <gtk/gtk.h> can be included directly."
31 #ifndef __GTK_ENTRY_H__
32 #define __GTK_ENTRY_H__
36 #include <gtk/gtkeditable.h>
37 #include <gtk/gtkimcontext.h>
38 #include <gtk/gtkmenu.h>
39 #include <gtk/gtkentrycompletion.h>
40 #include <pango/pango.h>
44 #define GTK_TYPE_ENTRY (gtk_entry_get_type ())
45 #define GTK_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
46 #define GTK_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
47 #define GTK_IS_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
48 #define GTK_IS_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
49 #define GTK_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
52 typedef struct _GtkEntry GtkEntry;
53 typedef struct _GtkEntryClass GtkEntryClass;
63 guint overwrite_mode : 1;
64 guint in_drag : 1; /* Dragging within the selection */
66 guint16 text_length; /* length in use, in chars */
67 guint16 text_max_length;
71 GtkIMContext *im_context;
72 GtkWidget *popup_menu;
77 PangoLayout *cached_layout;
79 guint cache_includes_preedit : 1;
80 guint need_im_reset : 1;
82 guint activates_default : 1;
83 guint cursor_visible : 1;
84 guint in_click : 1; /* Flag so we don't select all when clicking in entry to focus in */
85 guint is_cell_renderer : 1;
86 guint editing_canceled : 1; /* Only used by GtkCellRendererText */
87 guint mouse_cursor_obscured : 1;
88 guint select_words : 1;
89 guint select_lines : 1;
90 guint resolved_dir : 4; /* PangoDirection */
91 guint truncate_multiline : 1;
97 gint ascent; /* font ascent, in pango units */
98 gint descent; /* font descent, in pango units */
100 guint16 text_size; /* allocated size, in bytes */
101 guint16 n_bytes; /* length in use, in bytes */
103 guint16 preedit_length; /* length of preedit string, in bytes */
104 guint16 preedit_cursor; /* offset of cursor within preedit string, in chars */
106 gint dnd_position; /* In chars, -1 == no DND cursor */
111 gunichar invisible_char;
116 struct _GtkEntryClass
118 GtkWidgetClass parent_class;
120 /* Hook to customize right-click popup */
121 void (* populate_popup) (GtkEntry *entry,
126 void (* activate) (GtkEntry *entry);
127 void (* move_cursor) (GtkEntry *entry,
128 GtkMovementStep step,
130 gboolean extend_selection);
131 void (* insert_at_cursor) (GtkEntry *entry,
133 void (* delete_from_cursor) (GtkEntry *entry,
136 void (* backspace) (GtkEntry *entry);
137 void (* cut_clipboard) (GtkEntry *entry);
138 void (* copy_clipboard) (GtkEntry *entry);
139 void (* paste_clipboard) (GtkEntry *entry);
140 void (* toggle_overwrite) (GtkEntry *entry);
142 /* hook to add other objects beside the entry (like in GtkSpinButton) */
143 void (* get_text_area_size) (GtkEntry *entry,
149 /* Padding for future expansion */
150 void (*_gtk_reserved2) (void);
151 void (*_gtk_reserved3) (void);
154 GType gtk_entry_get_type (void) G_GNUC_CONST;
155 GtkWidget* gtk_entry_new (void);
156 void gtk_entry_set_visibility (GtkEntry *entry,
158 gboolean gtk_entry_get_visibility (GtkEntry *entry);
159 void gtk_entry_set_invisible_char (GtkEntry *entry,
161 gunichar gtk_entry_get_invisible_char (GtkEntry *entry);
162 void gtk_entry_set_has_frame (GtkEntry *entry,
164 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
165 void gtk_entry_set_inner_border (GtkEntry *entry,
166 const GtkBorder *border);
167 G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry *entry);
168 /* text is truncated if needed */
169 void gtk_entry_set_max_length (GtkEntry *entry,
171 gint gtk_entry_get_max_length (GtkEntry *entry);
172 void gtk_entry_set_activates_default (GtkEntry *entry,
174 gboolean gtk_entry_get_activates_default (GtkEntry *entry);
176 void gtk_entry_set_width_chars (GtkEntry *entry,
178 gint gtk_entry_get_width_chars (GtkEntry *entry);
180 /* Somewhat more convenient than the GtkEditable generic functions
182 void gtk_entry_set_text (GtkEntry *entry,
184 /* returns a reference to the text */
185 G_CONST_RETURN gchar* gtk_entry_get_text (GtkEntry *entry);
187 PangoLayout* gtk_entry_get_layout (GtkEntry *entry);
188 void gtk_entry_get_layout_offsets (GtkEntry *entry,
191 void gtk_entry_set_alignment (GtkEntry *entry,
193 gfloat gtk_entry_get_alignment (GtkEntry *entry);
195 void gtk_entry_set_completion (GtkEntry *entry,
196 GtkEntryCompletion *completion);
197 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry *entry);
199 gint gtk_entry_layout_index_to_text_index (GtkEntry *entry,
201 gint gtk_entry_text_index_to_layout_index (GtkEntry *entry,
204 /* For scrolling cursor appropriately
206 void gtk_entry_set_cursor_hadjustment (GtkEntry *entry,
207 GtkAdjustment *adjustment);
208 GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry *entry);
210 /* Deprecated compatibility functions
213 #ifndef GTK_DISABLE_DEPRECATED
214 GtkWidget* gtk_entry_new_with_max_length (gint max);
215 void gtk_entry_append_text (GtkEntry *entry,
217 void gtk_entry_prepend_text (GtkEntry *entry,
219 void gtk_entry_set_position (GtkEntry *entry,
221 void gtk_entry_select_region (GtkEntry *entry,
224 void gtk_entry_set_editable (GtkEntry *entry,
226 #endif /* GTK_DISABLE_DEPRECATED */
230 #endif /* __GTK_ENTRY_H__ */