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.Objects.CellRendererSpin

Contents

- Exported types
- Methods
  - new
- Properties
  - adjustment
  - climbRate
  - digits

Description

Renders a spin button in a cell

`GtkCellRendererSpin` renders text in a cell like `GtkCellRendererText` from which it is derived. But while `GtkCellRendererText` offers a simple entry to edit the text, `GtkCellRendererSpin` offers a `GtkSpinButton` widget. Of course, that means that the text has to be parseable as a floating point number.

The range of the spinbutton is taken from the adjustment property of the cell renderer, which can be set explicitly or mapped to a column in the tree model, like all properties of cell renders. `GtkCellRendererSpin` also has properties for the `GtkCellRendererSpin:climb-rate` and the number of `GtkCellRendererSpin:digits` to display. Other `GtkSpinButton` properties can be set in a handler for the `GtkCellRenderer::editing-started` signal.

Synopsis

- newtype CellRendererSpin = CellRendererSpin (ManagedPtr CellRendererSpin)
- class (GObject o, IsDescendantOf CellRendererSpin o) => IsCellRendererSpin o
- toCellRendererSpin :: (MonadIO m, IsCellRendererSpin o) => o -> m CellRendererSpin
- cellRendererSpinNew :: (HasCallStack, MonadIO m) => m CellRendererSpin
- clearCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o) => o -> m ()
- constructCellRendererSpinAdjustment :: (IsCellRendererSpin o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o)
- getCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o) => o -> m (Maybe Adjustment)
- setCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o, IsAdjustment a) => o -> a -> m ()
- constructCellRendererSpinClimbRate :: (IsCellRendererSpin o, MonadIO m) => Double -> m (GValueConstruct o)
- getCellRendererSpinClimbRate :: (MonadIO m, IsCellRendererSpin o) => o -> m Double
- setCellRendererSpinClimbRate :: (MonadIO m, IsCellRendererSpin o) => o -> Double -> m ()
- constructCellRendererSpinDigits :: (IsCellRendererSpin o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCellRendererSpinDigits :: (MonadIO m, IsCellRendererSpin o) => o -> m Word32
- setCellRendererSpinDigits :: (MonadIO m, IsCellRendererSpin o) => o -> Word32 -> m ()

# Exported types

newtype CellRendererSpin Source #

Memory-managed wrapper type.

Constructors

CellRendererSpin (ManagedPtr CellRendererSpin) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf CellRendererSpin o) => IsCellRendererSpin o Source #

Type class for types which can be safely cast to `CellRendererSpin`, for instance with `toCellRendererSpin`.

#### Instances

Instances details

(GObject o, IsDescendantOf CellRendererSpin o) => IsCellRendererSpin o Source # |
Instance details Defined in GI.Gtk.Objects.CellRendererSpin

toCellRendererSpin :: (MonadIO m, IsCellRendererSpin o) => o -> m CellRendererSpin Source #

Cast to `CellRendererSpin`, 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

activate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isActivatable, isFloating, notify, notifyByPspec, ref, refSink, runDispose, snapshot, startEditing, stealData, stealQdata, stopEditing, thawNotify, unref, watchClosure.

#### Getters

getAlignedArea, getAlignment, getData, getFixedSize, getIsExpanded, getIsExpander, getPadding, getPreferredHeight, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRequestMode, getSensitive, getState, getVisible.

#### Setters

setAlignment, setData, setDataFull, setFixedHeightFromFont, setFixedSize, setIsExpanded, setIsExpander, setPadding, setProperty, setSensitive, setVisible.

## new

cellRendererSpinNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m CellRendererSpin | Returns: a new `GtkCellRendererSpin`

Deprecated: (Since version 4.10)

Creates a new `GtkCellRendererSpin`.

# Properties

## adjustment

The adjustment that holds the value of the spinbutton. This must be non-`Nothing` for the cell renderer to be editable.

clearCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o) => o -> m () Source #

Set the value of the “`adjustment`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #adjustment

constructCellRendererSpinAdjustment :: (IsCellRendererSpin o, MonadIO m, IsAdjustment a) => a -> m (GValueConstruct o) Source #

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

getCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o) => o -> m (Maybe Adjustment) Source #

Get the value of the “`adjustment`” property. When overloading is enabled, this is equivalent to

    get cellRendererSpin #adjustment

setCellRendererSpinAdjustment :: (MonadIO m, IsCellRendererSpin o, IsAdjustment a) => o -> a -> m () Source #

Set the value of the “`adjustment`” property. When overloading is enabled, this is equivalent to

    set cellRendererSpin [ #adjustment := value ]

## climbRate

The acceleration rate when you hold down a button.

constructCellRendererSpinClimbRate :: (IsCellRendererSpin o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getCellRendererSpinClimbRate :: (MonadIO m, IsCellRendererSpin o) => o -> m Double Source #

Get the value of the “`climb-rate`” property. When overloading is enabled, this is equivalent to

    get cellRendererSpin #climbRate

setCellRendererSpinClimbRate :: (MonadIO m, IsCellRendererSpin o) => o -> Double -> m () Source #

Set the value of the “`climb-rate`” property. When overloading is enabled, this is equivalent to

    set cellRendererSpin [ #climbRate := value ]

## digits

The number of decimal places to display.

constructCellRendererSpinDigits :: (IsCellRendererSpin o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getCellRendererSpinDigits :: (MonadIO m, IsCellRendererSpin o) => o -> m Word32 Source #

Get the value of the “`digits`” property. When overloading is enabled, this is equivalent to

    get cellRendererSpin #digits

setCellRendererSpinDigits :: (MonadIO m, IsCellRendererSpin o) => o -> Word32 -> m () Source #

Set the value of the “`digits`” property. When overloading is enabled, this is equivalent to

    set cellRendererSpin [ #digits := value ]