GI.Gtk.Interfaces.CellEditable

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

Exported types

newtype CellEditable

Memory-managed wrapper type.

Constructors

CellEditable (ManagedPtr CellEditable)

Instances

Eq CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

Methods

(==) :: CellEditable -> CellEditable -> Bool

(/=) :: CellEditable -> CellEditable -> Bool

GObject CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

ManagedPtrNewtype CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

Methods

toManagedPtr :: CellEditable -> ManagedPtr CellEditable

TypedObject CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

Methods

glibType :: IO GType

IsGValue CellEditable

Convert CellEditable to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Interfaces.CellEditable

Methods

toGValue :: CellEditable -> IO GValue

fromGValue :: GValue -> IO CellEditable

HasParentTypes CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

type ParentTypes CellEditable

Defined in GI.Gtk.Interfaces.CellEditable

type ParentTypes CellEditable = '[Object, Widget]

class (GObject o, IsDescendantOf CellEditable o) => IsCellEditable o

Type class for types which can be safely cast to CellEditable, for instance with toCellEditable.

Instances

(GObject o, IsDescendantOf CellEditable o) => IsCellEditable o

Defined in GI.Gtk.Interfaces.CellEditable

toCellEditable :: (MonadIO m, IsCellEditable o) => o -> m CellEditable

Cast to CellEditable, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

editingDone

cellEditableEditingDone

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a)

=> a

cellEditable: A CellEditable

-> m ()

Emits the editingDone signal.

removeWidget

cellEditableRemoveWidget

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a)

=> a

cellEditable: A CellEditable

-> m ()

Emits the removeWidget signal.

startEditing

cellEditableStartEditing

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a)

=> a

cellEditable: A CellEditable

-> Maybe Event

event: The Event that began the editing process, or Nothing if editing was initiated programmatically

-> m ()

Begins editing on a cellEditable.

The CellRenderer for the cell creates and returns a CellEditable from cellRendererStartEditing, configured for the CellRenderer type.

cellEditableStartEditing can then set up cellEditable suitably for editing a cell, e.g. making the Esc key emit editingDone.

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

Properties

editingCanceled

Indicates whether editing on the cell has been canceled.

Since: 2.20

constructCellEditableEditingCanceled :: (IsCellEditable o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “editing-canceled” property. This is rarely needed directly, but it is used by new.

getCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> m Bool

Get the value of the “editing-canceled” property. When overloading is enabled, this is equivalent to

get cellEditable #editingCanceled

setCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> Bool -> m ()

Set the value of the “editing-canceled” property. When overloading is enabled, this is equivalent to

set cellEditable [ #editingCanceled := value ]

Signals

editingDone

type C_CellEditableEditingDoneCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type CellEditableEditingDoneCallback = IO ()

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

Implementations of CellEditable are responsible for emitting this signal when they are done editing, e.g. Entry emits this signal when the user presses Enter. Typical things to do in a handler for editingDone are to capture the edited value, disconnect the cellEditable from signals on the CellRenderer, etc.

cellEditableEditingDone is a convenience method for emitting editingDone.

afterCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId

Connect a signal handler for the editingDone signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellEditable #editingDone callback

genClosure_CellEditableEditingDone :: MonadIO m => CellEditableEditingDoneCallback -> m (GClosure C_CellEditableEditingDoneCallback)

Wrap the callback into a GClosure.

mk_CellEditableEditingDoneCallback :: C_CellEditableEditingDoneCallback -> IO (FunPtr C_CellEditableEditingDoneCallback)

Generate a function pointer callable from C code, from a C_CellEditableEditingDoneCallback.

noCellEditableEditingDoneCallback :: Maybe CellEditableEditingDoneCallback

A convenience synonym for Nothing :: Maybe CellEditableEditingDoneCallback.

onCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId

Connect a signal handler for the editingDone signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellEditable #editingDone callback

wrap_CellEditableEditingDoneCallback :: CellEditableEditingDoneCallback -> C_CellEditableEditingDoneCallback

Wrap a CellEditableEditingDoneCallback into a C_CellEditableEditingDoneCallback.

removeWidget

type C_CellEditableRemoveWidgetCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type CellEditableRemoveWidgetCallback = IO ()

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

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

cellEditableRemoveWidget is a convenience method for emitting removeWidget.

afterCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId

Connect a signal handler for the removeWidget signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cellEditable #removeWidget callback

genClosure_CellEditableRemoveWidget :: MonadIO m => CellEditableRemoveWidgetCallback -> m (GClosure C_CellEditableRemoveWidgetCallback)

Wrap the callback into a GClosure.

mk_CellEditableRemoveWidgetCallback :: C_CellEditableRemoveWidgetCallback -> IO (FunPtr C_CellEditableRemoveWidgetCallback)

Generate a function pointer callable from C code, from a C_CellEditableRemoveWidgetCallback.

noCellEditableRemoveWidgetCallback :: Maybe CellEditableRemoveWidgetCallback

A convenience synonym for Nothing :: Maybe CellEditableRemoveWidgetCallback.

onCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId

Connect a signal handler for the removeWidget signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cellEditable #removeWidget callback

wrap_CellEditableRemoveWidgetCallback :: CellEditableRemoveWidgetCallback -> C_CellEditableRemoveWidgetCallback

Wrap a CellEditableRemoveWidgetCallback into a C_CellEditableRemoveWidgetCallback.