| Gtk2Hs | Contents | Index

Graphics.UI.Gtk.ModelView.CellRenderer

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Contents

Detail
Class Hierarchy
Types
Methods
Attributes
Signals
Deprecated

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

data CellRenderer
class ObjectClass o => CellRendererClass o
castToCellRenderer :: GObjectClass obj => obj -> CellRenderer
toCellRenderer :: CellRendererClass o => o -> CellRenderer
data CellRendererMode
cellRendererStopEditing :: CellRendererClass self => self -> Bool -> IO ()
cellRendererGetFixedSize :: CellRendererClass self => self -> IO (Int, Int)
cellRendererSetFixedSize :: CellRendererClass self => self -> Int -> Int -> IO ()
cellMode :: CellRendererClass self => Attr self CellRendererMode
cellVisible :: CellRendererClass self => Attr self Bool
cellSensitive :: CellRendererClass self => Attr self Bool
cellXAlign :: CellRendererClass self => Attr self Float
cellYAlign :: CellRendererClass self => Attr self Float
cellXPad :: CellRendererClass self => Attr self Int
cellYPad :: CellRendererClass self => Attr self Int
cellWidth :: CellRendererClass self => Attr self Int
cellHeight :: CellRendererClass self => Attr self Int
cellIsExpander :: CellRendererClass self => Attr self Bool
cellIsExpanded :: CellRendererClass self => Attr self Bool
cellBackground :: CellRendererClass self => WriteAttr self String
cellBackgroundColor :: CellRendererClass self => Attr self Color
cellBackgroundSet :: CellRendererClass self => Attr self Bool
editingStarted :: CellRendererClass self => Signal self (Widget -> TreePath -> IO ())
editingCanceled :: CellRendererClass self => Signal self (IO ())
onEditingStarted :: CellRendererClass self => self -> (Widget -> TreePath -> IO ()) -> IO (ConnectId self)
afterEditingStarted :: CellRendererClass self => self -> (Widget -> TreePath -> IO ()) -> IO (ConnectId self)
onEditingCanceled :: CellRendererClass self => self -> IO () -> IO (ConnectId self)
afterEditingCanceled :: CellRendererClass self => self -> IO () -> IO (ConnectId self)

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 Graphics.UI.Gtk.ModelView.CellRendererToggle, which toggles when it gets activated by a mouse click, or it can be editable like Graphics.UI.Gtk.ModelView.CellRendererText, which allows the user to edit the text using a Graphics.UI.Gtk.Entry.Entry.

Class Hierarchy

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

Types
data CellRenderer

Instances

GObjectClass CellRenderer
CellRendererClass CellRenderer
ObjectClass CellRenderer

class ObjectClass o => CellRendererClass o

Instances

CellRendererClass CellRendererProgress
CellRendererClass CellRendererToggle
CellRendererClass CellRendererCombo
CellRendererClass CellRendererText
CellRendererClass CellRendererPixbuf
CellRendererClass CellRenderer

castToCellRenderer :: GObjectClass obj => obj -> CellRenderer
toCellRenderer :: CellRendererClass o => o -> CellRenderer
data CellRendererMode

Instances

Enum CellRendererMode
Eq CellRendererMode

Methods
cellRendererStopEditing

:: 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

:: 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

:: 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
Editable mode of the CellRenderer. Default value: `CellRendererModeInert`
cellVisible :: CellRendererClass self => Attr self Bool
Display the cell. Default value: `True`
cellSensitive :: CellRendererClass self => Attr self Bool
Display the cell sensitive. Default value: `True`
cellXAlign :: CellRendererClass self => Attr self Float
The x-align. Allowed values: `[0,1]` Default value: `0.5`
cellYAlign :: CellRendererClass self => Attr self Float
The y-align. Allowed values: `[0,1]` Default value: `0.5`
cellXPad :: CellRendererClass self => Attr self Int
The xpad. Default value: `0`
cellYPad :: CellRendererClass self => Attr self Int
The ypad. Default value: `0`
cellWidth :: CellRendererClass self => Attr self Int
The fixed width. Allowed values: `>= -1` Default value: `-1`
cellHeight :: CellRendererClass self => Attr self Int
The fixed height. Allowed values: `>= -1` Default value: `-1`
cellIsExpander :: CellRendererClass self => Attr self Bool
Row has children. Default value: `False`
cellIsExpanded :: CellRendererClass self => Attr self Bool
Row is an expander row, and is expanded. Default value: `False`
cellBackground :: CellRendererClass self => WriteAttr self String
Cell background color as a string. Default value: `""`
cellBackgroundColor :: CellRendererClass self => Attr self Color
Cell background color as a `Color`.
cellBackgroundSet :: CellRendererClass self => Attr self Bool
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 ())

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

- The widget that is passed to the handler contains the widget that is used by the `CellRenderer` to interact with the user. The widget must be casted to the appropriate widget. For instance, a Graphics.UI.Gtk.ModelView.CellRendererText uses an Graphics.UI.Gtk.Entry.Entry widget, while a Graphics.UI.Gtk.ModelView.CellRendererCombo uses a Graphics.UI.Gtk.ModelView.ComboBox.ComboBox (if Graphics.UI.Gtk.ModelView.CellRendererCombo.cellComboHasEntry is `False`) or a Graphics.UI.Gtk.ModelView.ComboBoxEntry.ComboBoxEntry (if Graphics.UI.Gtk.ModelView.CellRendererCombo.cellComboHasEntry is `True`).
- Available since Gtk+ version 2.6

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

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
onEditingStarted :: CellRendererClass self => self -> (Widget -> TreePath -> IO ()) -> IO (ConnectId self)
afterEditingStarted :: CellRendererClass self => self -> (Widget -> TreePath -> IO ()) -> IO (ConnectId self)
onEditingCanceled :: CellRendererClass self => self -> IO () -> IO (ConnectId self)
afterEditingCanceled :: CellRendererClass self => self -> IO () -> IO (ConnectId self)
Produced by Haddock version 2.4.2