gtkentry.h 5.08 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 34
#include <gtk/gtkimcontext.h>
#include <pango/pango.h>
Elliot Lee's avatar
Elliot Lee committed
35 36 37 38 39 40

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


41 42 43 44 45
#define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
#define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
#define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
#define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
#define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
Tim Janik's avatar
Tim Janik committed
46
#define GTK_ENTRY_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
Elliot Lee's avatar
Elliot Lee committed
47 48 49 50 51 52 53


typedef struct _GtkEntry       GtkEntry;
typedef struct _GtkEntryClass  GtkEntryClass;

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

56 57
  gchar     *text;

Owen Taylor's avatar
Owen Taylor committed
58 59 60
  guint      editable : 1;
  guint      visible  : 1;
  guint      overwrite_mode : 1;
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   button;
Owen Taylor's avatar
Owen Taylor committed
79 80
  guint   timer;
  guint   recompute_idle;
81 82
  gint    scroll_offset;
  gint    ascent;	/* font ascent, in pango units  */
83
  gint    descent;	/* font descent, in pango units  */
Owen Taylor's avatar
Owen Taylor committed
84 85 86 87 88 89
  
  guint16 text_size;	/* allocated size, in bytes */
  guint16 n_bytes;	/* length in use, in bytes */

  guint16 preedit_length;	/* length of preedit string, in bytes */
  guint16 preedit_cursor;	/* offset of cursor within preedit string, in bytes */
Elliot Lee's avatar
Elliot Lee committed
90 91 92 93
};

struct _GtkEntryClass
{
Owen Taylor's avatar
Owen Taylor committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
  GtkWidgetClass parent_class;
  
  /* Notification of changes
   */
  void (* changed)          (GtkEntry       *entry);
  void (* insert_text)      (GtkEntry       *entry,
			     const gchar    *text,
			     gint            length,
			     gint           *position);
  void (* delete_text)      (GtkEntry       *entry,
		    	     gint            start_pos,
			     gint            end_pos);

  /* Action signals
   */
  void (* activate)         (GtkEntry       *entry);
  void (* move)             (GtkEntry       *entry,
			     GtkMovementStep step,
			     gint            count,
			     gboolean        extend_selection);
  void (* insert)           (GtkEntry       *entry,
			     const gchar    *str);
  void (* delete)           (GtkEntry       *entry,
			     GtkDeleteType   type,
			     gint            count);
  void (* cut_clipboard)    (GtkEntry       *entry);
  void (* copy_clipboard)   (GtkEntry       *entry);
  void (* paste_clipboard)  (GtkEntry       *entry);
  void (* toggle_overwrite) (GtkEntry       *entry);
Elliot Lee's avatar
Elliot Lee committed
123 124
};

Elliot Lee's avatar
Elliot Lee committed
125
GtkType    gtk_entry_get_type       		(void) G_GNUC_CONST;
126
GtkWidget* gtk_entry_new            		(void);
Owen Taylor's avatar
Owen Taylor committed
127 128 129 130 131 132 133 134 135 136
void       gtk_entry_set_visibility 		(GtkEntry      *entry,
						 gboolean       visible);
void       gtk_entry_set_editable   		(GtkEntry      *entry,
						 gboolean       editable);
/* text is truncated if needed */
void       gtk_entry_set_max_length 		(GtkEntry      *entry,
						 guint16        max);

/* Somewhat more convenient than the GtkEditable generic functions
 */
137 138
void       gtk_entry_set_text       		(GtkEntry      *entry,
						 const gchar   *text);
Owen Taylor's avatar
Owen Taylor committed
139 140 141 142 143 144
/* returns a reference to the text */
gchar*     gtk_entry_get_text       		(GtkEntry      *entry);

/* Deprecated compatibility functions
 */
GtkWidget* gtk_entry_new_with_max_length	(guint16       max);
145 146 147 148 149 150 151 152 153 154
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);

Elliot Lee's avatar
Elliot Lee committed
155 156 157 158 159 160
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_ENTRY_H__ */