GI.Gtk.Objects.CellRendererPixbuf

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

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

Exported types

newtype CellRendererPixbuf

Memory-managed wrapper type.

Constructors

CellRendererPixbuf (ManagedPtr CellRendererPixbuf)

Instances

Eq CellRendererPixbuf

Defined in GI.Gtk.Objects.CellRendererPixbuf

Methods

(==) :: CellRendererPixbuf -> CellRendererPixbuf -> Bool

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

IsGValue CellRendererPixbuf

Convert CellRendererPixbuf to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.CellRendererPixbuf

Methods

toGValue :: CellRendererPixbuf -> IO GValue

fromGValue :: GValue -> IO CellRendererPixbuf

GObject CellRendererPixbuf

Defined in GI.Gtk.Objects.CellRendererPixbuf

Methods

gobjectType :: IO GType

HasParentTypes CellRendererPixbuf

Defined in GI.Gtk.Objects.CellRendererPixbuf

type ParentTypes CellRendererPixbuf

Defined in GI.Gtk.Objects.CellRendererPixbuf

type ParentTypes CellRendererPixbuf = '[CellRenderer, Object]

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

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

Instances

(GObject o, IsDescendantOf CellRendererPixbuf o) => IsCellRendererPixbuf o

Defined in GI.Gtk.Objects.CellRendererPixbuf

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

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

noCellRendererPixbuf :: Maybe CellRendererPixbuf

A convenience alias for Nothing :: Maybe CellRendererPixbuf.

Methods

Overloaded methods

new

cellRendererPixbufNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CellRendererPixbuf

Returns: the new cell renderer

Creates a new CellRendererPixbuf. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_set()). Also, with TreeViewColumn, you can bind a property to a value in a TreeModel. 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 TreeView.

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 ()

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

clear #gicon

constructCellRendererPixbufGicon :: (IsCellRendererPixbuf o, IsIcon a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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

clear #iconName

constructCellRendererPixbufIconName :: IsCellRendererPixbuf o => Text -> IO (GValueConstruct o)

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)

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 ()

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

set cellRendererPixbuf [ #iconName := value ]

iconSize

The IconSize value that specifies the size of the rendered icon.

constructCellRendererPixbufIconSize :: IsCellRendererPixbuf o => IconSize -> IO (GValueConstruct o)

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

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 ()

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 ()

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

clear #pixbuf

constructCellRendererPixbufPixbuf :: (IsCellRendererPixbuf o, IsPixbuf a) => a -> IO (GValueConstruct o)

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 ()

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 ()

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

clear #pixbufExpanderClosed

constructCellRendererPixbufPixbufExpanderClosed :: (IsCellRendererPixbuf o, IsPixbuf a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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

clear #pixbufExpanderOpen

constructCellRendererPixbufPixbufExpanderOpen :: (IsCellRendererPixbuf o, IsPixbuf a) => a -> IO (GValueConstruct o)

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)

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 ()

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 ()

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

clear #texture

constructCellRendererPixbufTexture :: (IsCellRendererPixbuf o, IsTexture a) => a -> IO (GValueConstruct o)

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)

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 ()

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

set cellRendererPixbuf [ #texture := value ]