Editable
- class Editable(*args, **kwargs)
Implementations: EditableLabel
, Entry
, PasswordEntry
, SearchEntry
, SpinButton
, Text
GtkEditable
is an interface for text editing widgets.
Typical examples of editable widgets are Entry
and
SpinButton
. 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 modify the behavior
of a widget.
As an example of the latter usage, by connecting the following handler to
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 char *text,
int length,
int *position,
gpointer data)
{
char *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);
}
Implementing GtkEditable
The most likely scenario for implementing GtkEditable
on your own widget
is that you will embed a GtkText
inside a complex widget, and want to
delegate the editable functionality to that text widget. GtkEditable
provides some utility functions to make this easy.
In your class_init function, call install_properties
,
passing the first available property ID:
static void
my_class_init (MyClass *class)
{
...
g_object_class_install_properties (object_class, NUM_PROPERTIES, props);
gtk_editable_install_properties (object_clas, NUM_PROPERTIES);
...
}
In your interface_init function for the GtkEditable
interface, provide
an implementation for the get_delegate vfunc that returns your text widget:
GtkEditable *
get_editable_delegate (GtkEditable *editable)
{
return GTK_EDITABLE (MY_WIDGET (editable)->text_widget);
}
static void
my_editable_init (GtkEditableInterface *iface)
{
iface->get_delegate = get_editable_delegate;
}
You don’t need to provide any other vfuncs. The default implementations work by forwarding to the delegate that the GtkEditableInterface.get_delegate() vfunc returns.
In your instance_init function, create your text widget, and then call
init_delegate
:
static void
my_widget_init (MyWidget *self)
{
...
self->text_widget = gtk_text_new ();
gtk_editable_init_delegate (GTK_EDITABLE (self));
...
}
In your dispose function, call finish_delegate
before
destroying your text widget:
static void
my_widget_dispose (GObject *object)
{
...
gtk_editable_finish_delegate (GTK_EDITABLE (self));
g_clear_pointer (&self->text_widget, gtk_widget_unparent);
...
}
Finally, use delegate_set_property
in your set_property
function (and similar for get_property
), to set the editable properties:
...
if (gtk_editable_delegate_set_property (object, prop_id, value, pspec))
return;
switch (prop_id)
...
It is important to note that if you create a GtkEditable
that uses
a delegate, the low level insert_text
and
delete_text
signals will be propagated from the
“wrapper” editable to the delegate, but they will not be propagated from
the delegate to the “wrapper” editable, as they would cause an infinite
recursion. If you wish to connect to the insert_text
and delete_text
signals, you will need to connect
to them on the delegate obtained via get_delegate
.
Methods
- class Editable
- delegate_get_accessible_platform_state(state: AccessiblePlatformState) bool
Retrieves the accessible platform state from the editable delegate.
This is an helper function to retrieve the accessible state for
GtkEditable
interface implementations using a delegate pattern.You should call this function in your editable widget implementation of the
get_platform_state
virtual function, for instance:static void accessible_interface_init (GtkAccessibleInterface *iface) { iface->get_platform_state = your_editable_get_accessible_platform_state; } static gboolean your_editable_get_accessible_platform_state (GtkAccessible *accessible, GtkAccessiblePlatformState state) { return gtk_editable_delegate_get_accessible_platform_state (GTK_EDITABLE (accessible), state); }
Added in version 4.10.
- Parameters:
state – what kind of accessible state to retrieve
- delegate_get_property(object: Object, prop_id: int, value: Any, pspec: ParamSpec) bool
Gets a property of the
GtkEditable
delegate forobject
.This is helper function that should be called in the
get_property
function of yourGtkEditable
implementation, before handling your own properties.- Parameters:
object – a
GObject
prop_id – a property ID
value – value to set
pspec – the
GParamSpec
for the property
- delegate_set_property(object: Object, prop_id: int, value: Any, pspec: ParamSpec) bool
Sets a property on the
GtkEditable
delegate forobject
.This is a helper function that should be called in the
set_property
function of yourGtkEditable
implementation, before handling your own properties.- Parameters:
object – a
GObject
prop_id – a property ID
value – value to set
pspec – the
GParamSpec
for the property
- delete_selection() None
Deletes the currently selected text of the editable.
This call doesn’t do anything if there is no selected text.
- delete_text(start_pos: int, end_pos: int) None
Deletes a sequence of characters.
The characters that are deleted are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters deleted are those fromstart_pos
to the end of the text.Note that the positions are specified in characters, not bytes.
- Parameters:
start_pos – start position
end_pos – end position
- finish_delegate() None
Undoes the setup done by
init_delegate
.This is a helper function that should be called from dispose, before removing the delegate object.
- get_chars(start_pos: int, end_pos: int) str
Retrieves a sequence of characters.
The characters that are retrieved are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters retrieved are those characters fromstart_pos
to the end of the text.Note that positions are specified in characters, not bytes.
- Parameters:
start_pos – start of text
end_pos – end of text
- get_delegate() Editable | None
Gets the
GtkEditable
thateditable
is delegating its implementation to.Typically, the delegate is a
Text
widget.
- get_position() int
Retrieves the current position of the cursor relative to the start of the content of the editable.
Note that this position is in characters, not in bytes.
- get_selection_bounds() tuple[bool, int, int]
Retrieves the selection bound of the editable.
start_pos
will be filled with the start of the selection andend_pos
with end. If no text was selected both will be identical andFalse
will be returned.Note that positions are specified in characters, not bytes.
- get_text() str
Retrieves the contents of
editable
.The returned string is owned by GTK and must not be modified or freed.
- get_width_chars() int
Gets the number of characters of space reserved for the contents of the editable.
- init_delegate() None
Sets up a delegate for
GtkEditable
.This is assuming that the get_delegate vfunc in the
GtkEditable
interface has been set up for theeditable
’s type.This is a helper function that should be called in instance init, after creating the delegate object.
- insert_text(text, position)
Inserts
length
bytes oftext
into the contents of the widget, at positionposition
.Note that the position is in characters, not in bytes. The function updates
position
to point after the newly inserted text.- Parameters:
text – the text to insert
position – location of the position text will be inserted at
- install_properties(object_class: ObjectClass, first_prop: int) int
Overrides the
GtkEditable
properties forclass
.This is a helper function that should be called in class_init, after installing your own properties.
Note that your class must have “text”, “cursor-position”, “selection-bound”, “editable”, “width-chars”, “max-width-chars”, “xalign” and “enable-undo” properties for this function to work.
To handle the properties in your set_property and get_property functions, you can either use
delegate_set_property
anddelegate_get_property
(if you are using a delegate), or remember thefirst_prop
offset and add it to the values in theEditableProperties
enumeration to get the property IDs for these properties.- Parameters:
object_class – a
GObjectClass
first_prop – property ID to use for the first property
- select_region(start_pos: int, end_pos: int) None
Selects a region of text.
The characters that are selected are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters selected are those characters fromstart_pos
to the end of the text.Note that positions are specified in characters, not bytes.
- Parameters:
start_pos – start of region
end_pos – end of region
- set_alignment(xalign: float) None
Sets the alignment for the contents of the editable.
This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the editable.
- Parameters:
xalign – The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts
- set_editable(is_editable: bool) None
Determines if the user can edit the text in the editable widget.
- Parameters:
is_editable –
True
if the user is allowed to edit the text in the widget
- set_enable_undo(enable_undo: bool) None
If enabled, changes to
editable
will be saved for undo/redo actions.This results in an additional copy of text changes and are not stored in secure memory. As such, undo is forcefully disabled when
visibility
is set toFalse
.- Parameters:
enable_undo – if undo/redo should be enabled
- set_max_width_chars(n_chars: int) None
Sets the desired maximum width in characters of
editable
.- Parameters:
n_chars – the new desired maximum width, in characters
- set_position(position: int) None
Sets the cursor position in the editable to the given value.
The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or equal to the number of characters in the editable. A value of -1 indicates that the position should be set after the last character of the editable. Note that
position
is in characters, not in bytes.- Parameters:
position – the position of the cursor
- set_text(text: str) None
Sets the text in the editable to the given value.
This is replacing the current contents.
- Parameters:
text – the text to set
- set_width_chars(n_chars: int) None
Changes the size request of the editable to be about the right size for
n_chars
characters.Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If
n_chars
is -1, the size reverts to the default size.- Parameters:
n_chars – width in chars
Properties
Signals
- class Editable.signals
- changed() None
Emitted at the end of a single user-visible operation on the contents.
E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).
- delete_text(start_pos: int, end_pos: int) None
Emitted when text is deleted from the widget by the user.
The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with
signal_stop_emission()
, it is possible to modify the range of deleted text, or prevent it from being deleted entirely.The
start_pos
andend_pos
parameters are interpreted as fordelete_text
.- Parameters:
start_pos – the starting position
end_pos – the end position
- insert_text(text: str, length: int) int
Emitted when text is inserted into the widget by the user.
The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with
signal_stop_emission()
, it is possible to modify the inserted text, or prevent it from being inserted entirely.- Parameters:
text – the new text to insert
length – the length of the new text, in bytes, or -1 if new_text is nul-terminated
Virtual Methods
- class Editable
-
- do_delete_text(start_pos: int, end_pos: int) None
Deletes a sequence of characters.
The characters that are deleted are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters deleted are those fromstart_pos
to the end of the text.Note that the positions are specified in characters, not bytes.
- Parameters:
start_pos – start position
end_pos – end position
- do_do_delete_text(start_pos: int, end_pos: int) None
Deletes a sequence of characters.
The characters that are deleted are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters deleted are those fromstart_pos
to the end of the text.Note that the positions are specified in characters, not bytes.
- Parameters:
start_pos – start position
end_pos – end position
- do_do_insert_text(text: str, length: int) int
Inserts
length
bytes oftext
into the contents of the widget, at positionposition
.Note that the position is in characters, not in bytes. The function updates
position
to point after the newly inserted text.- Parameters:
text – the text to insert
length – the length of the text in bytes, or -1
- do_get_delegate() Editable | None
Gets the
GtkEditable
thateditable
is delegating its implementation to.Typically, the delegate is a
Text
widget.
- do_get_selection_bounds() tuple[bool, int, int]
Retrieves the selection bound of the editable.
start_pos
will be filled with the start of the selection andend_pos
with end. If no text was selected both will be identical andFalse
will be returned.Note that positions are specified in characters, not bytes.
- do_get_text() str
Retrieves the contents of
editable
.The returned string is owned by GTK and must not be modified or freed.
- do_insert_text(text: str, length: int) int
Inserts
length
bytes oftext
into the contents of the widget, at positionposition
.Note that the position is in characters, not in bytes. The function updates
position
to point after the newly inserted text.- Parameters:
text – the text to insert
length – the length of the text in bytes, or -1
- do_set_selection_bounds(start_pos: int, end_pos: int) None
Selects a region of text.
The characters that are selected are those characters at positions from
start_pos
up to, but not includingend_pos
. Ifend_pos
is negative, then the characters selected are those characters fromstart_pos
to the end of the text.Note that positions are specified in characters, not bytes.
- Parameters:
start_pos – start of region
end_pos – end of region