The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Gtk2-1.043
River stage three • 104 direct dependents • 130 total dependents
12 ++
/ xs/GtkCellRenderer.xs

DESCRIPTION

The Gtk2::CellRenderer is the base class for objects which render cells onto drawables. These objects are used primarily by the Gtk2::TreeView, though they aren't tied to them in any specific way.

Typically, one cell renderer is used to draw many cells onto the screen. Thus, the cell renderer doesn't keep state; instead, any state is set immediately prior to use through the object property system. The cell is measured with get_size, and then renderered with render.

DERIVING NEW CELL RENDERERS

Gtk+ provides three cell renderers: Gtk2::CellRendererText, Gtk2::CellRendererToggle, and Gtk2::CellRendererPixbuf. You may derive a new renderer from any of these, or directly from Gtk2::CellRenderer itself.

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

The new renderer must be a GObject, so you must follow the normal procedure for creating a new Glib::Object (i.e., either Glib::Object::Subclass or Glib::Type::register_object). The new subclass can customize the object's behavior by providing new implementations of these four methods:

(x_offset, y_offset, width, height) = GET_SIZE ($cell, $widget, $cell_area)
o $cell (Gtk2::CellRenderer)
o $widget (Gtk2::Widget) widget to which $cell is rendering
o $cell_area (Gtk2::Gdk::Rectangle or undef) The area a cell will be allocated, or undef.

Return Values:

- x_offset - x offset of cell relative to $cell_area
- y_offset - y offset of cell relative to $cell_area
- width - width needed to render cell
- height - height needed to render cell

This is called to calculate the size of the cell for display, taking into account the padding and alignment properties of the parent. This one will be called very often. If you need to know your cell's data, then get it from the appropriate object properties, which will be set accordingly before this method is called.

RENDER ($cell, $drawable, $widget, $background_area, $cell_area, $expose_area, $flags)
o $cell (Gtk2::CellRenderer)
o $drawable (Gtk2::Gdk::Drawable) window on which to draw
o $widget (Gtk2::Widget) widget owning $drawable
o $background_area (Gtk2::Gdk::Rectangle) entire cell area (including tree expanders and maybe padding on the sides)
o $cell_area (Gtk2::Gdk::Rectangle) area normally rendered by a cell renderer
o $expose_area (Gtk2::Gdk::Rectangle) area that actually needs updating
o $flags (Gtk2::CellRendererState) flags that affect rendering

This is called to render the cell onto the screen. As with GET_SIZE, the data for the cell comes from object properties. In general, you'll want to make use of Gtk2::Style methods for drawing anything fancy.

The three passed-in rectangles are areas of $drawable. Most renderers draw within $cell_area; the xalign, yalign, xpad, and ypad fields of the cell renderer should be honored with respect to $cell_area. $background_area includes the blank space around the cell, and also the area containing the tree expander; so the $background_area rectangles for all cells cover the entire $drawable. $expose_area is a clip rectangle.

boolean = ACTIVATE ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)
o $cell (Gtk2::CellRenderer)
o $event (Gtk2::Gdk::Event)
o $widget (Gtk2::Widget) widget that received the event
o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath.
o $background_area (Gtk2::Gdk::Rectangle) background area as passed to RENDER.
o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to RENDER.
o $flags (Gtk2::CellRendererState) render flags

This method is called when an event occurs on a cell. Implementing it is not mandatory. The return value should be TRUE if the event was consumed/handled.

celleditable or undef = START_EDITING ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)
o $cell (Gtk2::CellRenderer)
o $event (Gtk2::Gdk::Event)
o $widget (Gtk2::Widget) widget that received the event
o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath.
o $background_area (Gtk2::Gdk::Rectangle) background area as passed to RENDER.
o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to RENDER.
o $flags (Gtk2::CellRendererState) render flags

For cells that are editable, this is called to put the cell into editing mode. If the return value is an object is a Gtk2::CellEditable, that widget will be used to edit the value; the calling code takes care of sizing, placing, and showing the editable, you just need to return it. If the return value is undef, the editing is aborted.

Note: for backward compatibility, the bizarre and non-standard scheme used for this in 1.02x is still supported, but is deprecated and should not be used in new code, and since i don't want people to use it any more i will not document it here.