GtkEntryBuffer holds text for GtkEntry

Adds a 'model' type buffer for GtkEntry in which the actual
textual data is stored. GtkEntryBuffer can be subclassed.

Among other things, this allows GtkEntry to be used for secrets
that need to be stored in non-pageable memory. It also allows
buffers to be shared by entries.

See bug #576801.

1 files changed, 133 insertions, 0 deletions

diff --git a/gtk/gtkentrybuffer.h b/gtk/gtkentrybuffer.h
new file mode 100644
index 0000000000..275aaa1b3b
--- /dev/null
+++ b/gtk/gtkentrybuffer.h
@@ -0,0 +1,133 @@
+/* gtkentrybuffer.h
+ * Copyright (C) 2009  Stefan Walter <stef@memberwebs.com>
+ *
+ * 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
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#ifndef __GTK_ENTRY_BUFFER_H__
+#define __GTK_ENTRY_BUFFER_H__
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+/* Maximum size of text buffer, in bytes */
+#define GTK_ENTRY_BUFFER_MAX_SIZE        G_MAXUSHORT
+
+#define GTK_TYPE_ENTRY_BUFFER            (gtk_entry_buffer_get_type ())
+#define GTK_ENTRY_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_ENTRY_BUFFER, GtkEntryBuffer))
+#define GTK_ENTRY_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_ENTRY_BUFFER, GtkEntryBufferClass))
+#define GTK_IS_ENTRY_BUFFER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_ENTRY_BUFFER))
+#define GTK_IS_ENTRY_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_ENTRY_BUFFER))
+#define GTK_ENTRY_BUFFER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_ENTRY_BUFFER, GtkEntryBufferClass))
+
+typedef struct _GtkEntryBuffer            GtkEntryBuffer;
+typedef struct _GtkEntryBufferClass       GtkEntryBufferClass;
+typedef struct _GtkEntryBufferPrivate     GtkEntryBufferPrivate;
+
+struct _GtkEntryBuffer
+{
+  GObject parent_instance;
+
+  /*< private >*/
+  GtkEntryBufferPrivate *priv;
+};
+
+struct _GtkEntryBufferClass
+{
+  GObjectClass parent_class;
+
+  /* Signals */
+
+  void         (*inserted_text)          (GtkEntryBuffer *buffer,
+                                          guint           position,
+                                          const gchar    *chars,
+                                          guint           n_chars);
+
+  void         (*deleted_text)           (GtkEntryBuffer *buffer,
+                                          guint           position,
+                                          guint           n_chars);
+
+  /* Virtual Methods */
+
+  const gchar* (*get_text)               (GtkEntryBuffer *buffer,
+                                          gsize          *n_bytes);
+
+  guint        (*get_length)             (GtkEntryBuffer *buffer);
+
+  guint        (*insert_text)            (GtkEntryBuffer *buffer,
+                                          guint           position,
+                                          const gchar    *chars,
+                                          guint           n_chars);
+
+  guint        (*delete_text)            (GtkEntryBuffer *buffer,
+                                          guint           position,
+                                          guint           n_chars);
+
+  /* Padding for future expansion */
+  void (*_gtk_reserved0) (void);
+  void (*_gtk_reserved1) (void);
+  void (*_gtk_reserved2) (void);
+  void (*_gtk_reserved3) (void);
+  void (*_gtk_reserved4) (void);
+  void (*_gtk_reserved5) (void);
+};
+
+GType                     gtk_entry_buffer_get_type               (void) G_GNUC_CONST;
+
+GtkEntryBuffer*           gtk_entry_buffer_new                    (const gchar     *initial_chars,
+                                                                   gint             n_initial_chars);
+
+gsize                     gtk_entry_buffer_get_bytes              (GtkEntryBuffer  *buffer);
+
+guint                     gtk_entry_buffer_get_length             (GtkEntryBuffer  *buffer);
+
+const gchar*              gtk_entry_buffer_get_text               (GtkEntryBuffer  *buffer);
+
+void                      gtk_entry_buffer_set_text               (GtkEntryBuffer  *buffer,
+                                                                   const gchar     *chars,
+                                                                   gint             n_chars);
+
+void                      gtk_entry_buffer_set_max_length         (GtkEntryBuffer  *buffer,
+                                                                   guint            max_length);
+
+guint                     gtk_entry_buffer_get_max_length         (GtkEntryBuffer  *buffer);
+
+guint                     gtk_entry_buffer_insert_text            (GtkEntryBuffer  *buffer,
+                                                                   guint            position,
+                                                                   const gchar     *chars,
+                                                                   gint             n_chars);
+
+guint                     gtk_entry_buffer_delete_text            (GtkEntryBuffer  *buffer,
+                                                                   guint            position,
+                                                                   gint             n_chars);
+
+void                      gtk_entry_buffer_emit_inserted_text     (GtkEntryBuffer  *buffer,
+                                                                   guint            position,
+                                                                   const gchar     *chars,
+                                                                   guint            n_chars);
+
+void                      gtk_entry_buffer_emit_deleted_text      (GtkEntryBuffer  *buffer,
+                                                                   guint            position,
+                                                                   guint            n_chars);
+
+G_END_DECLS
+
+#endif /* __GTK_ENTRY_BUFFER_H__ */