Pileus Git - ~andy/gtk/blob - gtk/gtkentry.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 #ifndef __GTK_ENTRY_H__
  28 #define __GTK_ENTRY_H__
  29
  30
  31 #include <gdk/gdk.h>
  32 #include <gtk/gtkeditable.h>
  33 #include <gtk/gtkimcontext.h>
  34 #include <pango/pango.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif /* __cplusplus */
  39
  40
  41 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  42 #define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  43 #define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  44 #define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
  45 #define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  46 #define GTK_ENTRY_GET_CLASS(obj)        (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_ENTRY, GtkEntryClass))
  47
  48
  49 typedef struct _GtkEntry       GtkEntry;
  50 typedef struct _GtkEntryClass  GtkEntryClass;
  51
  52 struct _GtkEntry
  53 {
  54   GtkEditable editable;
  55
  56   GdkWindow *text_area;
  57   GdkPixmap *backing_pixmap;
  58   GdkCursor *cursor;
  59   gchar     *text;
  60
  61   guint16 text_size;    /* allocated size, in bytes */
  62
  63   guint16 text_length;  /* length in use, in chars */
  64   guint16 text_max_length;
  65
  66   /*< private >*/
  67   guint   button;
  68   guint32 timer;
  69   guint16 n_bytes;      /* length in use, in bytes */
  70   PangoLayout *layout;
  71   gint    scroll_offset;
  72   gint    ascent;       /* font ascent, in pango units  */
  73   gint    descent;      /* font descent, in pango units  */
  74   GtkIMContext *im_context;
  75 };
  76
  77 struct _GtkEntryClass
  78 {
  79   GtkEditableClass parent_class;
  80 };
  81
  82 GtkType    gtk_entry_get_type                   (void);
  83 GtkWidget* gtk_entry_new                        (void);
  84 GtkWidget* gtk_entry_new_with_max_length        (guint16       max);
  85 void       gtk_entry_set_text                   (GtkEntry      *entry,
  86                                                  const gchar   *text);
  87 void       gtk_entry_append_text                (GtkEntry      *entry,
  88                                                  const gchar   *text);
  89 void       gtk_entry_prepend_text               (GtkEntry      *entry,
  90                                                  const gchar   *text);
  91 void       gtk_entry_set_position               (GtkEntry      *entry,
  92                                                  gint           position);
  93 /* returns a reference to the text */
  94 gchar*     gtk_entry_get_text                   (GtkEntry      *entry);
  95 void       gtk_entry_select_region              (GtkEntry      *entry,
  96                                                  gint           start,
  97                                                  gint           end);
  98 void       gtk_entry_set_visibility             (GtkEntry      *entry,
  99                                                  gboolean       visible);
 100 void       gtk_entry_set_editable               (GtkEntry      *entry,
 101                                                  gboolean       editable);
 102 /* text is truncated if needed */
 103 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 104                                                  guint16        max);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif /* __cplusplus */
 109
 110
 111 #endif /* __GTK_ENTRY_H__ */