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 #ifndef __GTK_ENTRY_H__
28 #define __GTK_ENTRY_H__
32 #include <gtk/gtkeditable.h>
33 #include <gtk/gtkimcontext.h>
34 #include <gtk/gtkmenu.h>
35 #include <gtk/gtkentrycompletion.h>
36 #include <pango/pango.h>
40 #define GTK_TYPE_ENTRY (gtk_entry_get_type ())
41 #define GTK_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
42 #define GTK_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
43 #define GTK_IS_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
44 #define GTK_IS_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
45 #define GTK_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
48 typedef struct _GtkEntry GtkEntry;
49 typedef struct _GtkEntryClass GtkEntryClass;
59 guint overwrite_mode : 1;
60 guint in_drag : 1; /* Dragging within the selection */
62 guint16 text_length; /* length in use, in chars */
63 guint16 text_max_length;
67 GtkIMContext *im_context;
68 GtkWidget *popup_menu;
73 PangoLayout *cached_layout;
75 guint cache_includes_preedit : 1;
76 guint need_im_reset : 1;
78 guint activates_default : 1;
79 guint cursor_visible : 1;
80 guint in_click : 1; /* Flag so we don't select all when clicking in entry to focus in */
81 guint is_cell_renderer : 1;
82 guint editing_canceled : 1; /* Only used by GtkCellRendererText */
83 guint mouse_cursor_obscured : 1;
84 guint select_words : 1;
85 guint select_lines : 1;
86 guint resolved_dir : 4; /* PangoDirection */
87 guint truncate_multiline : 1;
93 gint ascent; /* font ascent, in pango units */
94 gint descent; /* font descent, in pango units */
96 guint16 text_size; /* allocated size, in bytes */
97 guint16 n_bytes; /* length in use, in bytes */
99 guint16 preedit_length; /* length of preedit string, in bytes */
100 guint16 preedit_cursor; /* offset of cursor within preedit string, in chars */
102 gint dnd_position; /* In chars, -1 == no DND cursor */
107 gunichar invisible_char;
112 struct _GtkEntryClass
114 GtkWidgetClass parent_class;
116 /* Hook to customize right-click popup */
117 void (* populate_popup) (GtkEntry *entry,
122 void (* activate) (GtkEntry *entry);
123 void (* move_cursor) (GtkEntry *entry,
124 GtkMovementStep step,
126 gboolean extend_selection);
127 void (* insert_at_cursor) (GtkEntry *entry,
129 void (* delete_from_cursor) (GtkEntry *entry,
132 void (* backspace) (GtkEntry *entry);
133 void (* cut_clipboard) (GtkEntry *entry);
134 void (* copy_clipboard) (GtkEntry *entry);
135 void (* paste_clipboard) (GtkEntry *entry);
136 void (* toggle_overwrite) (GtkEntry *entry);
138 /* Padding for future expansion */
139 void (*_gtk_reserved1) (void);
140 void (*_gtk_reserved2) (void);
141 void (*_gtk_reserved3) (void);
144 GType gtk_entry_get_type (void) G_GNUC_CONST;
145 GtkWidget* gtk_entry_new (void);
146 void gtk_entry_set_visibility (GtkEntry *entry,
148 gboolean gtk_entry_get_visibility (GtkEntry *entry);
149 void gtk_entry_set_invisible_char (GtkEntry *entry,
151 gunichar gtk_entry_get_invisible_char (GtkEntry *entry);
152 void gtk_entry_set_has_frame (GtkEntry *entry,
154 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
155 void gtk_entry_set_inner_border (GtkEntry *entry,
156 const GtkBorder *border);
157 G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry *entry);
158 /* text is truncated if needed */
159 void gtk_entry_set_max_length (GtkEntry *entry,
161 gint gtk_entry_get_max_length (GtkEntry *entry);
162 void gtk_entry_set_activates_default (GtkEntry *entry,
164 gboolean gtk_entry_get_activates_default (GtkEntry *entry);
166 void gtk_entry_set_width_chars (GtkEntry *entry,
168 gint gtk_entry_get_width_chars (GtkEntry *entry);
170 /* Somewhat more convenient than the GtkEditable generic functions
172 void gtk_entry_set_text (GtkEntry *entry,
174 /* returns a reference to the text */
175 G_CONST_RETURN gchar* gtk_entry_get_text (GtkEntry *entry);
177 PangoLayout* gtk_entry_get_layout (GtkEntry *entry);
178 void gtk_entry_get_layout_offsets (GtkEntry *entry,
181 void gtk_entry_set_alignment (GtkEntry *entry,
183 gfloat gtk_entry_get_alignment (GtkEntry *entry);
185 void gtk_entry_set_completion (GtkEntry *entry,
186 GtkEntryCompletion *completion);
187 GtkEntryCompletion *gtk_entry_get_completion (GtkEntry *entry);
189 gint gtk_entry_layout_index_to_text_index (GtkEntry *entry,
191 gint gtk_entry_text_index_to_layout_index (GtkEntry *entry,
195 /* Deprecated compatibility functions
198 #ifndef GTK_DISABLE_DEPRECATED
199 GtkWidget* gtk_entry_new_with_max_length (gint max);
200 void gtk_entry_append_text (GtkEntry *entry,
202 void gtk_entry_prepend_text (GtkEntry *entry,
204 void gtk_entry_set_position (GtkEntry *entry,
206 void gtk_entry_select_region (GtkEntry *entry,
209 void gtk_entry_set_editable (GtkEntry *entry,
211 #endif /* GTK_DISABLE_DEPRECATED */
215 #endif /* __GTK_ENTRY_H__ */