gtk3-0.14.2: Binding to the Gtk+ 3 graphical user interface library

Maintainergtk2hs-users@lists.sourceforge.net
Stabilityprovisional
Portabilityportable (depends on GHC)
Safe HaskellNone
LanguageHaskell98

Graphics.UI.Gtk.ModelView.CellRenderer

Contents

Description

An object for rendering a cell in a list, icon or combo box widget.

Synopsis

Detail

The CellRenderer is a base class of a set of objects used for rendering a cell to a Drawable. 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 Drawable. 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 by changing the attributes of the cell. Then, the cell is measured and rendered in the correct location.

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.

Class Hierarchy

| GObject
| +----Object
| +----CellRenderer
| +----CellRendererText
| +----CellRendererPixbuf
| +----CellRendererProgress
| +----CellRendererCombo
| +----CellRendererToggle

Types

data CellRenderer Source

Instances

class GObjectClass o => CellRendererClass o Source

Instances

castToCellRenderer :: GObjectClass obj => obj -> CellRenderer Source

gTypeCellRenderer :: GType Source

toCellRenderer :: CellRendererClass o => o -> CellRenderer Source

data CellRendererMode Source

Constructors

CellRendererModeInert 
CellRendererModeActivatable 
CellRendererModeEditable 

Instances

Methods

cellRendererStopEditing Source

Arguments

:: CellRendererClass self 
=> self 
-> Bool

canceled - True if the editing has been canceled

-> IO () 

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

  • Available since Gtk+ version 2.6

cellRendererGetFixedSize Source

Arguments

:: CellRendererClass self 
=> self 
-> IO (Int, Int)
(width, height)

Returns (width, height) denoting the size of the fixed size of cell. If no fixed size is set, returns -1 for that value.

cellRendererSetFixedSize Source

Arguments

:: CellRendererClass self 
=> self 
-> Int

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

-> Int

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

-> IO () 

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

Attributes

cellMode :: CellRendererClass self => Attr self CellRendererMode Source

Editable mode of the CellRenderer.

Default value: CellRendererModeInert

cellVisible :: CellRendererClass self => Attr self Bool Source

Display the cell.

Default value: True

cellSensitive :: CellRendererClass self => Attr self Bool Source

Display the cell sensitive.

Default value: True

cellXAlign :: CellRendererClass self => Attr self Float Source

The x-align.

Allowed values: [0,1]

Default value: 0.5

cellYAlign :: CellRendererClass self => Attr self Float Source

The y-align.

Allowed values: [0,1]

Default value: 0.5

cellXPad :: CellRendererClass self => Attr self Int Source

The xpad.

Default value: 0

cellYPad :: CellRendererClass self => Attr self Int Source

The ypad.

Default value: 0

cellWidth :: CellRendererClass self => Attr self Int Source

The fixed width.

Allowed values: >= -1

Default value: -1

cellHeight :: CellRendererClass self => Attr self Int Source

The fixed height.

Allowed values: >= -1

Default value: -1

cellIsExpander :: CellRendererClass self => Attr self Bool Source

Row has children.

Default value: False

cellIsExpanded :: CellRendererClass self => Attr self Bool Source

Row is an expander row, and is expanded.

Default value: False

cellBackground :: (CellRendererClass self, GlibString string) => WriteAttr self string Source

Cell background color as a string.

Default value: ""

cellBackgroundSet :: CellRendererClass self => Attr self Bool Source

Whether the cellBackground / cellBackgroundColor attribute is set.

You can use this to reset the attribute to its default.

Default value: False

Signals

editingStarted :: CellRendererClass self => Signal self (Widget -> TreePath -> IO ()) Source

This signal gets emitted when a cell starts to be edited. The indended use of this signal is to do special setup on editable, e.g. adding a EntryCompletion or setting up additional columns in a ComboBox.

editingCanceled :: CellRendererClass self => Signal self (IO ()) Source

This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.

  • Available since Gtk+ version 2.4

Deprecated