gtkentry.h 3.54 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* 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
 * modify it under the terms of the GNU Library General Public
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library 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 22 23 24 25 26

/*
 * Modified by the GTK+ Team and others 1997-1999.  See the AUTHORS
 * 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
{
54
  GtkEditable editable;
Elliot Lee's avatar
Elliot Lee committed
55 56

  GdkWindow *text_area;
57
  GdkPixmap *backing_pixmap;
58
  GdkCursor *cursor;
59 60 61
  gchar     *text;

  guint16 text_size;	/* allocated size, in bytes */
Elliot Lee's avatar
Elliot Lee committed
62

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

66 67 68 69 70 71 72 73
  /*< private >*/
  guint   button;
  guint32 timer;
  guint16 n_bytes;	/* length in use, in bytes */
  PangoLayout *layout;
  gint    scroll_offset;
  gint    ascent;	/* font ascent, in pango units  */
  GtkIMContext *im_context;
Elliot Lee's avatar
Elliot Lee committed
74 75 76 77
};

struct _GtkEntryClass
{
78
  GtkEditableClass parent_class;
Elliot Lee's avatar
Elliot Lee committed
79 80
};

81 82
GtkType    gtk_entry_get_type       		(void);
GtkWidget* gtk_entry_new            		(void);
83
GtkWidget* gtk_entry_new_with_max_length	(guint16       max);
84 85 86 87 88 89 90 91
void       gtk_entry_set_text       		(GtkEntry      *entry,
						 const gchar   *text);
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);
92
/* returns a reference to the text */
93 94 95 96 97 98 99 100
gchar*     gtk_entry_get_text       		(GtkEntry      *entry);
void       gtk_entry_select_region  		(GtkEntry      *entry,
						 gint           start,
						 gint           end);
void       gtk_entry_set_visibility 		(GtkEntry      *entry,
						 gboolean       visible);
void       gtk_entry_set_editable   		(GtkEntry      *entry,
						 gboolean       editable);
101
/* text is truncated if needed */
102 103 104
void       gtk_entry_set_max_length 		(GtkEntry      *entry,
						 guint16        max);

Elliot Lee's avatar
Elliot Lee committed
105 106 107 108 109 110
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_ENTRY_H__ */