gi-gtk4-4.0.12: Gtk 4.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Interfaces.CellEditable

Contents

- Exported types
- Methods
  - editingDone
  - removeWidget
  - startEditing
- Properties
  - editingCanceled
- Signals
  - editingDone
  - removeWidget

Description

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.

Synopsis

- newtype CellEditable = CellEditable (ManagedPtr CellEditable)
- class (GObject o, IsDescendantOf CellEditable 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, IsEvent b) => a -> Maybe b -> m ()
- constructCellEditableEditingCanceled :: (IsCellEditable o, MonadIO m) => Bool -> m (GValueConstruct o)
- getCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> m Bool
- setCellEditableEditingCanceled :: (MonadIO m, IsCellEditable o) => o -> Bool -> m ()
- type CellEditableEditingDoneCallback = IO ()
- afterCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableEditingDoneCallback) -> m SignalHandlerId
- onCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableEditingDoneCallback) -> m SignalHandlerId
- type CellEditableRemoveWidgetCallback = IO ()
- afterCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableRemoveWidgetCallback) -> m SignalHandlerId
- onCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableRemoveWidgetCallback) -> m SignalHandlerId

# Exported types

newtype CellEditable Source #

Deprecated: (Since version 4.10)List views use widgets for displaying theircontents. See `Editable` for editable text widgets

Memory-managed wrapper type.

Constructors

CellEditable (ManagedPtr CellEditable) | Deprecated: (Since version 4.10)List views use widgets for displaying theircontents. See `Editable` for editable text widgets

#### Instances

Instances details

Eq CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable Methods (==) :: CellEditable -> CellEditable -> Bool Source # (/=) :: CellEditable -> CellEditable -> Bool Source #
GObject CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable
ManagedPtrNewtype CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable Methods toManagedPtr :: CellEditable -> ManagedPtr CellEditable Source #
TypedObject CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable Methods glibType :: IO GType Source #
HasParentTypes CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable
IsGValue (Maybe CellEditable) Source # | Convert `CellEditable` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Interfaces.CellEditable Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe CellEditable -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe CellEditable) Source #
type ParentTypes CellEditable Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable type ParentTypes CellEditable = '[Object, Widget]

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

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

#### Instances

Instances details

(GObject o, IsDescendantOf CellEditable o) => IsCellEditable o Source # |
Instance details Defined in GI.Gtk.Interfaces.CellEditable

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

### Click to display all available methods, including inherited ones

Expand

#### Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, editingDone, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, removeWidget, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, startEditing, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updatePlatformState, updateProperty, updateRelation, updateState, watchClosure.

#### Getters

getAccessibleId, getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBounds, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLimitEvents, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

#### Setters

setAccessibleParent, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLimitEvents, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

## editingDone

cellEditableEditingDone Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a) |
=> a | `cellEditable`: A `GtkCellEditable`
-> m () |

Deprecated: (Since version 4.10)

Emits the `GtkCellEditable::editing-done` signal.

## removeWidget

cellEditableRemoveWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a) |
=> a | `cellEditable`: A `GtkCellEditable`
-> m () |

Deprecated: (Since version 4.10)

Emits the `GtkCellEditable::remove-widget` signal.

## startEditing

cellEditableStartEditing Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellEditable a, IsEvent b) |
=> a | `cellEditable`: A `GtkCellEditable`
-> Maybe b | `event`: The `GdkEvent` that began the editing process, or `Nothing` if editing was initiated programmatically
-> m () |

Begins editing on a `cellEditable`.

The `GtkCellRenderer` for the cell creates and returns a `GtkCellEditable` from `cellRendererStartEditing`, configured for the `GtkCellRenderer` type.

`cellEditableStartEditing` can then set up `cellEditable` suitably for editing a cell, e.g. making the Esc key emit `GtkCellEditable::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.

constructCellEditableEditingCanceled :: (IsCellEditable o, MonadIO m) => Bool -> m (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

    set cellEditable [ #editingCanceled := value ]

# Signals

## editingDone

type CellEditableEditingDoneCallback = IO () Source #

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

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 editingDone are to capture the edited value, disconnect the `cellEditable` from signals on the `GtkCellRenderer`, etc.

`cellEditableEditingDone` is a convenience method for emitting `GtkCellEditable::editing-done`.

afterCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableEditingDoneCallback) -> m SignalHandlerId Source #

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onCellEditableEditingDone :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableEditingDoneCallback) -> m SignalHandlerId Source #

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

## removeWidget

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 `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.

`cellEditableRemoveWidget` is a convenience method for emitting `GtkCellEditable::remove-widget`.

afterCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableRemoveWidgetCallback) -> m SignalHandlerId Source #

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

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit `?self` parameter. Note that this requires activating the `ImplicitParams` GHC extension.

onCellEditableRemoveWidget :: (IsCellEditable a, MonadIO m) => a -> ((?self :: a) => CellEditableRemoveWidgetCallback) -> m SignalHandlerId Source #

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