gtkmm  2.24.4
Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::CellRenderer Class Reference

CellRenderers are used by Gtk::TreeView columns to render the Gtk::TreeModel column data appropriately. More...

Inheritance diagram for Gtk::CellRenderer:
Inheritance graph
[legend]
Collaboration diagram for Gtk::CellRenderer:
Collaboration graph
[legend]

Public Member Functions

virtual ~CellRenderer ()
 
GtkCellRenderer* gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRenderer* gobj () const
 Provides access to the underlying C GtkObject. More...
 
void get_size (Widget& widget, const Gdk::Rectangle& cell_area, int& x_offset, int& y_offset, int& width, int& height) const
 Obtains the width and height needed to render the cell. More...
 
void get_size (Widget& widget, int& x_offset, int& y_offset, int& width, int& height) const
 Obtains the width and height needed to render the cell. More...
 
void render (const Glib::RefPtr< Gdk::Window >& window, Widget& widget, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, const Gdk::Rectangle& expose_area, CellRendererState flags)
 Invokes the virtual render function of the Gtk::CellRenderer. More...
 
bool activate (GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags)
 Passes an activate event to the cell renderer for possible processing. More...
 
CellEditablestart_editing (GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags=CellRendererState(0))
 Passes an activate event to the cell renderer for possible processing. More...
 
void set_fixed_size (int width, int height)
 Sets the renderer size to be explicit, independent of the properties set. More...
 
void get_fixed_size (int& width, int& height) const
 Fills in width and height with the appropriate size of cell. More...
 
void set_alignment (float align, float yalign)
 Sets the renderer's alignment within its available space. More...
 
void get_alignment (float& xalign, float& yalign) const
 Fills in xalign and yalign with the appropriate values of cell. More...
 
void set_padding (int xpad, int ypad)
 Sets the renderer's padding. More...
 
void get_padding (int& xpad, int& ypad) const
 Fills in xpad and ypad with the appropriate values of cell. More...
 
void set_visible (bool visible=true)
 Sets the cell renderer's visibility. More...
 
bool get_visible () const
 Returns the cell renderer's visibility. More...
 
void set_sensitive (bool sensitive=true)
 Sets the cell renderer's sensitivity. More...
 
bool get_sensitive () const
 Returns the cell renderer's sensitivity. More...
 
void editing_canceled ()
 Causes the cell renderer to emit the Gtk::CellRenderer::signal_editing_canceled() signal. More...
 
void stop_editing (bool canceled=false)
 Informs the cell renderer that the editing is stopped. More...
 
Glib::SignalProxy< void > signal_editing_canceled ()
 This signal is emitted when the user cancels the process of editing a cell. More...
 
Glib::SignalProxy< void, CellEditable*, const Glib::ustring& > signal_editing_started ()
 This signal gets emitted when a cell starts to be edited. More...
 
Glib::PropertyProxy< CellRendererModeproperty_mode ()
 Editable mode of the CellRenderer. More...
 
Glib::PropertyProxy_ReadOnly< CellRendererModeproperty_mode () const
 Editable mode of the CellRenderer. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Display the cell. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Display the cell. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Display the cell sensitive. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Display the cell sensitive. More...
 
Glib::PropertyProxy< float > property_xalign ()
 The x-align. More...
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 The x-align. More...
 
Glib::PropertyProxy< float > property_yalign ()
 The y-align. More...
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 The y-align. More...
 
Glib::PropertyProxy< unsigned int > property_xpad ()
 The xpad. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_xpad () const
 The xpad. More...
 
Glib::PropertyProxy< unsigned int > property_ypad ()
 The ypad. More...
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_ypad () const
 The ypad. More...
 
Glib::PropertyProxy< int > property_width ()
 The fixed width. More...
 
Glib::PropertyProxy_ReadOnly< int > property_width () const
 The fixed width. More...
 
Glib::PropertyProxy< int > property_height ()
 The fixed height. More...
 
Glib::PropertyProxy_ReadOnly< int > property_height () const
 The fixed height. More...
 
Glib::PropertyProxy< bool > property_is_expander ()
 Row has children. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expander () const
 Row has children. More...
 
Glib::PropertyProxy< bool > property_is_expanded ()
 Row is an expander row, and is expanded. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expanded () const
 Row is an expander row, and is expanded. More...
 
Glib::PropertyProxy_WriteOnly< Glib::ustringproperty_cell_background ()
 Cell background color as a string. More...
 
Glib::PropertyProxy< Gdk::Colorproperty_cell_background_gdk ()
 Cell background color as a GdkColor. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::Colorproperty_cell_background_gdk () const
 Cell background color as a GdkColor. More...
 
Glib::PropertyProxy< bool > property_cell_background_set ()
 Whether this tag affects the cell background color. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set () const
 Whether this tag affects the cell background color. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_editing () const
 Whether the cell renderer is currently in editing mode. More...
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObject* gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObject* gobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void* > property_user_data ()
 Anonymous User Data Pointer. More...
 
Glib::PropertyProxy_ReadOnly< void* > property_user_data () const
 Anonymous User Data Pointer. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
 
ObjectBaseoperator= (const ObjectBase &)=delete
 
void set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)
 
void get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const
 
void set_property (const Glib::ustring &property_name, const PropertyType &value)
 
void get_property (const Glib::ustring &property_name, PropertyType &value) const
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
void freeze_notify ()
 
void thaw_notify ()
 
virtual void reference () const
 
virtual void unreference () const
 
GObject * gobj ()
 
const GObject * gobj () const
 
GObject * gobj_copy () const
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 

Protected Member Functions

virtual void on_editing_canceled ()
 This is a default handler for the signal signal_editing_canceled(). More...
 
 CellRenderer ()
 
virtual void get_size_vfunc (Widget& widget, const Gdk::Rectangle* cell_area, int* x_offset, int* y_offset, int* width, int* height) const
 Override this in derived CellRenderers. More...
 
virtual void render_vfunc (const Glib::RefPtr< Gdk::Drawable >& window, Widget& widget, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, const Gdk::Rectangle& expose_area, CellRendererState flags)
 
virtual bool activate_vfunc (GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags)
 
virtual CellEditablestart_editing_vfunc (GdkEvent* event, Widget& widget, const Glib::ustring& path, const Gdk::Rectangle& background_area, const Gdk::Rectangle& cell_area, CellRendererState flags)
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexceptoverride
 
- Protected Member Functions inherited from Glib::ObjectBase
 ObjectBase ()
 
 ObjectBase (const char *custom_type_name)
 
 ObjectBase (const std::type_info &custom_type_info)
 
 ObjectBase (ObjectBase &&src) noexcept
 
ObjectBaseoperator= (ObjectBase &&src) noexcept
 
virtual ~ObjectBase () noexcept=0
 
void initialize (GObject *castitem)
 
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)
 

Related Functions

(Note that these are not member functions.)

Gtk::CellRendererwrap (GtkCellRenderer* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

CellRenderers are used by Gtk::TreeView columns to render the Gtk::TreeModel column data appropriately.

They display, and allow editing of, the values of their properties. In most cases, Gtk::TreeView::append_column() will automatically choose the appropriate renderer for the mode column's data type, so you will rarely need to worry about these classes.

Constructor & Destructor Documentation

virtual Gtk::CellRenderer::~CellRenderer ( )
virtual
Gtk::CellRenderer::CellRenderer ( )
protected

Member Function Documentation

bool Gtk::CellRenderer::activate ( GdkEvent *  event,
Widget widget,
const Glib::ustring path,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags 
)

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

Some cell renderers may use events; for example, Gtk::CellRendererToggle toggles when it gets a mouse click.

Parameters
eventA Gdk::Event.
widgetWidget that received the event.
pathWidget-dependent string representation of the event location; e.g. for Gtk::TreeView, a string representation of Gtk::TreePath.
background_areaBackground area as passed to render().
cell_areaCell area as passed to render().
flagsRender flags.
Returns
true if the event was consumed/handled.
virtual bool Gtk::CellRenderer::activate_vfunc ( GdkEvent *  event,
Widget widget,
const Glib::ustring path,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags 
)
protectedvirtual
void Gtk::CellRenderer::editing_canceled ( )

Causes the cell renderer to emit the Gtk::CellRenderer::signal_editing_canceled() signal.

This function is for use only by implementations of cell renderers that need to notify the client program that an editing process was canceled and the changes were not committed.

Since gtkmm 2.4:
Deprecated: 2.6: Use stop_editing() instead
Deprecated:
Use stop_editing().
void Gtk::CellRenderer::get_alignment ( float &  xalign,
float &  yalign 
) const

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

Since gtkmm 2.18:
Parameters
xalignLocation to fill in with the x alignment of the cell, or nullptr.
yalignLocation to fill in with the y alignment of the cell, or nullptr.
void Gtk::CellRenderer::get_fixed_size ( int &  width,
int &  height 
) const

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

Parameters
widthLocation to fill in with the fixed width of the widget.
heightLocation to fill in with the fixed height of the widget.
void Gtk::CellRenderer::get_padding ( int &  xpad,
int &  ypad 
) const

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

Since gtkmm 2.18:
Parameters
xpadLocation to fill in with the x padding of the cell, or nullptr.
ypadLocation to fill in with the y padding of the cell, or nullptr.
bool Gtk::CellRenderer::get_sensitive ( ) const

Returns the cell renderer's sensitivity.

Since gtkmm 2.18:
Returns
true if the cell renderer is sensitive.
void Gtk::CellRenderer::get_size ( Widget widget,
const Gdk::Rectangle cell_area,
int &  x_offset,
int &  y_offset,
int &  width,
int &  height 
) const

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 render(). Fills in the x and y offsets of the cell relative to this location. Please note that the values set in width and height, as well as those in x_offset and y_offset are inclusive of the xpad and ypad properties.

Parameters
widgetThe widget the renderer is rendering to.
cell_areaThe area a cell will be allocated.
x_offsetLocation to return x offset of cell relative to cell_area.
y_offsetLocation to return y offset of cell relative to cell_area.
widthLocation to return width needed to render a cell.
heightLocation to return height needed to render a cell.
void Gtk::CellRenderer::get_size ( Widget widget,
int &  x_offset,
int &  y_offset,
int &  width,
int &  height 
) const

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 render(). Fills in the x and y offsets of the cell relative to this location. Please note that the values set in width and height , as well as those in x_offset and y_offset are inclusive of the xpad and ypad properties.

Parameters
widgetThe widget the renderer is rendering to.
x_offsetLocation to return x offset of cell relative to cell_area.
y_offsetLocation to return y offset of cell relative to cell_area.
widthLocation to return width needed to render a cell.
heightLocation to return height needed to render a cell.
virtual void Gtk::CellRenderer::get_size_vfunc ( Widget widget,
const Gdk::Rectangle cell_area,
int *  x_offset,
int *  y_offset,
int *  width,
int *  height 
) const
protectedvirtual

Override this in derived CellRenderers.

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 render(). If cell_area is not 0, 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 x_offset and y_offset are inclusive of the xpad and ypad properties.

Parameters
widgetThe widget the renderer is rendering to.
cell_areaThe area a cell will be allocated, or 0.
x_offsetx offset of cell relative to cell_area.
y_offsety offset of cell relative to cell_area.
widthWidth needed to render a cell.
heightHeight needed to render a cell.
bool Gtk::CellRenderer::get_visible ( ) const

Returns the cell renderer's visibility.

Since gtkmm 2.18:
Returns
true if the cell renderer is visible.
GtkCellRenderer* Gtk::CellRenderer::gobj ( )
inline

Provides access to the underlying C GtkObject.

const GtkCellRenderer* Gtk::CellRenderer::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

virtual void Gtk::CellRenderer::on_editing_canceled ( )
protectedvirtual

This is a default handler for the signal signal_editing_canceled().

Glib::PropertyProxy_WriteOnly< Glib::ustring > Gtk::CellRenderer::property_cell_background ( )

Cell background color as a string.

Returns
A PropertyProxy_WriteOnly that allows you to set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Gdk::Color > Gtk::CellRenderer::property_cell_background_gdk ( )

Cell background color as a GdkColor.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Gdk::Color > Gtk::CellRenderer::property_cell_background_gdk ( ) const

Cell background color as a GdkColor.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::CellRenderer::property_cell_background_set ( )

Whether this tag affects the cell background color.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_cell_background_set ( ) const

Whether this tag affects the cell background color.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_editing ( ) const

Whether the cell renderer is currently in editing mode.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::CellRenderer::property_height ( )

The fixed height.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::CellRenderer::property_height ( ) const

The fixed height.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::CellRenderer::property_is_expanded ( )

Row is an expander row, and is expanded.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_is_expanded ( ) const

Row is an expander row, and is expanded.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::CellRenderer::property_is_expander ( )

Row has children.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_is_expander ( ) const

Row has children.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< CellRendererMode > Gtk::CellRenderer::property_mode ( )

Editable mode of the CellRenderer.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< CellRendererMode > Gtk::CellRenderer::property_mode ( ) const

Editable mode of the CellRenderer.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::CellRenderer::property_sensitive ( )

Display the cell sensitive.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_sensitive ( ) const

Display the cell sensitive.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::CellRenderer::property_visible ( )

Display the cell.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_visible ( ) const

Display the cell.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< int > Gtk::CellRenderer::property_width ( )

The fixed width.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< int > Gtk::CellRenderer::property_width ( ) const

The fixed width.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< float > Gtk::CellRenderer::property_xalign ( )

The x-align.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< float > Gtk::CellRenderer::property_xalign ( ) const

The x-align.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< unsigned int > Gtk::CellRenderer::property_xpad ( )

The xpad.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::CellRenderer::property_xpad ( ) const

The xpad.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< float > Gtk::CellRenderer::property_yalign ( )

The y-align.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< float > Gtk::CellRenderer::property_yalign ( ) const

The y-align.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< unsigned int > Gtk::CellRenderer::property_ypad ( )

The ypad.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::CellRenderer::property_ypad ( ) const

The ypad.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::CellRenderer::render ( const Glib::RefPtr< Gdk::Window >&  window,
Widget widget,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
const Gdk::Rectangle expose_area,
CellRendererState  flags 
)

Invokes the virtual render function of the Gtk::CellRenderer.

The three passed-in rectangles are areas of window. Most renderers will draw within cell_area; the xalign, yalign, xpad, and ypad fields of the Gtk::CellRenderer 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 tile to cover the entire window. expose_area is a clip rectangle.

Parameters
windowA Gdk::Drawable to draw to.
widgetThe widget owning window.
background_areaEntire cell area (including tree expanders and maybe padding on the sides).
cell_areaArea normally rendered by a cell renderer.
expose_areaArea that actually needs updating.
flagsFlags that affect rendering.
virtual void Gtk::CellRenderer::render_vfunc ( const Glib::RefPtr< Gdk::Drawable >&  window,
Widget widget,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
const Gdk::Rectangle expose_area,
CellRendererState  flags 
)
protectedvirtual
void Gtk::CellRenderer::set_alignment ( float  align,
float  yalign 
)

Sets the renderer's alignment within its available space.

Since gtkmm 2.18:
Parameters
alignThe x alignment of the cell renderer.
yalignThe y alignment of the cell renderer.
void Gtk::CellRenderer::set_fixed_size ( int  width,
int  height 
)

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

Parameters
widthThe width of the cell renderer, or -1.
heightThe height of the cell renderer, or -1.
void Gtk::CellRenderer::set_padding ( int  xpad,
int  ypad 
)

Sets the renderer's padding.

Since gtkmm 2.18:
Parameters
xpadThe x padding of the cell renderer.
ypadThe y padding of the cell renderer.
void Gtk::CellRenderer::set_sensitive ( bool  sensitive = true)

Sets the cell renderer's sensitivity.

Since gtkmm 2.18:
Parameters
sensitiveThe sensitivity of the cell.
void Gtk::CellRenderer::set_visible ( bool  visible = true)

Sets the cell renderer's visibility.

Since gtkmm 2.18:
Parameters
visibleThe visibility of the cell.
Glib::SignalProxy< void > Gtk::CellRenderer::signal_editing_canceled ( )

This signal is 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.

See also
editing_canceled()
Slot Prototype:
void on_my_editing_canceled()
Glib::SignalProxy< void,CellEditable*,const Glib::ustring& > Gtk::CellRenderer::signal_editing_started ( )

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 an EntryCompletion or setting up additional columns in a ComboBox.

Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of editable before doing any specific setup.

Note that this signal does not work yet in gtkmm. See http://bugzilla.gnome.org/show_bug.cgi?id=301597

Since gtkmm 2.6:
Parameters
editablethe CellEditable.
paththe path identifying the edited cell.
Slot Prototype:
void on_my_editing_started(CellEditable* editable, const Glib::ustring& path)
CellEditable* Gtk::CellRenderer::start_editing ( GdkEvent *  event,
Widget widget,
const Glib::ustring path,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags = CellRendererState(0) 
)

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

Parameters
eventA Gdk::Event.
widgetWidget that received the event.
pathWidget-dependent string representation of the event location; e.g. for Gtk::TreeView, a string representation of Gtk::TreePath.
background_areaBackground area as passed to render().
cell_areaCell area as passed to render().
flagsRender flags.
Returns
A new Gtk::CellEditable, or nullptr.
virtual CellEditable* Gtk::CellRenderer::start_editing_vfunc ( GdkEvent *  event,
Widget widget,
const Glib::ustring path,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags 
)
protectedvirtual
void Gtk::CellRenderer::stop_editing ( bool  canceled = false)

Informs the cell renderer that the editing is stopped.

If canceled is true, the cell renderer will emit the Gtk::CellRenderer::signal_editing_canceled() signal.

This function should be called by cell renderer implementations in response to the Gtk::CellEditable::signal_editing_done() signal of Gtk::CellEditable.

Since gtkmm 2.6:
Parameters
canceledtrue if the editing has been canceled.

Friends And Related Function Documentation

Gtk::CellRenderer* wrap ( GtkCellRenderer *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: