Gtk::CellRendererPixbuf Class Reference

Renders a pixbuf in a cell. More...

#include <gtkmm/cellrendererpixbuf.h>

Inheritance diagram for Gtk::CellRendererPixbuf:

Public Member Functions
	CellRendererPixbuf (CellRendererPixbuf &&src) noexcept
CellRendererPixbuf &	operator= (CellRendererPixbuf &&src) noexcept
	CellRendererPixbuf (const CellRendererPixbuf &)=delete
CellRendererPixbuf &	operator= (const CellRendererPixbuf &)=delete
	~CellRendererPixbuf () noexcept override
GtkCellRendererPixbuf *	gobj ()
	Provides access to the underlying C GObject.
const GtkCellRendererPixbuf *	gobj () const
	Provides access to the underlying C GObject.
	CellRendererPixbuf ()
Glib::PropertyProxy_WriteOnly< Glib::RefPtr< Gdk::Pixbuf > >	property_pixbuf ()
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > >	property_pixbuf_expander_open ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > >	property_pixbuf_expander_open () const
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > >	property_pixbuf_expander_closed ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > >	property_pixbuf_expander_closed () const
Glib::PropertyProxy< Gtk::IconSize >	property_icon_size ()
	The Gtk::IconSize value that specifies the size of the rendered icon.
Glib::PropertyProxy_ReadOnly< Gtk::IconSize >	property_icon_size () const
	The Gtk::IconSize value that specifies the size of the rendered icon.
Glib::PropertyProxy< Glib::ustring >	property_icon_name ()
	The name of the themed icon to display.
Glib::PropertyProxy_ReadOnly< Glib::ustring >	property_icon_name () const
	The name of the themed icon to display.
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > >	property_gicon ()
	The GIcon representing the icon to display.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > >	property_gicon () const
	The GIcon representing the icon to display.
Glib::PropertyProxy< Glib::RefPtr< Gdk::Texture > >	property_texture ()
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Texture > >	property_texture () const
Public Member Functions inherited from Gtk::CellRenderer
	CellRenderer (CellRenderer &&src) noexcept
CellRenderer &	operator= (CellRenderer &&src) noexcept
	CellRenderer (const CellRenderer &)=delete
CellRenderer &	operator= (const CellRenderer &)=delete
	~CellRenderer () noexcept override
GtkCellRenderer *	gobj ()
	Provides access to the underlying C GObject.
const GtkCellRenderer *	gobj () const
	Provides access to the underlying C GObject.
SizeRequestMode	get_request_mode () const
	Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
void	get_preferred_width (Widget &widget, int &minimum_width, int &natural_width) const
	Retrieves a renderer’s natural size when rendered to widget.
void	get_preferred_height_for_width (Widget &widget, int width, int &minimum_height, int &natural_height) const
	Retrieves a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.
void	get_preferred_height (Widget &widget, int &minimum_height, int &natural_height) const
	Retrieves a renderer’s natural size when rendered to widget.
void	get_preferred_width_for_height (Widget &widget, int height, int &minimum_width, int &natural_width) const
	Retrieves a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.
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.
Gdk::Rectangle	get_aligned_area (Widget &widget, CellRendererState flags, const Gdk::Rectangle &cell_area) const
	Gets the aligned area used by this CellRenderer inside cell_area.
void	snapshot (const Glib::RefPtr< Gtk::Snapshot > & snapshot, Widget &widget, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
	Invokes the virtual render function of the Gtk::CellRenderer.
bool	activate (const Glib::RefPtr< const Gdk::Event > & 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.
CellEditable *	start_editing (const Glib::RefPtr< const Gdk::Event > & 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.
void	set_fixed_size (int width, int height)
	Sets the renderer size to be explicit, independent of the properties set.
void	get_fixed_size (int & width, int &height) const
	Fills in width and height with the appropriate size of cell.
void	set_alignment (float xalign, float yalign)
	Sets the renderer’s alignment within its available space.
void	get_alignment (float &xalign, float &yalign) const
	Fills in xalign and yalign with the appropriate values of cell.
void	set_padding (int xpad, int ypad)
	Sets the renderer’s padding.
void	get_padding (int &xpad, int &ypad) const
	Fills in xpad and ypad with the appropriate values of cell.
void	set_visible (bool visible=true)
	Sets the cell renderer’s visibility.
bool	get_visible () const
	Returns the cell renderer’s visibility.
void	set_sensitive (bool sensitive=true)
	Sets the cell renderer’s sensitivity.
bool	get_sensitive () const
	Returns the cell renderer’s sensitivity.
bool	is_activatable () const
	Checks whether the cell renderer can do something when activated.
void	set_is_expander (bool is_expander=true)
	Sets whether the given Gtk::CellRenderer is an expander.
bool	get_is_expander () const
	Checks whether the given Gtk::CellRenderer is an expander.
void	set_is_expanded (bool is_expanded=true)
	Sets whether the given Gtk::CellRenderer is expanded.
bool	get_is_expanded () const
	Checks whether the given Gtk::CellRenderer is expanded.
void	stop_editing (bool canceled=false)
	Informs the cell renderer that the editing is stopped.
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.
StateFlags	get_state (CellRendererState cell_state) const
	A get_state() convenience overload.
Glib::SignalProxy< void()>	signal_editing_canceled ()
Glib::SignalProxy< void(CellEditable *, const Glib::ustring &)>	signal_editing_started ()
Glib::PropertyProxy< CellRendererMode >	property_mode ()
	Default value: Gtk::CellRendererMode::INERT.
Glib::PropertyProxy_ReadOnly< CellRendererMode >	property_mode () const
	Default value: Gtk::CellRendererMode::INERT.
Glib::PropertyProxy< bool >	property_visible ()
	Default value: true
Glib::PropertyProxy_ReadOnly< bool >	property_visible () const
	Default value: true
Glib::PropertyProxy< bool >	property_sensitive ()
	Default value: true
Glib::PropertyProxy_ReadOnly< bool >	property_sensitive () const
	Default value: true
Glib::PropertyProxy< float >	property_xalign ()
	Default value: 0.5.
Glib::PropertyProxy_ReadOnly< float >	property_xalign () const
	Default value: 0.5.
Glib::PropertyProxy< float >	property_yalign ()
	Default value: 0.5.
Glib::PropertyProxy_ReadOnly< float >	property_yalign () const
	Default value: 0.5.
Glib::PropertyProxy< unsigned int >	property_xpad ()
	Default value: 0.
Glib::PropertyProxy_ReadOnly< unsigned int >	property_xpad () const
	Default value: 0.
Glib::PropertyProxy< unsigned int >	property_ypad ()
	Default value: 0.
Glib::PropertyProxy_ReadOnly< unsigned int >	property_ypad () const
	Default value: 0.
Glib::PropertyProxy< int >	property_width ()
	Default value: -1.
Glib::PropertyProxy_ReadOnly< int >	property_width () const
	Default value: -1.
Glib::PropertyProxy< int >	property_height ()
	Default value: -1.
Glib::PropertyProxy_ReadOnly< int >	property_height () const
	Default value: -1.
Glib::PropertyProxy< bool >	property_is_expander ()
	Default value: false
Glib::PropertyProxy_ReadOnly< bool >	property_is_expander () const
	Default value: false
Glib::PropertyProxy< bool >	property_is_expanded ()
	Default value: false
Glib::PropertyProxy_ReadOnly< bool >	property_is_expanded () const
	Default value: false
Glib::PropertyProxy_WriteOnly< Glib::ustring >	property_cell_background ()
	Default value: "".
Glib::PropertyProxy< Gdk::RGBA >	property_cell_background_rgba ()
	Cell background as a GdkRGBA
Glib::PropertyProxy_ReadOnly< Gdk::RGBA >	property_cell_background_rgba () const
	Cell background as a GdkRGBA
Glib::PropertyProxy< bool >	property_cell_background_set ()
	Default value: false
Glib::PropertyProxy_ReadOnly< bool >	property_cell_background_set () const
	Default value: false
Glib::PropertyProxy_ReadOnly< bool >	property_editing () const
	Default value: false
Public Member Functions inherited from Gtk::Object
	Object (Object &&src) noexcept
Object &	operator= (Object &&src) noexcept
	~Object () noexcept override

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.
Static Public Member Functions inherited from Gtk::CellRenderer
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Related Symbols
(Note that these are not member symbols.)
Gtk::CellRendererPixbuf *	wrap (GtkCellRendererPixbuf *object, bool take_copy=false)
	A Glib::wrap() method for this object.
Related Symbols inherited from Gtk::CellRenderer
Gtk::CellRenderer *	wrap (GtkCellRenderer *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Additional Inherited Members
Protected Member Functions inherited from Gtk::CellRenderer
	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	snapshot_vfunc (const Glib::RefPtr< Gtk::Snapshot > &snapshot, Widget &widget, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
virtual bool	activate_vfunc (const Glib::RefPtr< const Gdk::Event > & event, Widget &widget, const Glib::ustring & path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
virtual CellEditable *	start_editing_vfunc (const Glib::RefPtr< const Gdk::Event > & event, Widget &widget, const Glib::ustring & path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
virtual void	on_editing_canceled ()
	This is a default handler for the signal signal_editing_canceled().
virtual void	on_editing_started (CellEditable * editable, const Glib::ustring & path)
	This is a default handler for the signal signal_editing_started().

Detailed Description

Renders a pixbuf in a cell.

A CellRendererPixbuf can be used to render an image in a cell. It allows you to render either a given Pixbuf (set via the pixbuf property) or a named icon (set via the icon_name property).

To support the tree view, CellRendererPixbuf also supports rendering two alternative pixbufs, when the is_expanded property is true. If the is_expanded property is true and the pixbuf_expander_open property is set to a pixbuf, it renders that pixbuf. If the is_expanded property is false and the * pixbuf_expander_closed property is set to a pixbuf, it renders that one.

Deprecated:

4.10: List views use widgets to display their contents. You should use Gtk::Image for icons, and Gtk::Picture for images.

Constructor & Destructor Documentation

CellRendererPixbuf() [1/3]

Gtk::CellRendererPixbuf::CellRendererPixbuf ( CellRendererPixbuf &&  src )

noexcept

CellRendererPixbuf() [2/3]

Gtk::CellRendererPixbuf::CellRendererPixbuf ( const CellRendererPixbuf &  )

delete

~CellRendererPixbuf()

Gtk::CellRendererPixbuf::~CellRendererPixbuf ( )

overridenoexcept

CellRendererPixbuf() [3/3]

Gtk::CellRendererPixbuf::CellRendererPixbuf

(

)

Member Function Documentation

get_type()

static GType Gtk::CellRendererPixbuf::get_type ( )

static

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

gobj() [1/2]

GtkCellRendererPixbuf * Gtk::CellRendererPixbuf::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GtkCellRendererPixbuf * Gtk::CellRendererPixbuf::gobj ( ) const

inline

Provides access to the underlying C GObject.

operator=() [1/2]

CellRendererPixbuf & Gtk::CellRendererPixbuf::operator= ( CellRendererPixbuf &&  src )

noexcept

operator=() [2/2]

CellRendererPixbuf & Gtk::CellRendererPixbuf::operator= ( const CellRendererPixbuf &  )

delete

property_gicon() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > Gtk::CellRendererPixbuf::property_gicon

(

)

The GIcon representing the icon to display.

If the icon theme is changed, the image will be updated automatically.

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_gicon() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > Gtk::CellRendererPixbuf::property_gicon

(

)

const

The GIcon representing the icon to display.

If the icon theme is changed, the image will be updated automatically.

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_icon_name() [1/2]

Glib::PropertyProxy< Glib::ustring > Gtk::CellRendererPixbuf::property_icon_name

(

)

The name of the themed icon to display.

This property only has an effect if not overridden by the "pixbuf" property.

Default value: ""

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_icon_name() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::CellRendererPixbuf::property_icon_name

(

)

const

The name of the themed icon to display.

This property only has an effect if not overridden by the "pixbuf" property.

Default value: ""

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_icon_size() [1/2]

Glib::PropertyProxy< Gtk::IconSize > Gtk::CellRendererPixbuf::property_icon_size

(

)

The Gtk::IconSize value that specifies the size of the rendered icon.

Default value: Gtk::IconSize::INHERIT

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_icon_size() [2/2]

Glib::PropertyProxy_ReadOnly< Gtk::IconSize > Gtk::CellRendererPixbuf::property_icon_size

(

)

const

The Gtk::IconSize value that specifies the size of the rendered icon.

Default value: Gtk::IconSize::INHERIT

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

Glib::PropertyProxy_WriteOnly< Glib::RefPtr< Gdk::Pixbuf > > Gtk::CellRendererPixbuf::property_pixbuf

(

)

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_pixbuf_expander_closed() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > Gtk::CellRendererPixbuf::property_pixbuf_expander_closed

(

)

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_pixbuf_expander_closed() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > Gtk::CellRendererPixbuf::property_pixbuf_expander_closed

(

)

const

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_pixbuf_expander_open() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > Gtk::CellRendererPixbuf::property_pixbuf_expander_open

(

)

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_pixbuf_expander_open() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > Gtk::CellRendererPixbuf::property_pixbuf_expander_open

(

)

const

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_texture() [1/2]

Glib::PropertyProxy< Glib::RefPtr< Gdk::Texture > > Gtk::CellRendererPixbuf::property_texture

(

)

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_texture() [2/2]

Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Texture > > Gtk::CellRendererPixbuf::property_texture

(

)

const

Returns

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

Friends And Related Symbol Documentation

wrap()

Gtk::CellRendererPixbuf * wrap ( GtkCellRendererPixbuf *  object, bool  take_copy = false  )

related

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

Parameters

object	The C instance.
take_copy	False 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.