CellEditable

Deprecated since version 4.10: List views use widgets for displaying their contents. See Editable for editable text widgets

class CellEditable(*args, **kwargs)

Implementations: ComboBox, ComboBoxText, Entry, SpinButton

Interface for widgets that can be used for editing cells

The GtkCellEditable interface must be implemented for widgets to be usable to edit the contents of a GtkTreeView cell. It provides a way to specify how temporary widgets should be configured for editing, get the new value, etc.

Methods

class CellEditable

editing_done() → None

Emits the GtkCellEditable::editing-done signal.

Deprecated since version 4.10: Please do not use it in newly written code

remove_widget() → None

Emits the GtkCellEditable::remove-widget signal.

Deprecated since version 4.10: Please do not use it in newly written code

start_editing(event: Event | None = None) → None

Begins editing on a cell_editable.

The GtkCellRenderer for the cell creates and returns a GtkCellEditable from start_editing(), configured for the GtkCellRenderer type.

start_editing() can then set up cell_editable suitably for editing a cell, e.g. making the Esc key emit GtkCellEditable::editing-done.

Note that the cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells.

Parameters:

event – The GdkEvent that began the editing process, or None if editing was initiated programmatically

Properties

class CellEditable

props.editing_canceled: bool

Indicates whether editing on the cell has been canceled.

Signals

class CellEditable.signals

editing_done() → None

This signal is a sign for the cell renderer to update its value from the cell_editable.

Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing, e.g. GtkEntry emits this signal when the user presses Enter. Typical things to do in a handler for ::editing-done are to capture the edited value, disconnect the cell_editable from signals on the GtkCellRenderer, etc.

editing_done() is a convenience method for emitting GtkCellEditable::editing-done.

remove_widget() → None

This signal is meant to indicate that the cell is finished editing, and the cell_editable widget is being removed and may subsequently be destroyed.

Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the GtkCellEditable::editing-done signal, to give the cell renderer a chance to update the cell’s value before the widget is removed.

remove_widget() is a convenience method for emitting GtkCellEditable::remove-widget.

Virtual Methods

class CellEditable

do_editing_done() → None

Emits the GtkCellEditable::editing-done signal.

Deprecated since version 4.10: Please do not use it in newly written code

do_remove_widget() → None

Emits the GtkCellEditable::remove-widget signal.

Deprecated since version 4.10: Please do not use it in newly written code

do_start_editing(event: Event | None = None) → None

Begins editing on a cell_editable.

The GtkCellRenderer for the cell creates and returns a GtkCellEditable from start_editing(), configured for the GtkCellRenderer type.

start_editing() can then set up cell_editable suitably for editing a cell, e.g. making the Esc key emit GtkCellEditable::editing-done.

Note that the cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells.

Parameters:

event – The GdkEvent that began the editing process, or None if editing was initiated programmatically