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

Contents

- Exported types
- Methods
  - new
- Properties
  - gicon
  - iconName
  - iconSize
  - pixbuf
  - pixbufExpanderClosed
  - pixbufExpanderOpen
  - texture

Description

Renders a pixbuf in a cell

A `GtkCellRendererPixbuf` can be used to render an image in a cell. It allows to render either a given `GdkPixbuf` (set via the `GtkCellRendererPixbuf:pixbuf` property) or a named icon (set via the `GtkCellRendererPixbuf:icon-name` property).

To support the tree view, `GtkCellRendererPixbuf` also supports rendering two alternative pixbufs, when the `GtkCellRenderer:is-expander` property is `True`. If the `GtkCellRenderer:is-expanded property` is `True` and the `GtkCellRendererPixbuf:pixbuf-expander-open` property is set to a pixbuf, it renders that pixbuf, if the `GtkCellRenderer:is-expanded` property is `False` and the `GtkCellRendererPixbuf:pixbuf-expander-closed` property is set to a pixbuf, it renders that one.

Synopsis

- newtype CellRendererPixbuf = CellRendererPixbuf (ManagedPtr CellRendererPixbuf)
- class (GObject o, IsDescendantOf CellRendererPixbuf o) => IsCellRendererPixbuf o
- toCellRendererPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m CellRendererPixbuf
- cellRendererPixbufNew :: (HasCallStack, MonadIO m) => m CellRendererPixbuf
- clearCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufGicon :: (IsCellRendererPixbuf o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o)
- getCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Icon)
- setCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o, IsIcon a) => o -> a -> m ()
- clearCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufIconName :: (IsCellRendererPixbuf o, MonadIO m) => Text -> m (GValueConstruct o)
- getCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Text)
- setCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> Text -> m ()
- constructCellRendererPixbufIconSize :: (IsCellRendererPixbuf o, MonadIO m) => IconSize -> m (GValueConstruct o)
- getCellRendererPixbufIconSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> m IconSize
- setCellRendererPixbufIconSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> IconSize -> m ()
- clearCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufPixbuf :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)
- setCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m ()
- clearCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufPixbufExpanderClosed :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)
- getCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf)
- setCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m ()
- clearCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufPixbufExpanderOpen :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)
- getCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf)
- setCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m ()
- clearCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
- constructCellRendererPixbufTexture :: (IsCellRendererPixbuf o, MonadIO m, IsTexture a) => a -> m (GValueConstruct o)
- getCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Texture)
- setCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o, IsTexture a) => o -> a -> m ()

# Exported types

newtype CellRendererPixbuf Source #

Memory-managed wrapper type.

Constructors

CellRendererPixbuf (ManagedPtr CellRendererPixbuf) |

#### Instances

Instances details

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

class (GObject o, IsDescendantOf CellRendererPixbuf o) => IsCellRendererPixbuf o Source #

Type class for types which can be safely cast to `CellRendererPixbuf`, for instance with `toCellRendererPixbuf`.

#### Instances

Instances details

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

toCellRendererPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m CellRendererPixbuf Source #

Cast to `CellRendererPixbuf`, 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, setFixedSize, setIsExpanded, setIsExpander, setPadding, setProperty, setSensitive, setVisible.

## new

cellRendererPixbufNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m CellRendererPixbuf | Returns: the new cell renderer

Deprecated: (Since version 4.10)

Creates a new `GtkCellRendererPixbuf`. Adjust rendering parameters using object properties. Object properties can be set globally (with `g_object_set()`). Also, with `GtkTreeViewColumn`, you can bind a property to a value in a `GtkTreeModel`. For example, you can bind the “pixbuf” property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the `GtkTreeView`.

# Properties

## gicon

The GIcon representing the icon to display. If the icon theme is changed, the image will be updated automatically.

clearCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

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

    clear #gicon

constructCellRendererPixbufGicon :: (IsCellRendererPixbuf o, MonadIO m, IsIcon a) => a -> m (GValueConstruct o) Source #

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

getCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Icon) Source #

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

    get cellRendererPixbuf #gicon

setCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o, IsIcon a) => o -> a -> m () Source #

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

    set cellRendererPixbuf [ #gicon := value ]

## iconName

The name of the themed icon to display. This property only has an effect if not overridden by the "pixbuf" property.

clearCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

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

    clear #iconName

constructCellRendererPixbufIconName :: (IsCellRendererPixbuf o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Text) Source #

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

    get cellRendererPixbuf #iconName

setCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> Text -> m () Source #

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

    set cellRendererPixbuf [ #iconName := value ]

## iconSize

The `GtkIconSize` value that specifies the size of the rendered icon.

constructCellRendererPixbufIconSize :: (IsCellRendererPixbuf o, MonadIO m) => IconSize -> m (GValueConstruct o) Source #

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

getCellRendererPixbufIconSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> m IconSize Source #

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

    get cellRendererPixbuf #iconSize

setCellRendererPixbufIconSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> IconSize -> m () Source #

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

    set cellRendererPixbuf [ #iconSize := value ]

## pixbuf

No description available in the introspection data.

clearCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

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

    clear #pixbuf

constructCellRendererPixbufPixbuf :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o) Source #

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

setCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m () Source #

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

    set cellRendererPixbuf [ #pixbuf := value ]

## pixbufExpanderClosed

No description available in the introspection data.

clearCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

Set the value of the “`pixbuf-expander-closed`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #pixbufExpanderClosed

constructCellRendererPixbufPixbufExpanderClosed :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o) Source #

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

getCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf) Source #

Get the value of the “`pixbuf-expander-closed`” property. When overloading is enabled, this is equivalent to

    get cellRendererPixbuf #pixbufExpanderClosed

setCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m () Source #

Set the value of the “`pixbuf-expander-closed`” property. When overloading is enabled, this is equivalent to

    set cellRendererPixbuf [ #pixbufExpanderClosed := value ]

## pixbufExpanderOpen

No description available in the introspection data.

clearCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

Set the value of the “`pixbuf-expander-open`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #pixbufExpanderOpen

constructCellRendererPixbufPixbufExpanderOpen :: (IsCellRendererPixbuf o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o) Source #

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

getCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf) Source #

Get the value of the “`pixbuf-expander-open`” property. When overloading is enabled, this is equivalent to

    get cellRendererPixbuf #pixbufExpanderOpen

setCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m () Source #

Set the value of the “`pixbuf-expander-open`” property. When overloading is enabled, this is equivalent to

    set cellRendererPixbuf [ #pixbufExpanderOpen := value ]

## texture

No description available in the introspection data.

clearCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o) => o -> m () Source #

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

    clear #texture

constructCellRendererPixbufTexture :: (IsCellRendererPixbuf o, MonadIO m, IsTexture a) => a -> m (GValueConstruct o) Source #

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

getCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Texture) Source #

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

    get cellRendererPixbuf #texture

setCellRendererPixbufTexture :: (MonadIO m, IsCellRendererPixbuf o, IsTexture a) => o -> a -> m () Source #

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

    set cellRendererPixbuf [ #texture := value ]