.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Gtk2::CellRenderer 3pm"
.TH Gtk2::CellRenderer 3pm "2019-09-16" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Gtk2::CellRenderer \- An object that renders a single cell onto a Gtk2::Gdk::Drawable
.SH "DESCRIPTION"
.IX Header "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.
.PP
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 \f(CW\*(C`get_size\*(C'\fR, and then renderered with \f(CW\*(C`render\*(C'\fR.
.SH "HIERARCHY"
.IX Header "HIERARCHY"
.Vb 4
\&  Glib::Object
\&  +\-\-\-\-Glib::InitiallyUnowned
\&       +\-\-\-\-Gtk2::Object
\&            +\-\-\-\-Gtk2::CellRenderer
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "boolean = $cell\->\fBactivate\fP ($event, $widget, $path, $background_area, $cell_area, $flags)"
.el .SS "boolean = \f(CW$cell\fP\->\fBactivate\fP ($event, \f(CW$widget\fP, \f(CW$path\fP, \f(CW$background_area\fP, \f(CW$cell_area\fP, \f(CW$flags\fP)"
.IX Subsection "boolean = $cell->activate ($event, $widget, $path, $background_area, $cell_area, $flags)"
.IP "\(bu" 4
\&\f(CW$event\fR (Gtk2::Gdk::Event)
.IP "\(bu" 4
\&\f(CW$widget\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$path\fR (string)
.IP "\(bu" 4
\&\f(CW$background_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$cell_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$flags\fR (Gtk2::CellRendererState)
.ie n .SS "(xalign, yalign) = $cell\->\fBget_alignment\fP"
.el .SS "(xalign, yalign) = \f(CW$cell\fP\->\fBget_alignment\fP"
.IX Subsection "(xalign, yalign) = $cell->get_alignment"
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBset_alignment\fP ($xalign, $yalign)"
.el .SS "\f(CW$cell\fP\->\fBset_alignment\fP ($xalign, \f(CW$yalign\fP)"
.IX Subsection "$cell->set_alignment ($xalign, $yalign)"
.IP "\(bu" 4
\&\f(CW$xalign\fR (double)
.IP "\(bu" 4
\&\f(CW$yalign\fR (double)
.PP
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBediting_canceled\fP"
.el .SS "\f(CW$cell\fP\->\fBediting_canceled\fP"
.IX Subsection "$cell->editing_canceled"
Since: gtk+ 2.4
.ie n .SS "(width, height) = $cell\->\fBget_fixed_size\fP"
.el .SS "(width, height) = \f(CW$cell\fP\->\fBget_fixed_size\fP"
.IX Subsection "(width, height) = $cell->get_fixed_size"
Fetch the fixed size if \fI\f(CI$cell\fI\fR.  Values of \-1 mean \*(L"this dimension is not
fixed.\*(R"
.ie n .SS "$cell\->\fBset_fixed_size\fP ($width, $height)"
.el .SS "\f(CW$cell\fP\->\fBset_fixed_size\fP ($width, \f(CW$height\fP)"
.IX Subsection "$cell->set_fixed_size ($width, $height)"
.IP "\(bu" 4
\&\f(CW$width\fR (integer)
.IP "\(bu" 4
\&\f(CW$height\fR (integer)
.PP
Set the renderer's size explicitly, independent of object properties.  A value
of \-1 means \*(L"don't use a fixed size for this dimension.\*(R"
.ie n .SS "(xpad, ypad) = $cell\->\fBget_padding\fP"
.el .SS "(xpad, ypad) = \f(CW$cell\fP\->\fBget_padding\fP"
.IX Subsection "(xpad, ypad) = $cell->get_padding"
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBset_padding\fP ($xpad, $ypad)"
.el .SS "\f(CW$cell\fP\->\fBset_padding\fP ($xpad, \f(CW$ypad\fP)"
.IX Subsection "$cell->set_padding ($xpad, $ypad)"
.IP "\(bu" 4
\&\f(CW$xpad\fR (integer)
.IP "\(bu" 4
\&\f(CW$ypad\fR (integer)
.PP
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBrender\fP ($drawable, $widget, $background_area, $cell_area, $expose_area, $flags)"
.el .SS "\f(CW$cell\fP\->\fBrender\fP ($drawable, \f(CW$widget\fP, \f(CW$background_area\fP, \f(CW$cell_area\fP, \f(CW$expose_area\fP, \f(CW$flags\fP)"
.IX Subsection "$cell->render ($drawable, $widget, $background_area, $cell_area, $expose_area, $flags)"
.IP "\(bu" 4
\&\f(CW$drawable\fR (Gtk2::Gdk::Drawable)
.IP "\(bu" 4
\&\f(CW$widget\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$background_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$cell_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$expose_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$flags\fR (Gtk2::CellRendererState)
.ie n .SS "boolean = $cell\->\fBget_sensitive\fP"
.el .SS "boolean = \f(CW$cell\fP\->\fBget_sensitive\fP"
.IX Subsection "boolean = $cell->get_sensitive"
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBset_sensitive\fP ($sensitive)"
.el .SS "\f(CW$cell\fP\->\fBset_sensitive\fP ($sensitive)"
.IX Subsection "$cell->set_sensitive ($sensitive)"
.IP "\(bu" 4
\&\f(CW$sensitive\fR (boolean)
.PP
Since: gtk+ 2.18
.ie n .SS "(x_offset, y_offset, width, height) = $cell\->\fBget_size\fP ($widget, $cell_area)"
.el .SS "(x_offset, y_offset, width, height) = \f(CW$cell\fP\->\fBget_size\fP ($widget, \f(CW$cell_area\fP)"
.IX Subsection "(x_offset, y_offset, width, height) = $cell->get_size ($widget, $cell_area)"
.IP "\(bu" 4
\&\f(CW$widget\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$cell_area\fR (Gtk2::Gdk::Rectangle or undef)
.ie n .SS "celleditable or undef = $cell\->\fBstart_editing\fP ($event, $widget, $path, $background_area, $cell_area, $flags)"
.el .SS "celleditable or undef = \f(CW$cell\fP\->\fBstart_editing\fP ($event, \f(CW$widget\fP, \f(CW$path\fP, \f(CW$background_area\fP, \f(CW$cell_area\fP, \f(CW$flags\fP)"
.IX Subsection "celleditable or undef = $cell->start_editing ($event, $widget, $path, $background_area, $cell_area, $flags)"
.IP "\(bu" 4
\&\f(CW$event\fR (Gtk2::Gdk::Event)
.IP "\(bu" 4
\&\f(CW$widget\fR (Gtk2::Widget)
.IP "\(bu" 4
\&\f(CW$path\fR (string)
.IP "\(bu" 4
\&\f(CW$background_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$cell_area\fR (Gtk2::Gdk::Rectangle)
.IP "\(bu" 4
\&\f(CW$flags\fR (Gtk2::CellRendererState)
.ie n .SS "$cell\->\fBstop_editing\fP ($canceled)"
.el .SS "\f(CW$cell\fP\->\fBstop_editing\fP ($canceled)"
.IX Subsection "$cell->stop_editing ($canceled)"
.IP "\(bu" 4
\&\f(CW$canceled\fR (boolean)
.PP
Since: gtk+ 2.6
.ie n .SS "boolean = $cell\->\fBget_visible\fP"
.el .SS "boolean = \f(CW$cell\fP\->\fBget_visible\fP"
.IX Subsection "boolean = $cell->get_visible"
Since: gtk+ 2.18
.ie n .SS "$cell\->\fBset_visible\fP ($visible)"
.el .SS "\f(CW$cell\fP\->\fBset_visible\fP ($visible)"
.IX Subsection "$cell->set_visible ($visible)"
.IP "\(bu" 4
\&\f(CW$visible\fR (boolean)
.PP
Since: gtk+ 2.18
.SH "PROPERTIES"
.IX Header "PROPERTIES"
.IP "'cell\-background' (string : default undef : writable / private)" 4
.IX Item "'cell-background' (string : default undef : writable / private)"
Cell background color as a string
.IP "'cell\-background\-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)" 4
.IX Item "'cell-background-gdk' (Gtk2::Gdk::Color : default undef : readable / writable / private)"
Cell background color as a GdkColor
.IP "'cell\-background\-set' (boolean : default false : readable / writable / private)" 4
.IX Item "'cell-background-set' (boolean : default false : readable / writable / private)"
Whether this tag affects the cell background color
.IP "'editing' (boolean : default false : readable / private)" 4
.IX Item "'editing' (boolean : default false : readable / private)"
Whether the cell renderer is currently in editing mode
.IP "'height' (integer : default \-1 : readable / writable / private)" 4
.IX Item "'height' (integer : default -1 : readable / writable / private)"
The fixed height
.IP "'is\-expanded' (boolean : default false : readable / writable / private)" 4
.IX Item "'is-expanded' (boolean : default false : readable / writable / private)"
Row is an expander row, and is expanded
.IP "'is\-expander' (boolean : default false : readable / writable / private)" 4
.IX Item "'is-expander' (boolean : default false : readable / writable / private)"
Row has children
.ie n .IP "'mode' (Gtk2::CellRendererMode : default ""inert"" : readable / writable / private)" 4
.el .IP "'mode' (Gtk2::CellRendererMode : default ``inert'' : readable / writable / private)" 4
.IX Item "'mode' (Gtk2::CellRendererMode : default inert : readable / writable / private)"
Editable mode of the CellRenderer
.IP "'sensitive' (boolean : default true : readable / writable / private)" 4
.IX Item "'sensitive' (boolean : default true : readable / writable / private)"
Display the cell sensitive
.IP "'visible' (boolean : default true : readable / writable / private)" 4
.IX Item "'visible' (boolean : default true : readable / writable / private)"
Display the cell
.IP "'width' (integer : default \-1 : readable / writable / private)" 4
.IX Item "'width' (integer : default -1 : readable / writable / private)"
The fixed width
.IP "'xalign' (float : default 0.5 : readable / writable / private)" 4
.IX Item "'xalign' (float : default 0.5 : readable / writable / private)"
The x\-align
.IP "'xpad' (Glib::UInt : default 0 : readable / writable / private)" 4
.IX Item "'xpad' (Glib::UInt : default 0 : readable / writable / private)"
The xpad
.IP "'yalign' (float : default 0.5 : readable / writable / private)" 4
.IX Item "'yalign' (float : default 0.5 : readable / writable / private)"
The y\-align
.IP "'ypad' (Glib::UInt : default 0 : readable / writable / private)" 4
.IX Item "'ypad' (Glib::UInt : default 0 : readable / writable / private)"
The ypad
.SH "SIGNALS"
.IX Header "SIGNALS"
.IP "\fBediting-canceled\fR (Gtk2::CellRenderer)" 4
.IX Item "editing-canceled (Gtk2::CellRenderer)"
.PD 0
.IP "\fBediting-started\fR (Gtk2::CellRenderer, Gtk2::CellEditable, string)" 4
.IX Item "editing-started (Gtk2::CellRenderer, Gtk2::CellEditable, string)"
.PD
.SH "ENUMS AND FLAGS"
.IX Header "ENUMS AND FLAGS"
.SS "enum Gtk2::CellRendererMode"
.IX Subsection "enum Gtk2::CellRendererMode"
.IP "\(bu" 4
\&'inert' / '\s-1GTK_CELL_RENDERER_MODE_INERT\s0'
.IP "\(bu" 4
\&'activatable' / '\s-1GTK_CELL_RENDERER_MODE_ACTIVATABLE\s0'
.IP "\(bu" 4
\&'editable' / '\s-1GTK_CELL_RENDERER_MODE_EDITABLE\s0'
.SS "flags Gtk2::CellRendererState"
.IX Subsection "flags Gtk2::CellRendererState"
.IP "\(bu" 4
\&'selected' / '\s-1GTK_CELL_RENDERER_SELECTED\s0'
.IP "\(bu" 4
\&'prelit' / '\s-1GTK_CELL_RENDERER_PRELIT\s0'
.IP "\(bu" 4
\&'insensitive' / '\s-1GTK_CELL_RENDERER_INSENSITIVE\s0'
.IP "\(bu" 4
\&'sorted' / '\s-1GTK_CELL_RENDERER_SORTED\s0'
.IP "\(bu" 4
\&'focused' / '\s-1GTK_CELL_RENDERER_FOCUSED\s0'
.SH "DERIVING NEW CELL RENDERERS"
.IX Header "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.
.PP
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.
.PP
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:
.ie n .IP "(x_offset, y_offset, width, height) = \s-1GET_SIZE\s0 ($cell, $widget, $cell_area)" 4
.el .IP "(x_offset, y_offset, width, height) = \s-1GET_SIZE\s0 ($cell, \f(CW$widget\fR, \f(CW$cell_area\fR)" 4
.IX Item "(x_offset, y_offset, width, height) = GET_SIZE ($cell, $widget, $cell_area)"
.RS 4
.PD 0
.ie n .IP "o $cell (Gtk2::CellRenderer)" 4
.el .IP "o \f(CW$cell\fR (Gtk2::CellRenderer)" 4
.IX Item "o $cell (Gtk2::CellRenderer)"
.ie n .IP "o $widget (Gtk2::Widget) widget to which \fI\f(CI$cell\fI\fR is rendering" 4
.el .IP "o \f(CW$widget\fR (Gtk2::Widget) widget to which \fI\f(CI$cell\fI\fR is rendering" 4
.IX Item "o $widget (Gtk2::Widget) widget to which $cell is rendering"
.ie n .IP "o $cell_area (Gtk2::Gdk::Rectangle or undef) The area a cell will be allocated, or undef." 4
.el .IP "o \f(CW$cell_area\fR (Gtk2::Gdk::Rectangle or undef) The area a cell will be allocated, or undef." 4
.IX Item "o $cell_area (Gtk2::Gdk::Rectangle or undef) The area a cell will be allocated, or undef."
.RE
.RS 4
.PD
.Sp
Return Values:
.IP "\- x_offset \- x offset of cell relative to \fI\f(CI$cell_area\fI\fR" 4
.IX Item "- x_offset - x offset of cell relative to $cell_area"
.PD 0
.IP "\- y_offset \- y offset of cell relative to \fI\f(CI$cell_area\fI\fR" 4
.IX Item "- y_offset - y offset of cell relative to $cell_area"
.IP "\- width \- width needed to render cell" 4
.IX Item "- width - width needed to render cell"
.IP "\- height \- height needed to render cell" 4
.IX Item "- height - height needed to render cell"
.RE
.RS 4
.PD
.Sp
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.
.RE
.ie n .IP "\s-1RENDER\s0 ($cell, $drawable, $widget, $background_area, $cell_area, $expose_area, $flags)" 4
.el .IP "\s-1RENDER\s0 ($cell, \f(CW$drawable\fR, \f(CW$widget\fR, \f(CW$background_area\fR, \f(CW$cell_area\fR, \f(CW$expose_area\fR, \f(CW$flags\fR)" 4
.IX Item "RENDER ($cell, $drawable, $widget, $background_area, $cell_area, $expose_area, $flags)"
.RS 4
.PD 0
.ie n .IP "o $cell (Gtk2::CellRenderer)" 4
.el .IP "o \f(CW$cell\fR (Gtk2::CellRenderer)" 4
.IX Item "o $cell (Gtk2::CellRenderer)"
.ie n .IP "o $drawable (Gtk2::Gdk::Drawable) window on which to draw" 4
.el .IP "o \f(CW$drawable\fR (Gtk2::Gdk::Drawable) window on which to draw" 4
.IX Item "o $drawable (Gtk2::Gdk::Drawable) window on which to draw"
.ie n .IP "o $widget (Gtk2::Widget) widget owning \fI\f(CI$drawable\fI\fR" 4
.el .IP "o \f(CW$widget\fR (Gtk2::Widget) widget owning \fI\f(CI$drawable\fI\fR" 4
.IX Item "o $widget (Gtk2::Widget) widget owning $drawable"
.ie n .IP "o $background_area (Gtk2::Gdk::Rectangle) entire cell area (including tree expanders and maybe padding on the sides)" 4
.el .IP "o \f(CW$background_area\fR (Gtk2::Gdk::Rectangle) entire cell area (including tree expanders and maybe padding on the sides)" 4
.IX Item "o $background_area (Gtk2::Gdk::Rectangle) entire cell area (including tree expanders and maybe padding on the sides)"
.ie n .IP "o $cell_area (Gtk2::Gdk::Rectangle) area normally rendered by a cell renderer" 4
.el .IP "o \f(CW$cell_area\fR (Gtk2::Gdk::Rectangle) area normally rendered by a cell renderer" 4
.IX Item "o $cell_area (Gtk2::Gdk::Rectangle) area normally rendered by a cell renderer"
.ie n .IP "o $expose_area (Gtk2::Gdk::Rectangle) area that actually needs updating" 4
.el .IP "o \f(CW$expose_area\fR (Gtk2::Gdk::Rectangle) area that actually needs updating" 4
.IX Item "o $expose_area (Gtk2::Gdk::Rectangle) area that actually needs updating"
.ie n .IP "o $flags (Gtk2::CellRendererState) flags that affect rendering" 4
.el .IP "o \f(CW$flags\fR (Gtk2::CellRendererState) flags that affect rendering" 4
.IX Item "o $flags (Gtk2::CellRendererState) flags that affect rendering"
.RE
.RS 4
.PD
.Sp
This is called to render the cell onto the screen.  As with \s-1GET_SIZE,\s0 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.
.Sp
The three passed-in rectangles are areas of \fI\f(CI$drawable\fI\fR.  Most renderers draw
within \fI\f(CI$cell_area\fI\fR; the xalign, yalign, xpad, and ypad fields of the 
cell renderer should be honored with respect to \fI\f(CI$cell_area\fI\fR.
\&\fI\f(CI$background_area\fI\fR includes the blank space around the cell, and also the
area containing the tree expander; so the \fI\f(CI$background_area\fI\fR rectangles for
all cells cover the entire \fI\f(CI$drawable\fI\fR.  \fI\f(CI$expose_area\fI\fR is a clip
rectangle.
.RE
.ie n .IP "boolean = \s-1ACTIVATE\s0 ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)" 4
.el .IP "boolean = \s-1ACTIVATE\s0 ($cell, \f(CW$event\fR, \f(CW$widget\fR, \f(CW$path\fR, \f(CW$background_area\fR, \f(CW$cell_area\fR, \f(CW$flags\fR)" 4
.IX Item "boolean = ACTIVATE ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)"
.RS 4
.PD 0
.ie n .IP "o $cell (Gtk2::CellRenderer)" 4
.el .IP "o \f(CW$cell\fR (Gtk2::CellRenderer)" 4
.IX Item "o $cell (Gtk2::CellRenderer)"
.ie n .IP "o $event (Gtk2::Gdk::Event)" 4
.el .IP "o \f(CW$event\fR (Gtk2::Gdk::Event)" 4
.IX Item "o $event (Gtk2::Gdk::Event)"
.ie n .IP "o $widget (Gtk2::Widget) widget that received the event" 4
.el .IP "o \f(CW$widget\fR (Gtk2::Widget) widget that received the event" 4
.IX Item "o $widget (Gtk2::Widget) widget that received the event"
.ie n .IP "o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath." 4
.el .IP "o \f(CW$path\fR (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath." 4
.IX Item "o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath."
.ie n .IP "o $background_area (Gtk2::Gdk::Rectangle) background area as passed to ""RENDER""." 4
.el .IP "o \f(CW$background_area\fR (Gtk2::Gdk::Rectangle) background area as passed to \f(CWRENDER\fR." 4
.IX Item "o $background_area (Gtk2::Gdk::Rectangle) background area as passed to RENDER."
.ie n .IP "o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to ""RENDER""." 4
.el .IP "o \f(CW$cell_area\fR (Gtk2::Gdk::Rectangle) cell area as passed to \f(CWRENDER\fR." 4
.IX Item "o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to RENDER."
.ie n .IP "o $flags (Gtk2::CellRendererState) render flags" 4
.el .IP "o \f(CW$flags\fR (Gtk2::CellRendererState) render flags" 4
.IX Item "o $flags (Gtk2::CellRendererState) render flags"
.RE
.RS 4
.PD
.Sp
This method is called when an event occurs on a cell.  Implementing it is
not mandatory.  The return value should be \s-1TRUE\s0 if the event was
consumed/handled.
.RE
.ie n .IP "celleditable or undef = \s-1START_EDITING\s0 ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)" 4
.el .IP "celleditable or undef = \s-1START_EDITING\s0 ($cell, \f(CW$event\fR, \f(CW$widget\fR, \f(CW$path\fR, \f(CW$background_area\fR, \f(CW$cell_area\fR, \f(CW$flags\fR)" 4
.IX Item "celleditable or undef = START_EDITING ($cell, $event, $widget, $path, $background_area, $cell_area, $flags)"
.RS 4
.PD 0
.ie n .IP "o $cell (Gtk2::CellRenderer)" 4
.el .IP "o \f(CW$cell\fR (Gtk2::CellRenderer)" 4
.IX Item "o $cell (Gtk2::CellRenderer)"
.ie n .IP "o $event (Gtk2::Gdk::Event)" 4
.el .IP "o \f(CW$event\fR (Gtk2::Gdk::Event)" 4
.IX Item "o $event (Gtk2::Gdk::Event)"
.ie n .IP "o $widget (Gtk2::Widget) widget that received the event" 4
.el .IP "o \f(CW$widget\fR (Gtk2::Widget) widget that received the event" 4
.IX Item "o $widget (Gtk2::Widget) widget that received the event"
.ie n .IP "o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath." 4
.el .IP "o \f(CW$path\fR (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath." 4
.IX Item "o $path (string) widget-dependent string representation of the event location; e.g. for a Gtk2::TreeView, a string representation of a Gtk2::TreePath."
.ie n .IP "o $background_area (Gtk2::Gdk::Rectangle) background area as passed to ""RENDER""." 4
.el .IP "o \f(CW$background_area\fR (Gtk2::Gdk::Rectangle) background area as passed to \f(CWRENDER\fR." 4
.IX Item "o $background_area (Gtk2::Gdk::Rectangle) background area as passed to RENDER."
.ie n .IP "o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to ""RENDER""." 4
.el .IP "o \f(CW$cell_area\fR (Gtk2::Gdk::Rectangle) cell area as passed to \f(CWRENDER\fR." 4
.IX Item "o $cell_area (Gtk2::Gdk::Rectangle) cell area as passed to RENDER."
.ie n .IP "o $flags (Gtk2::CellRendererState) render flags" 4
.el .IP "o \f(CW$flags\fR (Gtk2::CellRendererState) render flags" 4
.IX Item "o $flags (Gtk2::CellRendererState) render flags"
.RE
.RS 4
.PD
.Sp
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.
.RE
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Gtk2, Glib::Object, Glib::InitiallyUnowned, Gtk2::Object
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2011 by the gtk2\-perl team.
.PP
This software is licensed under the \s-1LGPL.\s0  See Gtk2 for a full notice.