GI.Gtk.Objects.CellRenderer

The CellRenderer is a base class of a set of objects used for rendering a cell to a Context. These objects are used primarily by the TreeView widget, though they aren’t tied to them in any specific way. It is worth noting that CellRenderer is not a Widget and cannot be treated as such.

The primary use of a CellRenderer is for drawing a certain graphical elements on a Context. Typically, one cell renderer is used to draw many cells on the screen. To this extent, it isn’t expected that a CellRenderer keep any permanent state around. Instead, any state is set just prior to use using GObjects property system. Then, the cell is measured using cellRendererGetSize. Finally, the cell is rendered in the correct location using cellRendererRender.

There are a number of rules that must be followed when writing a new CellRenderer. First and foremost, it’s important that a certain set of properties will always yield a cell renderer of the same size, barring a Style change. The CellRenderer also has a number of generic properties that are expected to be honored by all children.

Beyond merely rendering a cell, cell renderers can optionally provide active user interface elements. A cell renderer can be “activatable” like CellRendererToggle, which toggles when it gets activated by a mouse click, or it can be “editable” like CellRendererText, which allows the user to edit the text using a Entry. To make a cell renderer activatable or editable, you have to implement the CellRendererClass.activate or CellRendererClass.start_editing virtual functions, respectively.

Many properties of CellRenderer and its subclasses have a corresponding “set” property, e.g. “cell-background-set” corresponds to “cell-background”. These “set” properties reflect whether a property has been set or not. You should not set them independently.

Exported types

newtype CellRenderer

Constructors

CellRenderer (ManagedPtr CellRenderer)

Instances

GObject CellRenderer

Methods

gobjectType :: CellRenderer -> IO GType

IsObject CellRenderer

IsCellRenderer CellRenderer

class GObject o => IsCellRenderer o

Instances

(GObject a, UnknownAncestorError Constraint CellRenderer a) => IsCellRenderer a

IsCellRenderer CellRendererText

IsCellRenderer CellRenderer

IsCellRenderer CellRendererPixbuf

IsCellRenderer CellRendererToggle

IsCellRenderer CellRendererSpin

IsCellRenderer CellRendererCombo

IsCellRenderer CellRendererProgress

IsCellRenderer CellRendererAccel

IsCellRenderer CellRendererSpinner

toCellRenderer :: (MonadIO m, IsCellRenderer o) => o -> m CellRenderer

noCellRenderer :: Maybe CellRenderer

Methods

activate

cellRendererActivate

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer

-> Event

event: a Event

-> b

widget: widget that received the event

-> Text

path: widget-dependent string representation of the event location; e.g. for TreeView, a string representation of TreePath

-> Rectangle

backgroundArea: background area as passed to cellRendererRender

-> Rectangle

cellArea: cell area as passed to cellRendererRender

-> [CellRendererState]

flags: render flags

-> m Bool

Returns: True if the event was consumed/handled

Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, CellRendererToggle toggles when it gets a mouse click.

getAlignedArea

cellRendererGetAlignedArea

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> [CellRendererState]

flags: render flags

-> Rectangle

cellArea: cell area which would be passed to cellRendererRender

-> m Rectangle

Gets the aligned area used by cell inside cellArea. Used for finding the appropriate edit and focus rectangle.

Since: 3.0

getAlignment

cellRendererGetAlignment

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m (Float, Float)

Fills in xalign and yalign with the appropriate values of cell.

Since: 2.18

getFixedSize

cellRendererGetFixedSize

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m (Int32, Int32)

Fills in width and height with the appropriate size of cell.

getPadding

cellRendererGetPadding

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m (Int32, Int32)

Fills in xpad and ypad with the appropriate values of cell.

Since: 2.18

getPreferredHeight

cellRendererGetPreferredHeight

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> m (Int32, Int32)

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

getPreferredHeightForWidth

cellRendererGetPreferredHeightForWidth

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> Int32

width: the size which is available for allocation

-> m (Int32, Int32)

Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.

Since: 3.0

getPreferredSize

cellRendererGetPreferredSize

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> m (Requisition, Requisition)

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

Since: 3.0

getPreferredWidth

cellRendererGetPreferredWidth

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> m (Int32, Int32)

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

getPreferredWidthForHeight

cellRendererGetPreferredWidthForHeight

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer instance

-> b

widget: the Widget this cell will be rendering to

-> Int32

height: the size which is available for allocation

-> m (Int32, Int32)

Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.

Since: 3.0

getRequestMode

cellRendererGetRequestMode

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: a CellRenderer instance

-> m SizeRequestMode

Returns: The SizeRequestMode preferred by this renderer.

Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.

Since: 3.0

getSensitive

cellRendererGetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m Bool

Returns: True if the cell renderer is sensitive

Returns the cell renderer’s sensitivity.

Since: 2.18

getSize

cellRendererGetSize

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer

-> b

widget: the widget the renderer is rendering to

-> Maybe Rectangle

cellArea: The area a cell will be allocated, or Nothing

-> m (Int32, Int32, Int32, Int32)

Deprecated: (Since version 3.0)Use cellRendererGetPreferredSize instead.

Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to cellRendererRender. If cellArea is not Nothing, fills in the x and y offsets (if set) of the cell relative to this location.

Please note that the values set in width and height, as well as those in xOffset and yOffset are inclusive of the xpad and ypad properties.

getState

cellRendererGetState

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer, or Nothing

-> Maybe b

widget: a Widget, or Nothing

-> [CellRendererState]

cellState: cell renderer state

-> m [StateFlags]

Returns: the widget state flags applying to cell

Translates the cell renderer state to StateFlags, based on the cell renderer and widget sensitivity, and the given CellRendererState.

Since: 3.0

getVisible

cellRendererGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m Bool

Returns: True if the cell renderer is visible

Returns the cell renderer’s visibility.

Since: 2.18

isActivatable

cellRendererIsActivatable

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> m Bool

Returns: True if the cell renderer can do anything when activated

Checks whether the cell renderer can do something when activated.

Since: 3.0

render

cellRendererRender

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer

-> Context

cr: a cairo context to draw to

-> b

widget: the widget owning window

-> Rectangle

backgroundArea: entire cell area (including tree expanders and maybe padding on the sides)

-> Rectangle

cellArea: area normally rendered by a cell renderer

-> [CellRendererState]

flags: flags that affect rendering

-> m ()

Invokes the virtual render function of the CellRenderer. The three passed-in rectangles are areas in cr. Most renderers will draw within cellArea; the xalign, yalign, xpad, and ypad fields of the CellRenderer should be honored with respect to cellArea. backgroundArea includes the blank space around the cell, and also the area containing the tree expander; so the backgroundArea rectangles for all cells tile to cover the entire window.

setAlignment

cellRendererSetAlignment

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Float

xalign: the x alignment of the cell renderer

-> Float

yalign: the y alignment of the cell renderer

-> m ()

Sets the renderer’s alignment within its available space.

Since: 2.18

setFixedSize

cellRendererSetFixedSize

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Int32

width: the width of the cell renderer, or -1

-> Int32

height: the height of the cell renderer, or -1

-> m ()

Sets the renderer size to be explicit, independent of the properties set.

setPadding

cellRendererSetPadding

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Int32

xpad: the x padding of the cell renderer

-> Int32

ypad: the y padding of the cell renderer

-> m ()

Sets the renderer’s padding.

Since: 2.18

setSensitive

cellRendererSetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Bool

sensitive: the sensitivity of the cell

-> m ()

Sets the cell renderer’s sensitivity.

Since: 2.18

setVisible

cellRendererSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Bool

visible: the visibility of the cell

-> m ()

Sets the cell renderer’s visibility.

Since: 2.18

startEditing

cellRendererStartEditing

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)

=> a

cell: a CellRenderer

-> Maybe Event

event: a Event

-> b

widget: widget that received the event

-> Text

path: widget-dependent string representation of the event location; e.g. for TreeView, a string representation of TreePath

-> Rectangle

backgroundArea: background area as passed to cellRendererRender

-> Rectangle

cellArea: cell area as passed to cellRendererRender

-> [CellRendererState]

flags: render flags

-> m (Maybe CellEditable)

Returns: A new CellEditable, or Nothing

Passes an activate event to the cell renderer for possible processing.

stopEditing

cellRendererStopEditing

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)

=> a

cell: A CellRenderer

-> Bool

canceled: True if the editing has been canceled

-> m ()

Informs the cell renderer that the editing is stopped. If canceled is True, the cell renderer will emit the CellRenderer::editing-canceled signal.

This function should be called by cell renderer implementations in response to the CellEditable::editing-done signal of CellEditable.

Since: 2.6

Properties

cellBackground

clearCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> m ()

constructCellRendererCellBackground :: IsCellRenderer o => Text -> IO (GValueConstruct o)

setCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> Text -> m ()

cellBackgroundGdk

clearCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m ()

constructCellRendererCellBackgroundGdk :: IsCellRenderer o => Color -> IO (GValueConstruct o)

getCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe Color)

setCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> Color -> m ()

cellBackgroundRgba

clearCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m ()

constructCellRendererCellBackgroundRgba :: IsCellRenderer o => RGBA -> IO (GValueConstruct o)

getCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe RGBA)

setCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> RGBA -> m ()

cellBackgroundSet

constructCellRendererCellBackgroundSet :: IsCellRenderer o => Bool -> IO (GValueConstruct o)

getCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> m Bool

setCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()

editing

getCellRendererEditing :: (MonadIO m, IsCellRenderer o) => o -> m Bool

height

constructCellRendererHeight :: IsCellRenderer o => Int32 -> IO (GValueConstruct o)

getCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> m Int32

setCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m ()

isExpanded

constructCellRendererIsExpanded :: IsCellRenderer o => Bool -> IO (GValueConstruct o)

getCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> m Bool

setCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()

isExpander

constructCellRendererIsExpander :: IsCellRenderer o => Bool -> IO (GValueConstruct o)

getCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> m Bool

setCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()

mode

constructCellRendererMode :: IsCellRenderer o => CellRendererMode -> IO (GValueConstruct o)

getCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> m CellRendererMode

setCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> CellRendererMode -> m ()

sensitive

constructCellRendererSensitive :: IsCellRenderer o => Bool -> IO (GValueConstruct o)

getCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> m Bool

setCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()

visible

constructCellRendererVisible :: IsCellRenderer o => Bool -> IO (GValueConstruct o)

getCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> m Bool

setCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()

width

constructCellRendererWidth :: IsCellRenderer o => Int32 -> IO (GValueConstruct o)

getCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> m Int32

setCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m ()

xalign

constructCellRendererXalign :: IsCellRenderer o => Float -> IO (GValueConstruct o)

getCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> m Float

setCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m ()

xpad

constructCellRendererXpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o)

getCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32

setCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m ()

yalign

constructCellRendererYalign :: IsCellRenderer o => Float -> IO (GValueConstruct o)

getCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> m Float

setCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m ()

ypad

constructCellRendererYpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o)

getCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32

setCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m ()

Signals

editingCanceled

type C_CellRendererEditingCanceledCallback = Ptr () -> Ptr () -> IO ()

type CellRendererEditingCanceledCallback = IO ()

afterCellRendererEditingCanceled :: (IsCellRenderer a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId

genClosure_CellRendererEditingCanceled :: CellRendererEditingCanceledCallback -> IO Closure

mk_CellRendererEditingCanceledCallback :: C_CellRendererEditingCanceledCallback -> IO (FunPtr C_CellRendererEditingCanceledCallback)

noCellRendererEditingCanceledCallback :: Maybe CellRendererEditingCanceledCallback

onCellRendererEditingCanceled :: (IsCellRenderer a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId

wrap_CellRendererEditingCanceledCallback :: CellRendererEditingCanceledCallback -> Ptr () -> Ptr () -> IO ()

editingStarted

type C_CellRendererEditingStartedCallback = Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO ()

type CellRendererEditingStartedCallback = CellEditable -> Text -> IO ()

afterCellRendererEditingStarted :: (IsCellRenderer a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId

genClosure_CellRendererEditingStarted :: CellRendererEditingStartedCallback -> IO Closure

mk_CellRendererEditingStartedCallback :: C_CellRendererEditingStartedCallback -> IO (FunPtr C_CellRendererEditingStartedCallback)

noCellRendererEditingStartedCallback :: Maybe CellRendererEditingStartedCallback

onCellRendererEditingStarted :: (IsCellRenderer a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId

wrap_CellRendererEditingStartedCallback :: CellRendererEditingStartedCallback -> Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO ()