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 <pango/pango.h>
38 #endif /* __cplusplus */
41 #define GTK_TYPE_ENTRY (gtk_entry_get_type ())
42 #define GTK_ENTRY(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
43 #define GTK_ENTRY_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
44 #define GTK_IS_ENTRY(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
45 #define GTK_IS_ENTRY_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
46 #define GTK_ENTRY_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
49 typedef struct _GtkEntry GtkEntry;
50 typedef struct _GtkEntryClass GtkEntryClass;
60 guint overwrite_mode : 1;
61 guint in_drag : 1; /* Dragging within the selection */
63 guint16 text_length; /* length in use, in chars */
64 guint16 text_max_length;
68 GtkIMContext *im_context;
69 GtkWidget *popup_menu;
74 PangoLayout *cached_layout;
75 guint cache_includes_preedit : 1;
77 guint need_im_reset : 1;
85 gint ascent; /* font ascent, in pango units */
86 gint descent; /* font descent, in pango units */
88 guint16 text_size; /* allocated size, in bytes */
89 guint16 n_bytes; /* length in use, in bytes */
91 guint16 preedit_length; /* length of preedit string, in bytes */
92 guint16 preedit_cursor; /* offset of cursor within preedit string, in chars */
94 gint dnd_position; /* In chars, -1 == no DND cursor */
99 gunichar invisible_char;
102 struct _GtkEntryClass
104 GtkWidgetClass parent_class;
106 /* Notification of changes
108 void (* changed) (GtkEntry *entry);
109 void (* insert_text) (GtkEntry *entry,
113 void (* delete_text) (GtkEntry *entry,
119 void (* activate) (GtkEntry *entry);
120 void (* move_cursor) (GtkEntry *entry,
121 GtkMovementStep step,
123 gboolean extend_selection);
124 void (* insert_at_cursor) (GtkEntry *entry,
126 void (* delete_from_cursor) (GtkEntry *entry,
129 void (* cut_clipboard) (GtkEntry *entry);
130 void (* copy_clipboard) (GtkEntry *entry);
131 void (* paste_clipboard) (GtkEntry *entry);
132 void (* toggle_overwrite) (GtkEntry *entry);
135 GtkType gtk_entry_get_type (void) G_GNUC_CONST;
136 GtkWidget* gtk_entry_new (void);
137 void gtk_entry_set_visibility (GtkEntry *entry,
139 void gtk_entry_set_invisible_char (GtkEntry *entry,
141 void gtk_entry_set_editable (GtkEntry *entry,
143 void gtk_entry_set_has_frame (GtkEntry *entry,
145 gboolean gtk_entry_get_has_frame (GtkEntry *entry);
146 /* text is truncated if needed */
147 void gtk_entry_set_max_length (GtkEntry *entry,
150 /* Somewhat more convenient than the GtkEditable generic functions
152 void gtk_entry_set_text (GtkEntry *entry,
154 /* returns a reference to the text */
155 G_CONST_RETURN gchar* gtk_entry_get_text (GtkEntry *entry);
157 /* Deprecated compatibility functions
159 GtkWidget* gtk_entry_new_with_max_length (gint max);
160 void gtk_entry_append_text (GtkEntry *entry,
162 void gtk_entry_prepend_text (GtkEntry *entry,
164 void gtk_entry_set_position (GtkEntry *entry,
166 void gtk_entry_select_region (GtkEntry *entry,
172 #endif /* __cplusplus */
175 #endif /* __GTK_ENTRY_H__ */