2004-08-17 Marcus Brinkmann <marcus@g10code.de>
[pinentry.git] / gtk+-2 / gtksecentry.h
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
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/. 
25  */
26
27 /*
28  * Heavily stripped down for use in pinentry-gtk-2 by Albrecht Dreß
29  * <albrecht.dress@arcor.de> Feb. 2004.
30  *
31  * (C) by Albrecht Dreß 2004 unter the terms of the GNU Lesser General
32  * Public License.
33  *
34  * The entry is now always invisible, uses secure memory methods to
35  * allocate the text memory, and all potentially dangerous methods
36  * (copy & paste, popup, etc.) have been removed.
37  */
38
39 #ifndef __GTK_SECURE_ENTRY_H__
40 #define __GTK_SECURE_ENTRY_H__
41
42
43 #include <gtk/gtk.h>
44
45 #ifdef __cplusplus
46 extern "C" {
47 #ifdef MAKE_EMACS_HAPPY
48 }
49 #endif                          /* MAKE_EMACS_HAPPY */
50 #endif                          /* __cplusplus */
51 #define GTK_TYPE_SECURE_ENTRY                  (gtk_secure_entry_get_type ())
52 #define GTK_SECURE_ENTRY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SECURE_ENTRY, GtkSecureEntry))
53 #define GTK_SECURE_ENTRY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SECURE_ENTRY, GtkSecureEntryClass))
54 #define GTK_IS_SECURE_ENTRY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SECURE_ENTRY))
55 #define GTK_IS_SECURE_ENTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SECURE_ENTRY))
56 #define GTK_SECURE_ENTRY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SECURE_ENTRY, GtkSecureEntryClass))
57 typedef struct _GtkSecureEntry GtkSecureEntry;
58 typedef struct _GtkSecureEntryClass GtkSecureEntryClass;
59
60 struct _GtkSecureEntry {
61     GtkWidget widget;
62
63     gchar *text;
64
65     guint overwrite_mode:1;
66
67     guint16 text_length;        /* length in use, in chars */
68     guint16 text_max_length;
69
70     /*< private > */
71     GdkWindow *text_area;
72     GtkIMContext *im_context;
73
74     gint current_pos;
75     gint selection_bound;
76
77     PangoLayout *cached_layout;
78     guint cache_includes_preedit:1;
79
80     guint need_im_reset:1;
81
82     guint has_frame:1;
83
84     guint activates_default:1;
85
86     guint cursor_visible:1;
87
88     guint in_click:1;           /* Flag so we don't select all when clicking in entry to focus in */
89
90     guint is_cell_renderer:1;
91     guint editing_canceled:1;   /* Only used by GtkCellRendererText */
92
93     guint mouse_cursor_obscured:1;
94
95     guint resolved_dir : 4; /* PangoDirection */
96
97     guint button;
98     guint blink_timeout;
99     guint recompute_idle;
100     gint scroll_offset;
101     gint ascent;                /* font ascent, in pango units  */
102     gint descent;               /* font descent, in pango units  */
103
104     guint16 text_size;          /* allocated size, in bytes */
105     guint16 n_bytes;            /* length in use, in bytes */
106
107     guint16 preedit_length;     /* length of preedit string, in bytes */
108     guint16 preedit_cursor;     /* offset of cursor within preedit string, in chars */
109
110     gunichar invisible_char;
111
112     gint width_chars;
113 };
114
115 struct _GtkSecureEntryClass {
116     GtkWidgetClass parent_class;
117
118     /* Action signals
119      */
120     void (*activate) (GtkSecureEntry * entry);
121     void (*move_cursor) (GtkSecureEntry * entry,
122                          GtkMovementStep step,
123                          gint count, gboolean extend_selection);
124     void (*insert_at_cursor) (GtkSecureEntry * entry, const gchar * str);
125     void (*delete_from_cursor) (GtkSecureEntry * entry,
126                                 GtkDeleteType type, gint count);
127
128     /* Padding for future expansion */
129     void (*_gtk_reserved1) (void);
130     void (*_gtk_reserved2) (void);
131     void (*_gtk_reserved3) (void);
132     void (*_gtk_reserved4) (void);
133 };
134
135 GType
136 gtk_secure_entry_get_type(void)
137     G_GNUC_CONST;
138 GtkWidget *
139 gtk_secure_entry_new(void);
140 void
141 gtk_secure_entry_set_invisible_char(GtkSecureEntry * entry, gunichar ch);
142 gunichar
143 gtk_secure_entry_get_invisible_char(GtkSecureEntry * entry);
144 void
145 gtk_secure_entry_set_has_frame(GtkSecureEntry * entry, gboolean setting);
146 gboolean
147 gtk_secure_entry_get_has_frame(GtkSecureEntry * entry);
148 /* text is truncated if needed */
149 void
150 gtk_secure_entry_set_max_length(GtkSecureEntry * entry, gint max);
151 gint
152 gtk_secure_entry_get_max_length(GtkSecureEntry * entry);
153 void
154 gtk_secure_entry_set_activates_default(GtkSecureEntry * entry,
155                                        gboolean setting);
156 gboolean
157 gtk_secure_entry_get_activates_default(GtkSecureEntry * entry);
158
159 void
160 gtk_secure_entry_set_width_chars(GtkSecureEntry * entry, gint n_chars);
161 gint
162 gtk_secure_entry_get_width_chars(GtkSecureEntry * entry);
163
164 /* Somewhat more convenient than the GtkEditable generic functions
165  */
166 void
167 gtk_secure_entry_set_text(GtkSecureEntry * entry, const gchar * text);
168 /* returns a reference to the text */
169 G_CONST_RETURN gchar *
170 gtk_secure_entry_get_text(GtkSecureEntry * entry);
171
172 PangoLayout *
173 gtk_secure_entry_get_layout(GtkSecureEntry * entry);
174 void
175 gtk_secure_entry_get_layout_offsets(GtkSecureEntry * entry,
176                                     gint * x, gint * y);
177
178 #ifdef __cplusplus
179 }
180 #endif                          /* __cplusplus */
181
182
183 #endif                          /* __GTK_SECURE_ENTRY_H__ */