gtkentry.h 14.5 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
4 5 6 7
 * Copyright (C) 2004-2006 Christian Hammond
 * Copyright (C) 2008 Cody Russell
 * Copyright (C) 2008 Red Hat, Inc.
 *
Elliot Lee's avatar
Elliot Lee committed
8
 * This library is free software; you can redistribute it and/or
9
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
10 11 12 13 14 15
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
17
 *
18
 * You should have received a copy of the GNU Lesser General Public
19 20 21
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
22
 */
23 24

/*
25
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
26 27
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
28
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 30
 */

31 32 33 34
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
35 36 37 38
#ifndef __GTK_ENTRY_H__
#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 45
#include <gtk/gtkimage.h>
#include <gtk/gtkselection.h>
Elliot Lee's avatar
Elliot Lee committed
46

47

48
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
49

50
#define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
Manish Singh's avatar
Manish Singh committed
51 52 53 54 55
#define GTK_ENTRY(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
#define GTK_ENTRY_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
#define GTK_IS_ENTRY(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY))
#define GTK_IS_ENTRY_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
#define GTK_ENTRY_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
Elliot Lee's avatar
Elliot Lee committed
56

57 58 59 60 61
typedef enum
{
  GTK_ENTRY_ICON_PRIMARY,
  GTK_ENTRY_ICON_SECONDARY
} GtkEntryIconPosition;
Elliot Lee's avatar
Elliot Lee committed
62 63 64 65 66 67

typedef struct _GtkEntry       GtkEntry;
typedef struct _GtkEntryClass  GtkEntryClass;

struct _GtkEntry
{
Owen Taylor's avatar
Owen Taylor committed
68
  GtkWidget  widget;
Elliot Lee's avatar
Elliot Lee committed
69

70
  gchar       *GSEAL (text);                        /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
71

72 73 74 75
  guint        GSEAL (editable) : 1;
  guint        GSEAL (visible)  : 1;
  guint        GSEAL (overwrite_mode) : 1;
  guint        GSEAL (in_drag) : 1;	            /* FIXME: Should be private?
Tim Janik's avatar
Tim Janik committed
76
                                                       Dragging within the selection */
Elliot Lee's avatar
Elliot Lee committed
77

78 79
  guint16      GSEAL (text_length);                 /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
  guint16      GSEAL (text_max_length);             /* COMPAT: Deprecated, not used. Remove in GTK+ 3.x */
Owen Taylor's avatar
Owen Taylor committed
80

81
  /*< private >*/
Tim Janik's avatar
Tim Janik committed
82 83 84 85 86 87 88 89 90
  GdkWindow    *GSEAL (text_area);
  GtkIMContext *GSEAL (im_context);
  GtkWidget    *GSEAL (popup_menu);

  gint          GSEAL (current_pos);
  gint          GSEAL (selection_bound);

  PangoLayout  *GSEAL (cached_layout);

91 92 93 94 95 96 97 98 99 100 101 102 103
  guint         GSEAL (cache_includes_preedit) : 1;
  guint         GSEAL (need_im_reset)          : 1;
  guint         GSEAL (has_frame)              : 1;
  guint         GSEAL (activates_default)      : 1;
  guint         GSEAL (cursor_visible)         : 1;
  guint         GSEAL (in_click)               : 1; /* Flag so we don't select all when clicking in entry to focus in */
  guint         GSEAL (is_cell_renderer)       : 1;
  guint         GSEAL (editing_canceled)       : 1; /* Only used by GtkCellRendererText */ 
  guint         GSEAL (mouse_cursor_obscured)  : 1;
  guint         GSEAL (select_words)           : 1;
  guint         GSEAL (select_lines)           : 1;
  guint         GSEAL (resolved_dir)           : 4; /* PangoDirection */
  guint         GSEAL (truncate_multiline)     : 1;
Tim Janik's avatar
Tim Janik committed
104 105 106 107 108 109 110 111

  guint         GSEAL (button);
  guint         GSEAL (blink_timeout);
  guint         GSEAL (recompute_idle);
  gint          GSEAL (scroll_offset);
  gint          GSEAL (ascent);	                    /* font ascent in pango units  */
  gint          GSEAL (descent);	            /* font descent in pango units */

112 113
  guint16       GSEAL (x_text_size);	            /* allocated size, in bytes */
  guint16       GSEAL (x_n_bytes);	            /* length in use, in bytes */
Tim Janik's avatar
Tim Janik committed
114 115 116 117 118 119 120 121 122 123 124 125

  guint16       GSEAL (preedit_length);	            /* length of preedit string, in bytes */
  guint16       GSEAL (preedit_cursor);	            /* offset of cursor within preedit string, in chars */

  gint          GSEAL (dnd_position);		    /* In chars, -1 == no DND cursor */

  gint          GSEAL (drag_start_x);
  gint          GSEAL (drag_start_y);

  gunichar      GSEAL (invisible_char);

  gint          GSEAL (width_chars);
Elliot Lee's avatar
Elliot Lee committed
126 127 128 129
};

struct _GtkEntryClass
{
Owen Taylor's avatar
Owen Taylor committed
130 131
  GtkWidgetClass parent_class;

132 133 134
  /* Hook to customize right-click popup */
  void (* populate_popup)   (GtkEntry       *entry,
                             GtkMenu        *menu);
135

Owen Taylor's avatar
Owen Taylor committed
136 137
  /* Action signals
   */
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
  void (* activate)           (GtkEntry             *entry);
  void (* move_cursor)        (GtkEntry             *entry,
			       GtkMovementStep       step,
			       gint                  count,
			       gboolean              extend_selection);
  void (* insert_at_cursor)   (GtkEntry             *entry,
			       const gchar          *str);
  void (* delete_from_cursor) (GtkEntry             *entry,
			       GtkDeleteType         type,
			       gint                  count);
  void (* backspace)          (GtkEntry             *entry);
  void (* cut_clipboard)      (GtkEntry             *entry);
  void (* copy_clipboard)     (GtkEntry             *entry);
  void (* paste_clipboard)    (GtkEntry             *entry);
  void (* toggle_overwrite)   (GtkEntry             *entry);
153

154 155 156 157 158 159 160
  /* hook to add other objects beside the entry (like in GtkSpinButton) */
  void (* get_text_area_size) (GtkEntry       *entry,
			       gint           *x,
			       gint           *y,
			       gint           *width,
			       gint           *height);

161
  /* Padding for future expansion */
162 163
  void (*_gtk_reserved1)      (void);
  void (*_gtk_reserved2)      (void);
Elliot Lee's avatar
Elliot Lee committed
164 165
};

Manish Singh's avatar
Manish Singh committed
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

170 171 172
GtkEntryBuffer* gtk_entry_get_buffer            (GtkEntry       *entry);
void       gtk_entry_set_buffer                 (GtkEntry       *entry,
                                                 GtkEntryBuffer *buffer);
173 174 175

GdkWindow *gtk_entry_get_text_window            (GtkEntry      *entry);

Owen Taylor's avatar
Owen Taylor committed
176 177
void       gtk_entry_set_visibility 		(GtkEntry      *entry,
						 gboolean       visible);
178
gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
179

180 181
void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
                                                 gunichar       ch);
182
gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
183
void       gtk_entry_unset_invisible_char       (GtkEntry      *entry);
184

185 186 187
void       gtk_entry_set_has_frame              (GtkEntry      *entry,
                                                 gboolean       setting);
gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
188

189 190 191
void       gtk_entry_set_inner_border                (GtkEntry        *entry,
                                                      const GtkBorder *border);
G_CONST_RETURN GtkBorder* gtk_entry_get_inner_border (GtkEntry        *entry);
192

Tim Janik's avatar
Tim Janik committed
193 194 195
void       gtk_entry_set_overwrite_mode         (GtkEntry      *entry,
                                                 gboolean       overwrite);
gboolean   gtk_entry_get_overwrite_mode         (GtkEntry      *entry);
196

Owen Taylor's avatar
Owen Taylor committed
197 198
/* text is truncated if needed */
void       gtk_entry_set_max_length 		(GtkEntry      *entry,
Havoc Pennington's avatar
Havoc Pennington committed
199
						 gint           max);
200
gint       gtk_entry_get_max_length             (GtkEntry      *entry);
Tim Janik's avatar
Tim Janik committed
201
guint16    gtk_entry_get_text_length            (GtkEntry      *entry);
202

203 204 205
void       gtk_entry_set_activates_default      (GtkEntry      *entry,
                                                 gboolean       setting);
gboolean   gtk_entry_get_activates_default      (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
206

207 208 209 210
void       gtk_entry_set_width_chars            (GtkEntry      *entry,
                                                 gint           n_chars);
gint       gtk_entry_get_width_chars            (GtkEntry      *entry);

Owen Taylor's avatar
Owen Taylor committed
211 212
/* Somewhat more convenient than the GtkEditable generic functions
 */
213
void       gtk_entry_set_text                   (GtkEntry      *entry,
214
                                                 const gchar   *text);
Owen Taylor's avatar
Owen Taylor committed
215
/* returns a reference to the text */
216
G_CONST_RETURN gchar* gtk_entry_get_text        (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
217

218 219 220 221
PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
                                                 gint          *x,
                                                 gint          *y);
222 223 224
void       gtk_entry_set_alignment              (GtkEntry      *entry,
                                                 gfloat         xalign);
gfloat     gtk_entry_get_alignment              (GtkEntry      *entry);
225

226 227 228 229
void                gtk_entry_set_completion (GtkEntry           *entry,
                                              GtkEntryCompletion *completion);
GtkEntryCompletion *gtk_entry_get_completion (GtkEntry           *entry);

230 231 232 233 234
gint       gtk_entry_layout_index_to_text_index (GtkEntry      *entry,
                                                 gint           layout_index);
gint       gtk_entry_text_index_to_layout_index (GtkEntry      *entry,
                                                 gint           text_index);

235
/* For scrolling cursor appropriately
236 237 238 239
 */
void           gtk_entry_set_cursor_hadjustment (GtkEntry      *entry,
                                                 GtkAdjustment *adjustment);
GtkAdjustment* gtk_entry_get_cursor_hadjustment (GtkEntry      *entry);
240

241 242 243 244 245 246 247 248 249 250 251 252
/* Progress API
 */
void           gtk_entry_set_progress_fraction   (GtkEntry     *entry,
                                                  gdouble       fraction);
gdouble        gtk_entry_get_progress_fraction   (GtkEntry     *entry);

void           gtk_entry_set_progress_pulse_step (GtkEntry     *entry,
                                                  gdouble       fraction);
gdouble        gtk_entry_get_progress_pulse_step (GtkEntry     *entry);

void           gtk_entry_progress_pulse          (GtkEntry     *entry);

253 254 255 256 257 258 259 260 261 262 263 264 265 266
/* Setting and managing icons
 */
void           gtk_entry_set_icon_from_pixbuf            (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  GdkPixbuf            *pixbuf);
void           gtk_entry_set_icon_from_stock             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *stock_id);
void           gtk_entry_set_icon_from_icon_name         (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *icon_name);
void           gtk_entry_set_icon_from_gicon             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  GIcon                *icon);
267
GtkImageType gtk_entry_get_icon_storage_type             (GtkEntry             *entry,
268
							  GtkEntryIconPosition  icon_pos);
269
GdkPixbuf*   gtk_entry_get_icon_pixbuf                   (GtkEntry             *entry,
270
							  GtkEntryIconPosition  icon_pos);
271
const gchar* gtk_entry_get_icon_stock                    (GtkEntry             *entry,
272 273 274
							  GtkEntryIconPosition  icon_pos);
const gchar* gtk_entry_get_icon_name                     (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
275
GIcon*       gtk_entry_get_icon_gicon                    (GtkEntry             *entry,
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
							  GtkEntryIconPosition  icon_pos);
void         gtk_entry_set_icon_activatable              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  gboolean              activatable);
gboolean     gtk_entry_get_icon_activatable              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
void         gtk_entry_set_icon_sensitive                (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  gboolean              sensitive);
gboolean     gtk_entry_get_icon_sensitive                (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos);
gint         gtk_entry_get_icon_at_pos                   (GtkEntry             *entry,
							  gint                  x,
							  gint                  y);
void         gtk_entry_set_icon_tooltip_text             (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *tooltip);
293 294
gchar *      gtk_entry_get_icon_tooltip_text             (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos);
295 296 297
void         gtk_entry_set_icon_tooltip_markup           (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  const gchar          *tooltip);
298 299
gchar *      gtk_entry_get_icon_tooltip_markup           (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos);
300 301 302 303 304 305
void         gtk_entry_set_icon_drag_source              (GtkEntry             *entry,
							  GtkEntryIconPosition  icon_pos,
							  GtkTargetList        *target_list,
							  GdkDragAction         actions);
gint         gtk_entry_get_current_icon_drag_source      (GtkEntry             *entry);

306 307 308
GdkWindow  * gtk_entry_get_icon_window                   (GtkEntry             *entry,
                                                          GtkEntryIconPosition  icon_pos);

309

Owen Taylor's avatar
Owen Taylor committed
310 311
/* Deprecated compatibility functions
 */
312 313

#ifndef GTK_DISABLE_DEPRECATED
Havoc Pennington's avatar
Havoc Pennington committed
314
GtkWidget* gtk_entry_new_with_max_length	(gint           max);
315 316 317 318 319 320 321 322 323
void       gtk_entry_append_text    		(GtkEntry      *entry,
						 const gchar   *text);
void       gtk_entry_prepend_text   		(GtkEntry      *entry,
						 const gchar   *text);
void       gtk_entry_set_position   		(GtkEntry      *entry,
						 gint           position);
void       gtk_entry_select_region  		(GtkEntry      *entry,
						 gint           start,
						 gint           end);
324 325
void       gtk_entry_set_editable   		(GtkEntry      *entry,
						 gboolean       editable);
326
#endif /* GTK_DISABLE_DEPRECATED */
327

328
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
329 330

#endif /* __GTK_ENTRY_H__ */