gtkentry.h 8.04 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * 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
18
 */
19 20

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

Elliot Lee's avatar
Elliot Lee committed
27 28 29 30 31
#ifndef __GTK_ENTRY_H__
#define __GTK_ENTRY_H__


#include <gdk/gdk.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>
Elliot Lee's avatar
Elliot Lee committed
37

38
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
39

40
#define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
Manish Singh's avatar
Manish Singh committed
41 42 43 44 45
#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
46 47 48 49 50 51 52


typedef struct _GtkEntry       GtkEntry;
typedef struct _GtkEntryClass  GtkEntryClass;

struct _GtkEntry
{
Owen Taylor's avatar
Owen Taylor committed
53
  GtkWidget  widget;
Elliot Lee's avatar
Elliot Lee committed
54

55 56
  gchar     *text;

Owen Taylor's avatar
Owen Taylor committed
57 58 59
  guint      editable : 1;
  guint      visible  : 1;
  guint      overwrite_mode : 1;
Owen Taylor's avatar
Owen Taylor committed
60
  guint      in_drag : 1;	/* Dragging within the selection */
Elliot Lee's avatar
Elliot Lee committed
61

62
  guint16 text_length;	/* length in use, in chars */
63
  guint16 text_max_length;
Owen Taylor's avatar
Owen Taylor committed
64

65
  /*< private >*/
Owen Taylor's avatar
Owen Taylor committed
66 67 68 69 70 71 72 73 74 75 76 77
  GdkWindow *text_area;
  GtkIMContext *im_context;
  GtkWidget   *popup_menu;
  
  gint         current_pos;
  gint         selection_bound;
  
  PangoLayout *cached_layout;
  guint        cache_includes_preedit : 1;

  guint        need_im_reset : 1;

78
  guint        has_frame : 1;
79 80

  guint        activates_default : 1;
81 82

  guint        cursor_visible : 1;
83 84

  guint        in_click : 1;	/* Flag so we don't select all when clicking in entry to focus in */
85 86

  guint        is_cell_renderer : 1;
87
  guint        editing_canceled : 1; /* Only used by GtkCellRendererText */
88

89 90
  guint        mouse_cursor_obscured : 1;
  
Matthias Clasen's avatar
Matthias Clasen committed
91 92
  guint        select_words : 1;
  guint        select_lines : 1;
93
  guint        resolved_dir : 4; /* PangoDirection */
94
  guint   button;
95
  guint   blink_timeout;
Owen Taylor's avatar
Owen Taylor committed
96
  guint   recompute_idle;
97 98
  gint    scroll_offset;
  gint    ascent;	/* font ascent, in pango units  */
99
  gint    descent;	/* font descent, in pango units  */
Owen Taylor's avatar
Owen Taylor committed
100 101 102 103 104
  
  guint16 text_size;	/* allocated size, in bytes */
  guint16 n_bytes;	/* length in use, in bytes */

  guint16 preedit_length;	/* length of preedit string, in bytes */
105
  guint16 preedit_cursor;	/* offset of cursor within preedit string, in chars */
Owen Taylor's avatar
Owen Taylor committed
106 107 108 109 110

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

  gint drag_start_x;
  gint drag_start_y;
111 112
  
  gunichar invisible_char;
113 114

  gint width_chars;
Elliot Lee's avatar
Elliot Lee committed
115 116 117 118
};

struct _GtkEntryClass
{
Owen Taylor's avatar
Owen Taylor committed
119 120
  GtkWidgetClass parent_class;

121 122 123 124
  /* Hook to customize right-click popup */
  void (* populate_popup)   (GtkEntry       *entry,
                             GtkMenu        *menu);
  
Owen Taylor's avatar
Owen Taylor committed
125 126
  /* Action signals
   */
127 128 129 130 131 132 133 134 135 136
  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);
137
  void (* backspace)          (GtkEntry       *entry);
138 139 140 141
  void (* cut_clipboard)      (GtkEntry       *entry);
  void (* copy_clipboard)     (GtkEntry       *entry);
  void (* paste_clipboard)    (GtkEntry       *entry);
  void (* toggle_overwrite)   (GtkEntry       *entry);
142 143 144 145 146

  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
Elliot Lee's avatar
Elliot Lee committed
147 148
};

Manish Singh's avatar
Manish Singh committed
149
GType      gtk_entry_get_type       		(void) G_GNUC_CONST;
150
GtkWidget* gtk_entry_new            		(void);
Owen Taylor's avatar
Owen Taylor committed
151 152
void       gtk_entry_set_visibility 		(GtkEntry      *entry,
						 gboolean       visible);
153
gboolean   gtk_entry_get_visibility             (GtkEntry      *entry);
154 155
void       gtk_entry_set_invisible_char         (GtkEntry      *entry,
                                                 gunichar       ch);
156
gunichar   gtk_entry_get_invisible_char         (GtkEntry      *entry);
157 158 159
void       gtk_entry_set_has_frame              (GtkEntry      *entry,
                                                 gboolean       setting);
gboolean   gtk_entry_get_has_frame              (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
160 161
/* text is truncated if needed */
void       gtk_entry_set_max_length 		(GtkEntry      *entry,
Havoc Pennington's avatar
Havoc Pennington committed
162
						 gint           max);
163
gint       gtk_entry_get_max_length             (GtkEntry      *entry);
164 165 166
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
167

168 169 170 171
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
172 173
/* Somewhat more convenient than the GtkEditable generic functions
 */
174
void       gtk_entry_set_text                   (GtkEntry      *entry,
175
                                                 const gchar   *text);
Owen Taylor's avatar
Owen Taylor committed
176
/* returns a reference to the text */
177
G_CONST_RETURN gchar* gtk_entry_get_text        (GtkEntry      *entry);
Owen Taylor's avatar
Owen Taylor committed
178

179 180 181 182
PangoLayout* gtk_entry_get_layout               (GtkEntry      *entry);
void         gtk_entry_get_layout_offsets       (GtkEntry      *entry,
                                                 gint          *x,
                                                 gint          *y);
183 184 185
void       gtk_entry_set_alignment              (GtkEntry      *entry,
                                                 gfloat         xalign);
gfloat     gtk_entry_get_alignment              (GtkEntry      *entry);
186

187 188 189 190
void                gtk_entry_set_completion (GtkEntry           *entry,
                                              GtkEntryCompletion *completion);
GtkEntryCompletion *gtk_entry_get_completion (GtkEntry           *entry);

191 192 193 194 195 196
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);


Owen Taylor's avatar
Owen Taylor committed
197 198
/* Deprecated compatibility functions
 */
199 200

#ifndef GTK_DISABLE_DEPRECATED
Havoc Pennington's avatar
Havoc Pennington committed
201
GtkWidget* gtk_entry_new_with_max_length	(gint           max);
202 203 204 205 206 207 208 209 210
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);
211 212
void       gtk_entry_set_editable   		(GtkEntry      *entry,
						 gboolean       editable);
213
#endif /* GTK_DISABLE_DEPRECATED */
214

215 216 217 218 219 220
/* private */
void      _gtk_entry_get_borders                (GtkEntry *entry,
						 gint     *xborder,
						 gint     *yborder);


221
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
222 223

#endif /* __GTK_ENTRY_H__ */