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 Library 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  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library 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 #ifndef __GTK_ENTRY_H__
  20 #define __GTK_ENTRY_H__
  21
  22
  23 #include <gdk/gdk.h>
  24 #include <gtk/gtkeditable.h>
  25
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #pragma }
  30 #endif /* __cplusplus */
  31
  32
  33 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  34 #define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  35 #define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  36 #define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
  37 #define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  38
  39
  40 typedef struct _GtkEntry       GtkEntry;
  41 typedef struct _GtkEntryClass  GtkEntryClass;
  42
  43 struct _GtkEntry
  44 {
  45   GtkEditable editable;
  46
  47   GdkWindow *text_area;
  48   GdkPixmap *backing_pixmap;
  49   GdkCursor *cursor;
  50   gchar *text;
  51
  52   guint16 text_size;
  53   guint16 text_length;
  54   guint16 text_max_length;
  55   gint    scroll_offset;
  56   guint   visible : 1;
  57   guint32 timer;
  58   guint   button;
  59
  60   /* The total number of characters (not bytes) in the entry */
  61   guint nchars;
  62
  63   /* The byte offset of each character
  64    *  (including the last insertion position) */
  65   guint16 *char_pos;
  66
  67   /* The x-offset of each character (including the last insertion position)
  68    * only valid when the widget is realized */
  69   gint *char_offset;
  70 };
  71
  72 struct _GtkEntryClass
  73 {
  74   GtkEditableClass parent_class;
  75 };
  76
  77 GtkType    gtk_entry_get_type                   (void);
  78 GtkWidget* gtk_entry_new                        (void);
  79 GtkWidget* gtk_entry_new_with_max_length        (guint16   max);
  80 void       gtk_entry_set_text                   (GtkEntry      *entry,
  81                                                  const gchar   *text);
  82 void       gtk_entry_append_text                (GtkEntry      *entry,
  83                                                  const gchar   *text);
  84 void       gtk_entry_prepend_text               (GtkEntry      *entry,
  85                                                  const gchar   *text);
  86 void       gtk_entry_set_position               (GtkEntry      *entry,
  87                                                  gint           position);
  88 gchar*     gtk_entry_get_text                   (GtkEntry      *entry);
  89 void       gtk_entry_select_region              (GtkEntry      *entry,
  90                                                  gint           start,
  91                                                  gint           end);
  92 void       gtk_entry_set_visibility             (GtkEntry      *entry,
  93                                                  gboolean       visible);
  94 void       gtk_entry_set_editable               (GtkEntry      *entry,
  95                                                  gboolean       editable);
  96 /* DO NOT USE THIS FUNCTION. The only reason why it is public
  97  * is that there were bugs in GtkEntry. IT WILL DISAPPEAR. */
  98 void       gtk_entry_adjust_scroll              (GtkEntry      *entry);
  99 /* text is truncated if needed */
 100 void       gtk_entry_set_max_length             (GtkEntry      *entry,
 101                                                  guint16        max);
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif /* __cplusplus */
 106
 107
 108 #endif /* __GTK_ENTRY_H__ */