gtkmm 3.24.7
Public Member Functions | Static 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...

#include <gtkmm/cellrenderer.h>

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

Public Member Functions

 CellRenderer (CellRenderer && src) noexcept
 
CellRendereroperator= (CellRenderer && src) noexcept
 
 CellRenderer (const CellRenderer &)=delete
 
CellRendereroperator= (const CellRenderer &)=delete
 
 ~CellRenderer () noexcept override
 
GtkCellRenderer * gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkCellRenderer * gobj () const
 Provides access to the underlying C GObject. More...
 
SizeRequestMode get_request_mode () const
 Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. More...
 
void get_preferred_width (Widget & widget, int & minimum_width, int & natural_width) const
 Retreives a renderer’s natural size when rendered to widget. More...
 
void get_preferred_height_for_width (Widget & widget, int width, int & minimum_height, int & natural_height) const
 Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width. More...
 
void get_preferred_height (Widget & widget, int & minimum_height, int & natural_height) const
 Retreives a renderer’s natural size when rendered to widget. More...
 
void get_preferred_width_for_height (Widget & widget, int height, int & minimum_width, int & natural_width) const
 Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height. More...
 
void get_preferred_size (Widget & widget, Requisition & minimum_size, Requisition & natural_size) const
 Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management. More...
 
void get_aligned_area (Widget & widget, CellRendererState flags, const Gdk::Rectangle & cell_area, Gdk::Rectangle & aligned_area)
 Gets the aligned area used by cell inside cell_area. More...
 
void render (const ::Cairo::RefPtr< ::Cairo::Context > & cr, Widget & widget, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_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))
 Starts editing the contents of this cell, through a new Gtk::CellEditable widget created by the Gtk::CellRendererClass.start_editing virtual function. 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 xalign, 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...
 
bool is_activatable () const
 Checks whether the cell renderer can do something when activated. More...
 
void stop_editing (bool canceled=false)
 Informs the cell renderer that the editing is stopped. More...
 
StateFlags get_state (Widget & widget, CellRendererState cell_state) const
 Translates the cell renderer state to Gtk::StateFlags, based on the cell renderer and widget sensitivity, and the given Gtk::CellRendererState. More...
 
StateFlags get_state (CellRendererState cell_state) const
 Translates the cell renderer state to StateFlags, based on the cell renderer and the given CellRendererState. More...
 
Glib::SignalProxy< void > signal_editing_canceled ()
 
Glib::SignalProxy< void, CellEditable *, const Glib::ustring & > signal_editing_started ()
 
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::ustring > property_cell_background ()
 Cell background color as a string. More...
 
Glib::PropertyProxy< Gdk::Colorproperty_cell_background_gdk ()
 Cell background as a Gdk::Color. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::Colorproperty_cell_background_gdk () const
 Cell background as a Gdk::Color. More...
 
Glib::PropertyProxy< Gdk::RGBAproperty_cell_background_rgba ()
 Cell background as a Gdk::RGBA. More...
 
Glib::PropertyProxy_ReadOnly< Gdk::RGBAproperty_cell_background_rgba () const
 Cell background as a Gdk::RGBA. More...
 
Glib::PropertyProxy< bool > property_cell_background_set ()
 Whether the cell background color is set. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set () const
 Whether the cell background color is set. 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
 Object (Object && src) noexcept
 
Objectoperator= (Object && src) noexcept
 
 ~Object () noexcept override
 
GObject * gobj ()
 Provides access to the underlying C GObject. More...
 
const GObject * gobj () const
 Provides access to the underlying C GObject. More...
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

virtual void on_editing_canceled ()
 This is a default handler for the signal signal_editing_canceled(). More...
 
virtual void on_editing_started (CellEditable * editable, const Glib::ustring & path)
 This is a default handler for the signal signal_editing_started(). More...
 
 CellRenderer ()
 
virtual SizeRequestMode get_request_mode_vfunc () const
 
virtual void get_preferred_width_vfunc (Widget & widget, int & minimum_width, int & natural_width) const
 
virtual void get_preferred_height_for_width_vfunc (Widget & widget, int width, int & minimum_height, int & natural_height) const
 
virtual void get_preferred_height_vfunc (Widget & widget, int & minimum_height, int & natural_height) const
 
virtual void get_preferred_width_for_height_vfunc (Widget & widget, int height, int & minimum_width, int & natural_width) const
 
virtual void render_vfunc (const ::Cairo::RefPtr< ::Cairo::Context > & cr, Widget & widget, const Gdk::Rectangle & background_area, const Gdk::Rectangle & cell_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)
 

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

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

◆ CellRenderer() [1/3]

Gtk::CellRenderer::CellRenderer ( CellRenderer &&  src)
noexcept

◆ CellRenderer() [2/3]

Gtk::CellRenderer::CellRenderer ( const CellRenderer )
delete

◆ ~CellRenderer()

Gtk::CellRenderer::~CellRenderer ( )
overridenoexcept

◆ CellRenderer() [3/3]

Gtk::CellRenderer::CellRenderer ( )
protected

Member Function Documentation

◆ activate()

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.

◆ activate_vfunc()

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

◆ get_aligned_area()

void Gtk::CellRenderer::get_aligned_area ( Widget widget,
CellRendererState  flags,
const Gdk::Rectangle cell_area,
Gdk::Rectangle aligned_area 
)

Gets the aligned area used by cell inside cell_area.

Used for finding the appropriate edit and focus rectangle.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
flagsRender flags.
cell_areaCell area which would be passed to render().
aligned_areaThe return location for the space inside cell_area that would acually be used to render.

◆ get_alignment()

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.

◆ get_fixed_size()

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.

◆ get_padding()

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.

◆ get_preferred_height()

void Gtk::CellRenderer::get_preferred_height ( Widget widget,
int &  minimum_height,
int &  natural_height 
) const

Retreives a renderer’s natural size when rendered to widget.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
minimum_heightLocation to store the minimum size, or nullptr.
natural_heightLocation to store the natural size, or nullptr.

◆ get_preferred_height_for_width()

void Gtk::CellRenderer::get_preferred_height_for_width ( Widget widget,
int  width,
int &  minimum_height,
int &  natural_height 
) const

Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
widthThe size which is available for allocation.
minimum_heightLocation for storing the minimum size, or nullptr.
natural_heightLocation for storing the preferred size, or nullptr.

◆ get_preferred_height_for_width_vfunc()

virtual void Gtk::CellRenderer::get_preferred_height_for_width_vfunc ( Widget widget,
int  width,
int &  minimum_height,
int &  natural_height 
) const
protectedvirtual

◆ get_preferred_height_vfunc()

virtual void Gtk::CellRenderer::get_preferred_height_vfunc ( Widget widget,
int &  minimum_height,
int &  natural_height 
) const
protectedvirtual

◆ get_preferred_size()

void Gtk::CellRenderer::get_preferred_size ( Widget widget,
Requisition minimum_size,
Requisition natural_size 
) const

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
minimum_sizeLocation for storing the minimum size, or nullptr.
natural_sizeLocation for storing the natural size, or nullptr.

◆ get_preferred_width()

void Gtk::CellRenderer::get_preferred_width ( Widget widget,
int &  minimum_width,
int &  natural_width 
) const

Retreives a renderer’s natural size when rendered to widget.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
minimum_widthLocation to store the minimum size, or nullptr.
natural_widthLocation to store the natural size, or nullptr.

◆ get_preferred_width_for_height()

void Gtk::CellRenderer::get_preferred_width_for_height ( Widget widget,
int  height,
int &  minimum_width,
int &  natural_width 
) const

Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.

Since gtkmm 3.0:
Parameters
widgetThe Gtk::Widget this cell will be rendering to.
heightThe size which is available for allocation.
minimum_widthLocation for storing the minimum size, or nullptr.
natural_widthLocation for storing the preferred size, or nullptr.

◆ get_preferred_width_for_height_vfunc()

virtual void Gtk::CellRenderer::get_preferred_width_for_height_vfunc ( Widget widget,
int  height,
int &  minimum_width,
int &  natural_width 
) const
protectedvirtual

◆ get_preferred_width_vfunc()

virtual void Gtk::CellRenderer::get_preferred_width_vfunc ( Widget widget,
int &  minimum_width,
int &  natural_width 
) const
protectedvirtual

◆ get_request_mode()

SizeRequestMode Gtk::CellRenderer::get_request_mode ( ) const

Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.

Since gtkmm 3.0:
Returns
The Gtk::SizeRequestMode preferred by this renderer.

◆ get_request_mode_vfunc()

virtual SizeRequestMode Gtk::CellRenderer::get_request_mode_vfunc ( ) const
protectedvirtual

◆ get_sensitive()

bool Gtk::CellRenderer::get_sensitive ( ) const

Returns the cell renderer’s sensitivity.

Since gtkmm 2.18:
Returns
true if the cell renderer is sensitive.

◆ get_state() [1/2]

StateFlags Gtk::CellRenderer::get_state ( CellRendererState  cell_state) const

Translates the cell renderer state to StateFlags, based on the cell renderer and the given CellRendererState.

Parameters
cell_stateThe cell renderer state.
Returns
The widget state flags applying to the cell renderer.
Since gtkmm 3.0:

◆ get_state() [2/2]

StateFlags Gtk::CellRenderer::get_state ( Widget widget,
CellRendererState  cell_state 
) const

Translates the cell renderer state to Gtk::StateFlags, based on the cell renderer and widget sensitivity, and the given Gtk::CellRendererState.

Since gtkmm 3.0:
Parameters
widgetA Gtk::Widget, or nullptr.
cell_stateCell renderer state.
Returns
The widget state flags applying to cell.

◆ get_type()

static GType Gtk::CellRenderer::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ get_visible()

bool Gtk::CellRenderer::get_visible ( ) const

Returns the cell renderer’s visibility.

Since gtkmm 2.18:
Returns
true if the cell renderer is visible.

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

◆ is_activatable()

bool Gtk::CellRenderer::is_activatable ( ) const

Checks whether the cell renderer can do something when activated.

Since gtkmm 3.0:
Returns
true if the cell renderer can do anything when activated.

◆ on_editing_canceled()

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

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

◆ on_editing_started()

virtual void Gtk::CellRenderer::on_editing_started ( CellEditable editable,
const Glib::ustring &  path 
)
protectedvirtual

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

◆ operator=() [1/2]

CellRenderer & Gtk::CellRenderer::operator= ( CellRenderer &&  src)
noexcept

◆ operator=() [2/2]

CellRenderer & Gtk::CellRenderer::operator= ( const CellRenderer )
delete

◆ property_cell_background()

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

Cell background color as a string.

Default value: ""

Returns
A PropertyProxy_WriteOnly that allows you to set the value of the property, or receive notification when the value of the property changes.

◆ property_cell_background_gdk() [1/2]

Glib::PropertyProxy< Gdk::Color > Gtk::CellRenderer::property_cell_background_gdk ( )

Cell background as a Gdk::Color.

Deprecated: 3.4: Use Gtk::CellRenderer::property_cell_background_rgba() instead.

Deprecated:
Use property_cell_background_rgba() instead.
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.

◆ property_cell_background_gdk() [2/2]

Glib::PropertyProxy_ReadOnly< Gdk::Color > Gtk::CellRenderer::property_cell_background_gdk ( ) const

Cell background as a Gdk::Color.

Deprecated: 3.4: Use Gtk::CellRenderer::property_cell_background_rgba() instead.

Deprecated:
Use property_cell_background_rgba() instead.
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_cell_background_rgba() [1/2]

Glib::PropertyProxy< Gdk::RGBA > Gtk::CellRenderer::property_cell_background_rgba ( )

Cell background as a Gdk::RGBA.

Since gtkmm 3.0:
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.

◆ property_cell_background_rgba() [2/2]

Glib::PropertyProxy_ReadOnly< Gdk::RGBA > Gtk::CellRenderer::property_cell_background_rgba ( ) const

Cell background as a Gdk::RGBA.

Since gtkmm 3.0:
Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_cell_background_set() [1/2]

Glib::PropertyProxy< bool > Gtk::CellRenderer::property_cell_background_set ( )

Whether the cell background color is set.

Default value: false

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.

◆ property_cell_background_set() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_cell_background_set ( ) const

Whether the cell background color is set.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_editing()

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_editing ( ) const

Whether the cell renderer is currently in editing mode.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_height() [1/2]

Glib::PropertyProxy< int > Gtk::CellRenderer::property_height ( )

The fixed height.

Default value: -1

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.

◆ property_height() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::CellRenderer::property_height ( ) const

The fixed height.

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_is_expanded() [1/2]

Glib::PropertyProxy< bool > Gtk::CellRenderer::property_is_expanded ( )

Row is an expander row, and is expanded.

Default value: false

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.

◆ property_is_expanded() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_is_expanded ( ) const

Row is an expander row, and is expanded.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_is_expander() [1/2]

Glib::PropertyProxy< bool > Gtk::CellRenderer::property_is_expander ( )

Row has children.

Default value: false

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.

◆ property_is_expander() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_is_expander ( ) const

Row has children.

Default value: false

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_mode() [1/2]

Glib::PropertyProxy< CellRendererMode > Gtk::CellRenderer::property_mode ( )

Editable mode of the CellRenderer.

Default value: Gtk::CELL_RENDERER_MODE_INERT

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.

◆ property_mode() [2/2]

Glib::PropertyProxy_ReadOnly< CellRendererMode > Gtk::CellRenderer::property_mode ( ) const

Editable mode of the CellRenderer.

Default value: Gtk::CELL_RENDERER_MODE_INERT

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_sensitive() [1/2]

Glib::PropertyProxy< bool > Gtk::CellRenderer::property_sensitive ( )

Display the cell sensitive.

Default value: true

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.

◆ property_sensitive() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_sensitive ( ) const

Display the cell sensitive.

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_visible() [1/2]

Glib::PropertyProxy< bool > Gtk::CellRenderer::property_visible ( )

Display the cell.

Default value: true

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.

◆ property_visible() [2/2]

Glib::PropertyProxy_ReadOnly< bool > Gtk::CellRenderer::property_visible ( ) const

Display the cell.

Default value: true

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_width() [1/2]

Glib::PropertyProxy< int > Gtk::CellRenderer::property_width ( )

The fixed width.

Default value: -1

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.

◆ property_width() [2/2]

Glib::PropertyProxy_ReadOnly< int > Gtk::CellRenderer::property_width ( ) const

The fixed width.

Default value: -1

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_xalign() [1/2]

Glib::PropertyProxy< float > Gtk::CellRenderer::property_xalign ( )

The x-align.

Default value: 0.5

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.

◆ property_xalign() [2/2]

Glib::PropertyProxy_ReadOnly< float > Gtk::CellRenderer::property_xalign ( ) const

The x-align.

Default value: 0.5

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_xpad() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::CellRenderer::property_xpad ( )

The xpad.

Default value: 0

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.

◆ property_xpad() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::CellRenderer::property_xpad ( ) const

The xpad.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_yalign() [1/2]

Glib::PropertyProxy< float > Gtk::CellRenderer::property_yalign ( )

The y-align.

Default value: 0.5

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.

◆ property_yalign() [2/2]

Glib::PropertyProxy_ReadOnly< float > Gtk::CellRenderer::property_yalign ( ) const

The y-align.

Default value: 0.5

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_ypad() [1/2]

Glib::PropertyProxy< unsigned int > Gtk::CellRenderer::property_ypad ( )

The ypad.

Default value: 0

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.

◆ property_ypad() [2/2]

Glib::PropertyProxy_ReadOnly< unsigned int > Gtk::CellRenderer::property_ypad ( ) const

The ypad.

Default value: 0

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ render()

void Gtk::CellRenderer::render ( const ::Cairo::RefPtr< ::Cairo::Context > &  cr,
Widget widget,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags 
)

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

The three passed-in rectangles are areas in cr. 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.

Parameters
crA cairo context 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.
flagsFlags that affect rendering.

◆ render_vfunc()

virtual void Gtk::CellRenderer::render_vfunc ( const ::Cairo::RefPtr< ::Cairo::Context > &  cr,
Widget widget,
const Gdk::Rectangle background_area,
const Gdk::Rectangle cell_area,
CellRendererState  flags 
)
protectedvirtual

◆ set_alignment()

void Gtk::CellRenderer::set_alignment ( float  xalign,
float  yalign 
)

Sets the renderer’s alignment within its available space.

Since gtkmm 2.18:
Parameters
xalignThe x alignment of the cell renderer.
yalignThe y alignment of the cell renderer.

◆ set_fixed_size()

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.

◆ set_padding()

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.

◆ set_sensitive()

void Gtk::CellRenderer::set_sensitive ( bool  sensitive = true)

Sets the cell renderer’s sensitivity.

Since gtkmm 2.18:
Parameters
sensitiveThe sensitivity of the cell.

◆ set_visible()

void Gtk::CellRenderer::set_visible ( bool  visible = true)

Sets the cell renderer’s visibility.

Since gtkmm 2.18:
Parameters
visibleThe visibility of the cell.

◆ signal_editing_canceled()

Glib::SignalProxy< void > Gtk::CellRenderer::signal_editing_canceled ( )
Slot Prototype:
void on_my_editing_canceled()

Flags: Run First

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.

See also: Gtk::CellRenderer::stop_editing().

Since gtkmm 2.4:

◆ signal_editing_started()

Glib::SignalProxy< void, CellEditable *, const Glib::ustring & > Gtk::CellRenderer::signal_editing_started ( )
Slot Prototype:
void on_my_editing_started(CellEditable* editable, const Glib::ustring& path)

Flags: Run First

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

See Gtk::CellEditable::start_editing() for information on the lifecycle of the editable and a way to do setup that doesn’t depend on the renderer.

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, as in the following example:

[C example ellipted]

Since gtkmm 2.6:
Parameters
editableThe Gtk::CellEditable.
pathThe path identifying the edited cell.

◆ start_editing()

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

Starts editing the contents of this cell, through a new Gtk::CellEditable widget created by the Gtk::CellRendererClass.start_editing virtual function.

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 for editing this cell, or nullptr if editing is not possible.

◆ start_editing_vfunc()

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

◆ stop_editing()

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

◆ wrap()

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.