summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStef Walter <stef@memberwebs.com>2009-07-08 20:41:53 -0500
committerStef Walter <stef@memberwebs.com>2009-07-08 20:41:53 -0500
commiteab02f697a29f2bfd388f6318adf18e2936e7e96 (patch)
treea35e51f9844f498b8cdea61661e197a5c8aa8722 /docs
parent9ef87ea11e7d2b50d5222e5429b8a65a0f665162 (diff)
downloadgtk+-eab02f697a29f2bfd388f6318adf18e2936e7e96.tar.gz
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.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/gtk/gtk-docs.sgml1
-rw-r--r--docs/reference/gtk/gtk-sections.txt31
-rw-r--r--docs/reference/gtk/gtk.types1
-rw-r--r--docs/reference/gtk/tmpl/gtk-unused.sgml19
-rw-r--r--docs/reference/gtk/tmpl/gtkentry.sgml32
-rw-r--r--docs/reference/gtk/tmpl/gtkentrybuffer.sgml168
6 files changed, 252 insertions, 0 deletions
diff --git a/docs/reference/gtk/gtk-docs.sgml b/docs/reference/gtk/gtk-docs.sgml
index 16a59b0f1e..9b65c5ec77 100644
--- a/docs/reference/gtk/gtk-docs.sgml
+++ b/docs/reference/gtk/gtk-docs.sgml
@@ -177,6 +177,7 @@ that is, GUI components such as #GtkButton or #GtkTextView.
<chapter id="NumericEntry">
<title>Numeric/Text Data Entry</title>
<xi:include href="xml/gtkentry.xml" />
+ <xi:include href="xml/gtkentrybuffer.xml" />
<xi:include href="xml/gtkentrycompletion.xml" />
<xi:include href="xml/gtkhscale.xml" />
<xi:include href="xml/gtkvscale.xml" />
diff --git a/docs/reference/gtk/gtk-sections.txt b/docs/reference/gtk/gtk-sections.txt
index bb19dec3a6..331157dfb4 100644
--- a/docs/reference/gtk/gtk-sections.txt
+++ b/docs/reference/gtk/gtk-sections.txt
@@ -1268,7 +1268,10 @@ gtk_old_editable_get_type
<TITLE>GtkEntry</TITLE>
GtkEntry
gtk_entry_new
+gtk_entry_new_with_buffer
gtk_entry_new_with_max_length
+gtk_entry_get_buffer
+gtk_entry_set_buffer
gtk_entry_set_text
gtk_entry_append_text
gtk_entry_prepend_text
@@ -1343,6 +1346,34 @@ gtk_entry_get_type
</SECTION>
<SECTION>
+<FILE>gtkentrybuffer</FILE>
+<TITLE>GtkEntryBuffer</TITLE>
+GtkEntryBuffer
+gtk_entry_buffer_new
+gtk_entry_buffer_get_text
+gtk_entry_buffer_set_text
+gtk_entry_buffer_get_bytes
+gtk_entry_buffer_get_length
+gtk_entry_buffer_get_max_length
+gtk_entry_buffer_set_max_length
+gtk_entry_buffer_insert_text
+gtk_entry_buffer_delete_text
+gtk_entry_buffer_emit_deleted_text
+gtk_entry_buffer_emit_inserted_text
+
+<SUBSECTION Standard>
+GTK_ENTRY_BUFFER
+GTK_IS_ENTRY_BUFFER
+GTK_TYPE_ENTRY_BUFFER
+GTK_ENTRY_BUFFER_CLASS
+GTK_IS_ENTRY_BUFFER_CLASS
+GTK_ENTRY_BUFFER_GET_CLASS
+GTK_ENTRY_BUFFER_MAX_SIZE
+<SUBSECTION Private>
+gtk_entry_buffer_get_type
+</SECTION>
+
+<SECTION>
<FILE>gtkentrycompletion</FILE>
<TITLE>GtkEntryCompletion</TITLE>
GtkEntryCompletion
diff --git a/docs/reference/gtk/gtk.types b/docs/reference/gtk/gtk.types
index 126f673bb1..d743aa1e1a 100644
--- a/docs/reference/gtk/gtk.types
+++ b/docs/reference/gtk/gtk.types
@@ -48,6 +48,7 @@ gtk_curve_get_type
gtk_dialog_get_type
gtk_drawing_area_get_type
gtk_editable_get_type
+gtk_entry_buffer_get_type
gtk_entry_completion_get_type
gtk_entry_get_type
gtk_event_box_get_type
diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml
index cb2a663eff..420d945397 100644
--- a/docs/reference/gtk/tmpl/gtk-unused.sgml
+++ b/docs/reference/gtk/tmpl/gtk-unused.sgml
@@ -1033,6 +1033,25 @@ You may not attach these to signals created with the
</para>
+<!-- ##### STRUCT GtkEntryBufferClass ##### -->
+<para>
+
+</para>
+
+@parent_class:
+@inserted_text:
+@deleted_text:
+@get_text:
+@get_length:
+@insert_text:
+@delete_text:
+@_gtk_reserved0:
+@_gtk_reserved1:
+@_gtk_reserved2:
+@_gtk_reserved3:
+@_gtk_reserved4:
+@_gtk_reserved5:
+
<!-- ##### ARG GtkFileChooser:file-system ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkentry.sgml b/docs/reference/gtk/tmpl/gtkentry.sgml
index 385e7235e7..59a95c68fb 100644
--- a/docs/reference/gtk/tmpl/gtkentry.sgml
+++ b/docs/reference/gtk/tmpl/gtkentry.sgml
@@ -173,6 +173,11 @@ The #GtkEntry-struct struct contains only private data.
</para>
+<!-- ##### ARG GtkEntry:buffer ##### -->
+<para>
+
+</para>
+
<!-- ##### ARG GtkEntry:caps-lock-warning ##### -->
<para>
@@ -401,6 +406,15 @@ The #GtkEntry-struct struct contains only private data.
@Returns:
+<!-- ##### FUNCTION gtk_entry_new_with_buffer ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
<!-- ##### FUNCTION gtk_entry_new_with_max_length ##### -->
<para>
</para>
@@ -409,6 +423,24 @@ The #GtkEntry-struct struct contains only private data.
@Returns:
+<!-- ##### FUNCTION gtk_entry_get_buffer ##### -->
+<para>
+
+</para>
+
+@entry:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_set_buffer ##### -->
+<para>
+
+</para>
+
+@entry:
+@buffer:
+
+
<!-- ##### FUNCTION gtk_entry_set_text ##### -->
<para>
diff --git a/docs/reference/gtk/tmpl/gtkentrybuffer.sgml b/docs/reference/gtk/tmpl/gtkentrybuffer.sgml
new file mode 100644
index 0000000000..712f013153
--- /dev/null
+++ b/docs/reference/gtk/tmpl/gtkentrybuffer.sgml
@@ -0,0 +1,168 @@
+<!-- ##### SECTION Title ##### -->
+GtkEntryBuffer
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT GtkEntryBuffer ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL GtkEntryBuffer::deleted-text ##### -->
+<para>
+
+</para>
+
+@entrybuffer: the object which received the signal.
+@arg1:
+@arg2:
+
+<!-- ##### SIGNAL GtkEntryBuffer::inserted-text ##### -->
+<para>
+
+</para>
+
+@entrybuffer: the object which received the signal.
+@arg1:
+@arg2:
+@arg3:
+
+<!-- ##### ARG GtkEntryBuffer:length ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkEntryBuffer:max-length ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkEntryBuffer:text ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gtk_entry_buffer_new ##### -->
+<para>
+
+</para>
+
+@initial_chars:
+@n_initial_chars:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_get_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_set_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@chars:
+@n_chars:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_get_bytes ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_get_length ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_get_max_length ##### -->
+<para>
+
+</para>
+
+@buffer:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_set_max_length ##### -->
+<para>
+
+</para>
+
+@buffer:
+@max_length:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_insert_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@position:
+@chars:
+@n_chars:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_delete_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@position:
+@n_chars:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_emit_deleted_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@position:
+@n_chars:
+
+
+<!-- ##### FUNCTION gtk_entry_buffer_emit_inserted_text ##### -->
+<para>
+
+</para>
+
+@buffer:
+@position:
+@chars:
+@n_chars:
+
+