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 #endif /* __cplusplus */
  30
  31
  32 #define GTK_TYPE_ENTRY                  (gtk_entry_get_type ())
  33 #define GTK_ENTRY(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_ENTRY, GtkEntry))
  34 #define GTK_ENTRY_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY, GtkEntryClass))
  35 #define GTK_IS_ENTRY(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_ENTRY))
  36 #define GTK_IS_ENTRY_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY))
  37
  38
  39 typedef struct _GtkEntry       GtkEntry;
  40 typedef struct _GtkEntryClass  GtkEntryClass;
  41
  42 struct _GtkEntry
  43 {
  44   GtkEditable editable;
  45
  46   GdkWindow *text_area;
  47   GdkPixmap *backing_pixmap;
  48   GdkCursor *cursor;
  49   GdkWChar  *text;
  50
  51   guint16 text_size;    /* allocated size */
  52   guint16 text_length;  /* length in use */
  53   guint16 text_max_length;
  54   gint    scroll_offset;
  55   guint   visible : 1;
  56   guint32 timer;
  57   guint   button;
  58
  59   /* The x-offset of each character (including the last insertion position)
  60    * only valid when the widget is realized */
  61   gint   *char_offset;
  62
  63   /* Same as 'text', but in multibyte */
  64   gchar  *text_mb;
  65   /* If true, 'text' and 'text_mb' are not coherent */
  66   guint   text_mb_dirty : 1;
  67   /* If true, we use the encoding of wchar_t as the encoding of 'text'.
  68    * Otherwise we use the encoding of multi-byte characters instead. */
  69   guint   use_wchar : 1;
  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 /* returns a reference to the text */
  89 gchar*     gtk_entry_get_text                   (GtkEntry      *entry);
  90 void       gtk_entry_select_region              (GtkEntry      *entry,
  91                                                  gint           start,
  92                                                  gint           end);
  93 void       gtk_entry_set_visibility             (GtkEntry      *entry,
  94                                                  gboolean       visible);
  95 void       gtk_entry_set_editable               (GtkEntry      *entry,
  96                                                  gboolean       editable);
  97 /* text is truncated if needed */
  98 void       gtk_entry_set_max_length             (GtkEntry      *entry,
  99                                                  guint16        max);
 100 /* deprecated function. The only reason why it is public
 101  * is that there were bugs in GtkEntry. IT WILL DISAPPEAR.
 102  */
 103 void       gtk_entry_adjust_scroll              (GtkEntry      *entry);
 104
 105 #ifdef __cplusplus
 106 }
 107 #endif /* __cplusplus */
 108
 109
 110 #endif /* __GTK_ENTRY_H__ */