Gtk.CellEditable

g GObject.GInterface GObject.GInterface Gtk.CellEditable Gtk.CellEditable GObject.GInterface->Gtk.CellEditable

Implementations:
 Gtk.ComboBox, Gtk.Entry

Methods

  editing_done ()
  remove_widget ()
  start_editing (event)

Virtual Methods

  do_editing_done ()
  do_remove_widget ()
  do_start_editing (event)

Properties

Name Type Flags Short Description
editing-canceled bool r/w/en Indicates that editing has been canceled

Signals

Name Short Description
editing-done This signal is a sign for the cell renderer to update its value from the cell_editable.
remove-widget 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.

Fields

None

Class Details

class Gtk.CellEditable
Bases:GObject.GInterface
Structure:Gtk.CellEditableIface

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

editing_done()[source]

Emits the Gtk.CellEditable ::editing-done signal.

remove_widget()[source]

Emits the Gtk.CellEditable ::remove-widget signal.

start_editing(event)[source]
Parameters:event (Gdk.Event or None) – The Gdk.Event that began the editing process, or None if editing was initiated programmatically

Begins editing on a self.

The Gtk.CellRenderer for the cell creates and returns a Gtk.CellEditable from Gtk.CellRenderer.start_editing(), configured for the Gtk.CellRenderer type.

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

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

do_editing_done() virtual

Emits the Gtk.CellEditable ::editing-done signal.

do_remove_widget() virtual

Emits the Gtk.CellEditable ::remove-widget signal.

do_start_editing(event) virtual
Parameters:event (Gdk.Event or None) – The Gdk.Event that began the editing process, or None if editing was initiated programmatically

Begins editing on a cell_editable.

The Gtk.CellRenderer for the cell creates and returns a Gtk.CellEditable from Gtk.CellRenderer.start_editing(), configured for the Gtk.CellRenderer type.

Gtk.CellEditable.start_editing() can then set up cell_editable suitably for editing a cell, e.g. making the Esc key emit Gtk.CellEditable ::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.

Signal Details

Gtk.CellEditable.signals.editing_done(cell_editable)
Signal Name:editing-done
Flags:RUN_LAST
Parameters:cell_editable (Gtk.CellEditable) – The object which received the signal

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

Implementations of Gtk.CellEditable are responsible for emitting this signal when they are done editing, e.g. Gtk.Entry 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 Gtk.CellRenderer, etc.

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

Gtk.CellEditable.signals.remove_widget(cell_editable)
Signal Name:remove-widget
Flags:RUN_LAST
Parameters:cell_editable (Gtk.CellEditable) – The object which received the signal

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 Gtk.CellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the Gtk.CellEditable ::editing-done signal, to give the cell renderer a chance to update the cell’s value before the widget is removed.

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

Property Details

Gtk.CellEditable.props.editing_canceled
Name:editing-canceled
Type:bool
Default Value:False
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Indicates whether editing on the cell has been canceled.

New in version 2.20.