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

GI.Gtk.Objects.CellRendererPixbuf

Contents

Exported types
Methods
- Overloaded methods
- new
Properties

Description

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.

Synopsis

newtype CellRendererPixbuf = CellRendererPixbuf (ManagedPtr CellRendererPixbuf)
class (GObject o, IsDescendantOf CellRendererPixbuf o) => IsCellRendererPixbuf o
toCellRendererPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m CellRendererPixbuf
noCellRendererPixbuf :: Maybe CellRendererPixbuf
cellRendererPixbufNew :: (HasCallStack, MonadIO m) => m CellRendererPixbuf
constructCellRendererPixbufFollowState :: IsCellRendererPixbuf o => Bool -> IO (GValueConstruct o)
getCellRendererPixbufFollowState :: (MonadIO m, IsCellRendererPixbuf o) => o -> m Bool
setCellRendererPixbufFollowState :: (MonadIO m, IsCellRendererPixbuf o) => o -> Bool -> m ()
clearCellRendererPixbufGicon :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufGicon :: (IsCellRendererPixbuf o, IsIcon a) => a -> IO (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 => Text -> IO (GValueConstruct o)
getCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Text)
setCellRendererPixbufIconName :: (MonadIO m, IsCellRendererPixbuf o) => o -> Text -> m ()
clearCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufPixbuf :: (IsCellRendererPixbuf o, IsPixbuf a) => a -> IO (GValueConstruct o)
getCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf)
setCellRendererPixbufPixbuf :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m ()
clearCellRendererPixbufPixbufExpanderClosed :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufPixbufExpanderClosed :: (IsCellRendererPixbuf o, IsPixbuf a) => a -> IO (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, IsPixbuf a) => a -> IO (GValueConstruct o)
getCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Pixbuf)
setCellRendererPixbufPixbufExpanderOpen :: (MonadIO m, IsCellRendererPixbuf o, IsPixbuf a) => o -> a -> m ()
clearCellRendererPixbufStockDetail :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufStockDetail :: IsCellRendererPixbuf o => Text -> IO (GValueConstruct o)
getCellRendererPixbufStockDetail :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Text)
setCellRendererPixbufStockDetail :: (MonadIO m, IsCellRendererPixbuf o) => o -> Text -> m ()
clearCellRendererPixbufStockId :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufStockId :: IsCellRendererPixbuf o => Text -> IO (GValueConstruct o)
getCellRendererPixbufStockId :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Text)
setCellRendererPixbufStockId :: (MonadIO m, IsCellRendererPixbuf o) => o -> Text -> m ()
constructCellRendererPixbufStockSize :: IsCellRendererPixbuf o => Word32 -> IO (GValueConstruct o)
getCellRendererPixbufStockSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> m Word32
setCellRendererPixbufStockSize :: (MonadIO m, IsCellRendererPixbuf o) => o -> Word32 -> m ()
clearCellRendererPixbufSurface :: (MonadIO m, IsCellRendererPixbuf o) => o -> m ()
constructCellRendererPixbufSurface :: IsCellRendererPixbuf o => Surface -> IO (GValueConstruct o)
getCellRendererPixbufSurface :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Surface)
setCellRendererPixbufSurface :: (MonadIO m, IsCellRendererPixbuf o) => o -> Surface -> 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 # (/=) :: CellRendererPixbuf -> CellRendererPixbuf -> Bool #
IsGValue CellRendererPixbuf Source #	Convert `CellRendererPixbuf` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.CellRendererPixbuf Methods toGValue :: CellRendererPixbuf -> IO GValue # fromGValue :: GValue -> IO CellRendererPixbuf #
GObject CellRendererPixbuf Source #
Instance details Defined in GI.Gtk.Objects.CellRendererPixbuf Methods gobjectType :: IO GType #
HasParentTypes CellRendererPixbuf Source #
Instance details Defined in GI.Gtk.Objects.CellRendererPixbuf
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.

noCellRendererPixbuf :: Maybe CellRendererPixbuf Source #

A convenience alias for Nothing :: Maybe CellRendererPixbuf.

Methods

Overloaded methods

new

cellRendererPixbufNew Source #

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

followState

Specifies whether the rendered pixbuf should be colorized according to the CellRendererState.

Since: 2.8

constructCellRendererPixbufFollowState :: IsCellRendererPixbuf o => Bool -> IO (GValueConstruct o) Source #

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

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

Get the value of the “follow-state” property. When overloading is enabled, this is equivalent to

get cellRendererPixbuf #followState

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

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

set cellRendererPixbuf [ #followState := value ]

gicon

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

Since: 2.14

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, IsIcon a) => a -> IO (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 "stock_id" or "pixbuf" properties.

Since: 2.8

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 => Text -> IO (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 ]

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, IsPixbuf a) => a -> IO (GValueConstruct o) Source #

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

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

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

get cellRendererPixbuf #pixbuf

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, IsPixbuf a) => a -> IO (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, IsPixbuf a) => a -> IO (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 ]

stockDetail

No description available in the introspection data.

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

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

clear #stockDetail

constructCellRendererPixbufStockDetail :: IsCellRendererPixbuf o => Text -> IO (GValueConstruct o) Source #

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

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

Get the value of the “stock-detail” property. When overloading is enabled, this is equivalent to

get cellRendererPixbuf #stockDetail

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

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

set cellRendererPixbuf [ #stockDetail := value ]

stockId

No description available in the introspection data.

Since: 2.2

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

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

clear #stockId

constructCellRendererPixbufStockId :: IsCellRendererPixbuf o => Text -> IO (GValueConstruct o) Source #

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

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

Get the value of the “stock-id” property. When overloading is enabled, this is equivalent to

get cellRendererPixbuf #stockId

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

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

set cellRendererPixbuf [ #stockId := value ]

stockSize

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

Since: 2.2

constructCellRendererPixbufStockSize :: IsCellRendererPixbuf o => Word32 -> IO (GValueConstruct o) Source #

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

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

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

get cellRendererPixbuf #stockSize

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

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

set cellRendererPixbuf [ #stockSize := value ]

surface

No description available in the introspection data.

Since: 3.10

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

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

clear #surface

constructCellRendererPixbufSurface :: IsCellRendererPixbuf o => Surface -> IO (GValueConstruct o) Source #

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

getCellRendererPixbufSurface :: (MonadIO m, IsCellRendererPixbuf o) => o -> m (Maybe Surface) Source #

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

get cellRendererPixbuf #surface

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

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

set cellRendererPixbuf [ #surface := value ]