| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gtk.Interfaces.CellEditable
Contents
Description
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.
Synopsis
- newtype CellEditable = CellEditable (ManagedPtr CellEditable)
- noCellEditable :: Maybe CellEditable
- class GObject o => IsCellEditable o
- toCellEditable :: (MonadIO m, IsCellEditable o) => o -> m CellEditable
- cellEditableEditingDone :: (HasCallStack, MonadIO m, IsCellEditable a) => a -> m ()
- cellEditableRemoveWidget :: (HasCallStack, MonadIO m, IsCellEditable a) => a -> m ()
- cellEditableStartEditing :: (HasCallStack, MonadIO m, IsCellEditable a) => a -> Maybe Event -> m ()
- constructCellEditableEditingCanceled :: IsCellEditable o => Bool -> IO (GValueConstruct o)
- getCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> m Bool
- setCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> Bool -> m ()
- type C_CellEditableEditingDoneCallback = Ptr () -> Ptr () -> IO ()
- type CellEditableEditingDoneCallback = IO ()
- afterCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId
- genClosure_CellEditableEditingDone :: CellEditableEditingDoneCallback -> IO Closure
- mk_CellEditableEditingDoneCallback :: C_CellEditableEditingDoneCallback -> IO (FunPtr C_CellEditableEditingDoneCallback)
- noCellEditableEditingDoneCallback :: Maybe CellEditableEditingDoneCallback
- onCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId
- wrap_CellEditableEditingDoneCallback :: CellEditableEditingDoneCallback -> C_CellEditableEditingDoneCallback
- type C_CellEditableRemoveWidgetCallback = Ptr () -> Ptr () -> IO ()
- type CellEditableRemoveWidgetCallback = IO ()
- afterCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId
- genClosure_CellEditableRemoveWidget :: CellEditableRemoveWidgetCallback -> IO Closure
- mk_CellEditableRemoveWidgetCallback :: C_CellEditableRemoveWidgetCallback -> IO (FunPtr C_CellEditableRemoveWidgetCallback)
- noCellEditableRemoveWidgetCallback :: Maybe CellEditableRemoveWidgetCallback
- onCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId
- wrap_CellEditableRemoveWidgetCallback :: CellEditableRemoveWidgetCallback -> C_CellEditableRemoveWidgetCallback
Exported types
newtype CellEditable Source #
Memory-managed wrapper type.
Constructors
| CellEditable (ManagedPtr CellEditable) |
Instances
| GObject CellEditable Source # | |
Defined in GI.Gtk.Interfaces.CellEditable Methods gobjectType :: CellEditable -> IO GType # | |
| IsObject CellEditable Source # | |
Defined in GI.Gtk.Interfaces.CellEditable | |
| IsCellEditable CellEditable Source # | |
Defined in GI.Gtk.Interfaces.CellEditable | |
| IsWidget CellEditable Source # | |
Defined in GI.Gtk.Interfaces.CellEditable | |
noCellEditable :: Maybe CellEditable Source #
A convenience alias for Nothing :: Maybe CellEditable.
class GObject o => IsCellEditable o Source #
Type class for types which can be safely cast to CellEditable, for instance with toCellEditable.
Instances
| (GObject a, (UnknownAncestorError CellEditable a :: Constraint)) => IsCellEditable a Source # | |
Defined in GI.Gtk.Interfaces.CellEditable | |
| IsCellEditable CellEditable Source # | |
Defined in GI.Gtk.Interfaces.CellEditable | |
| IsCellEditable ComboBox Source # | |
Defined in GI.Gtk.Objects.ComboBox | |
| IsCellEditable Entry Source # | |
Defined in GI.Gtk.Objects.Entry | |
| IsCellEditable SpinButton Source # | |
Defined in GI.Gtk.Objects.SpinButton | |
| IsCellEditable SearchEntry Source # | |
Defined in GI.Gtk.Objects.SearchEntry | |
| IsCellEditable ComboBoxText Source # | |
Defined in GI.Gtk.Objects.ComboBoxText | |
| IsCellEditable AppChooserButton Source # | |
Defined in GI.Gtk.Objects.AppChooserButton | |
toCellEditable :: (MonadIO m, IsCellEditable o) => o -> m CellEditable Source #
Cast to CellEditable, for types for which this is known to be safe. For general casts, use castTo.
Methods
editingDone
cellEditableEditingDone Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCellEditable a) | |
| => a |
|
| -> m () |
Emits the CellEditable::editing-done signal.
removeWidget
cellEditableRemoveWidget Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCellEditable a) | |
| => a |
|
| -> m () |
Emits the CellEditable::remove-widget signal.
startEditing
cellEditableStartEditing Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCellEditable a) | |
| => a |
|
| -> Maybe Event |
|
| -> 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 CellEditable::editing-done.
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 => Bool -> IO (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “editing-canceled” property.
When overloading is enabled, this is equivalent to
setcellEditable [ #editingCanceled:=value ]
Signals
editingDone
type C_CellEditableEditingDoneCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CellEditableEditingDoneCallback = IO () Source #
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 ::editing-done are to capture the edited value,
disconnect the cellEditable from signals on the CellRenderer, etc.
cellEditableEditingDone is a convenience method
for emitting CellEditable::editing-done.
afterCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId Source #
Connect a signal handler for the “editing-done” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after cellEditable #editingDone callback
genClosure_CellEditableEditingDone :: CellEditableEditingDoneCallback -> IO Closure Source #
Wrap the callback into a Closure.
mk_CellEditableEditingDoneCallback :: C_CellEditableEditingDoneCallback -> IO (FunPtr C_CellEditableEditingDoneCallback) Source #
Generate a function pointer callable from C code, from a C_CellEditableEditingDoneCallback.
noCellEditableEditingDoneCallback :: Maybe CellEditableEditingDoneCallback Source #
A convenience synonym for .Nothing :: Maybe CellEditableEditingDoneCallback
onCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> CellEditableEditingDoneCallback -> m SignalHandlerId Source #
Connect a signal handler for the “editing-done” 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 Source #
Wrap a CellEditableEditingDoneCallback into a C_CellEditableEditingDoneCallback.
removeWidget
type C_CellEditableRemoveWidgetCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CellEditableRemoveWidgetCallback = IO () Source #
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 CellEditable::editing-done 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 CellEditable::remove-widget.
afterCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId Source #
Connect a signal handler for the “remove-widget” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after cellEditable #removeWidget callback
genClosure_CellEditableRemoveWidget :: CellEditableRemoveWidgetCallback -> IO Closure Source #
Wrap the callback into a Closure.
mk_CellEditableRemoveWidgetCallback :: C_CellEditableRemoveWidgetCallback -> IO (FunPtr C_CellEditableRemoveWidgetCallback) Source #
Generate a function pointer callable from C code, from a C_CellEditableRemoveWidgetCallback.
noCellEditableRemoveWidgetCallback :: Maybe CellEditableRemoveWidgetCallback Source #
A convenience synonym for .Nothing :: Maybe CellEditableRemoveWidgetCallback
onCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> CellEditableRemoveWidgetCallback -> m SignalHandlerId Source #
Connect a signal handler for the “remove-widget” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on cellEditable #removeWidget callback