X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkeditable.c;h=43dfd45564fc675cd5e31682d3fcb48230946ad1;hb=5bbbc47a4c306653e8347f7afb85a940a503f755;hp=16a000370e76733b38cbd0c622d9d8f0ac4a5fc9;hpb=0a07e9733bb259598a09515a3e4cdbcda5feef57;p=~andy%2Fgtk
diff --git a/gtk/gtkeditable.c b/gtk/gtkeditable.c
index 16a000370..43dfd4556 100644
--- a/gtk/gtkeditable.c
+++ b/gtk/gtkeditable.c
@@ -12,9 +12,7 @@
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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.
+ * License along with this library. If not, see .
*/
/*
@@ -24,6 +22,49 @@
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+/**
+ * SECTION:gtkeditable
+ * @Short_description: Interface for text-editing widgets
+ * @Title: GtkEditable
+ *
+ * The #GtkEditable interface is an interface which should be implemented by
+ * text editing widgets, such as #GtkEntry and #GtkSpinButton. It contains functions
+ * for generically manipulating an editable widget, a large number of action
+ * signals used for key bindings, and several signals that an application can
+ * connect to to modify the behavior of a widget.
+ *
+ * As an example of the latter usage, by connecting
+ * the following handler to #GtkEditable::insert-text, an application
+ * can convert all entry into a widget into uppercase.
+ *
+ *
+ * Forcing entry to uppercase.
+ *
+ * #include <ctype.h>
+ *
+ * void
+ * insert_text_handler (GtkEditable *editable,
+ * const gchar *text,
+ * gint length,
+ * gint *position,
+ * gpointer data)
+ * {
+ * gchar *result = g_utf8_strup (text, length);
+ *
+ * g_signal_handlers_block_by_func (editable,
+ * (gpointer) insert_text_handler, data);
+ * gtk_editable_insert_text (editable, result, length, position);
+ * g_signal_handlers_unblock_by_func (editable,
+ * (gpointer) insert_text_handler, data);
+ *
+ * g_signal_stop_emission_by_name (editable, "insert_text");
+ *
+ * g_free (result);
+ * }
+ *
+ *
+ */
+
#include "config.h"
#include
@@ -44,7 +85,7 @@ gtk_editable_get_type (void)
{
const GTypeInfo editable_info =
{
- sizeof (GtkEditableClass), /* class_size */
+ sizeof (GtkEditableInterface), /* class_size */
gtk_editable_base_init, /* base_init */
NULL, /* base_finalize */
};
@@ -69,10 +110,10 @@ gtk_editable_base_init (gpointer g_class)
* @new_text: the new text to insert
* @new_text_length: the length of the new text, in bytes,
* or -1 if new_text is nul-terminated
- * @position: the position, in characters, at which to insert
- * the new text. this is an in-out parameter.
- * After the signal emission is finished, it should
- * point after the newly inserted text.
+ * @position: (inout) (type int): the position, in characters,
+ * at which to insert the new text. this is an in-out
+ * parameter. After the signal emission is finished, it
+ * should point after the newly inserted text.
*
* This signal is emitted when text is inserted into
* the widget by the user. The default handler for
@@ -85,7 +126,7 @@ gtk_editable_base_init (gpointer g_class)
g_signal_new (I_("insert-text"),
GTK_TYPE_EDITABLE,
G_SIGNAL_RUN_LAST,
- G_STRUCT_OFFSET (GtkEditableClass, insert_text),
+ G_STRUCT_OFFSET (GtkEditableInterface, insert_text),
NULL, NULL,
_gtk_marshal_VOID__STRING_INT_POINTER,
G_TYPE_NONE, 3,
@@ -112,7 +153,7 @@ gtk_editable_base_init (gpointer g_class)
g_signal_new (I_("delete-text"),
GTK_TYPE_EDITABLE,
G_SIGNAL_RUN_LAST,
- G_STRUCT_OFFSET (GtkEditableClass, delete_text),
+ G_STRUCT_OFFSET (GtkEditableInterface, delete_text),
NULL, NULL,
_gtk_marshal_VOID__INT_INT,
G_TYPE_NONE, 2,
@@ -134,7 +175,7 @@ gtk_editable_base_init (gpointer g_class)
g_signal_new (I_("changed"),
GTK_TYPE_EDITABLE,
G_SIGNAL_RUN_LAST,
- G_STRUCT_OFFSET (GtkEditableClass, changed),
+ G_STRUCT_OFFSET (GtkEditableInterface, changed),
NULL, NULL,
_gtk_marshal_VOID__VOID,
G_TYPE_NONE, 0);
@@ -155,6 +196,8 @@ gtk_editable_base_init (gpointer g_class)
*
* Note that the position is in characters, not in bytes.
* The function updates @position to point after the newly inserted text.
+ *
+ * Virtual: do_insert_text
*/
void
gtk_editable_insert_text (GtkEditable *editable,
@@ -168,7 +211,7 @@ gtk_editable_insert_text (GtkEditable *editable,
if (new_text_length < 0)
new_text_length = strlen (new_text);
- GTK_EDITABLE_GET_CLASS (editable)->do_insert_text (editable, new_text, new_text_length, position);
+ GTK_EDITABLE_GET_IFACE (editable)->do_insert_text (editable, new_text, new_text_length, position);
}
/**
@@ -179,10 +222,12 @@ gtk_editable_insert_text (GtkEditable *editable,
*
* Deletes a sequence of characters. The characters that are deleted are
* those characters at positions from @start_pos up to, but not including
- * @end_pos. If @end_pos is negative, then the the characters deleted
+ * @end_pos. If @end_pos is negative, then the characters deleted
* are those from @start_pos to the end of the text.
*
* Note that the positions are specified in characters, not bytes.
+ *
+ * Virtual: do_delete_text
*/
void
gtk_editable_delete_text (GtkEditable *editable,
@@ -191,7 +236,7 @@ gtk_editable_delete_text (GtkEditable *editable,
{
g_return_if_fail (GTK_IS_EDITABLE (editable));
- GTK_EDITABLE_GET_CLASS (editable)->do_delete_text (editable, start_pos, end_pos);
+ GTK_EDITABLE_GET_IFACE (editable)->do_delete_text (editable, start_pos, end_pos);
}
/**
@@ -202,7 +247,7 @@ gtk_editable_delete_text (GtkEditable *editable,
*
* Retrieves a sequence of characters. The characters that are retrieved
* are those characters at positions from @start_pos up to, but not
- * including @end_pos. If @end_pos is negative, then the the characters
+ * including @end_pos. If @end_pos is negative, then the characters
* retrieved are those characters from @start_pos to the end of the text.
*
* Note that positions are specified in characters, not bytes.
@@ -218,7 +263,7 @@ gtk_editable_get_chars (GtkEditable *editable,
{
g_return_val_if_fail (GTK_IS_EDITABLE (editable), NULL);
- return GTK_EDITABLE_GET_CLASS (editable)->get_chars (editable, start_pos, end_pos);
+ return GTK_EDITABLE_GET_IFACE (editable)->get_chars (editable, start_pos, end_pos);
}
/**
@@ -240,7 +285,7 @@ gtk_editable_set_position (GtkEditable *editable,
{
g_return_if_fail (GTK_IS_EDITABLE (editable));
- GTK_EDITABLE_GET_CLASS (editable)->set_position (editable, position);
+ GTK_EDITABLE_GET_IFACE (editable)->set_position (editable, position);
}
/**
@@ -259,7 +304,7 @@ gtk_editable_get_position (GtkEditable *editable)
{
g_return_val_if_fail (GTK_IS_EDITABLE (editable), 0);
- return GTK_EDITABLE_GET_CLASS (editable)->get_position (editable);
+ return GTK_EDITABLE_GET_IFACE (editable)->get_position (editable);
}
/**
@@ -286,7 +331,7 @@ gtk_editable_get_selection_bounds (GtkEditable *editable,
g_return_val_if_fail (GTK_IS_EDITABLE (editable), FALSE);
- result = GTK_EDITABLE_GET_CLASS (editable)->get_selection_bounds (editable, &tmp_start, &tmp_end);
+ result = GTK_EDITABLE_GET_IFACE (editable)->get_selection_bounds (editable, &tmp_start, &tmp_end);
if (start_pos)
*start_pos = MIN (tmp_start, tmp_end);
@@ -322,11 +367,13 @@ gtk_editable_delete_selection (GtkEditable *editable)
*
* Selects a region of text. The characters that are selected are
* those characters at positions from @start_pos up to, but not
- * including @end_pos. If @end_pos is negative, then the the
+ * including @end_pos. If @end_pos is negative, then the
* characters selected are those characters from @start_pos to
* the end of the text.
*
* Note that positions are specified in characters, not bytes.
+ *
+ * Virtual: set_selection_bounds
*/
void
gtk_editable_select_region (GtkEditable *editable,
@@ -335,7 +382,7 @@ gtk_editable_select_region (GtkEditable *editable,
{
g_return_if_fail (GTK_IS_EDITABLE (editable));
- GTK_EDITABLE_GET_CLASS (editable)->set_selection_bounds (editable, start_pos, end_pos);
+ GTK_EDITABLE_GET_IFACE (editable)->set_selection_bounds (editable, start_pos, end_pos);
}
/**