gtkmm: 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
 
CellRendererPixbufoperator= (CellRendererPixbuf&& src) noexcept
 
 CellRendererPixbuf (const CellRendererPixbuf&)=delete
 
CellRendererPixbufoperator= (const CellRendererPixbuf&)=delete
 
 ~CellRendererPixbuf () noexcept override
 
GtkCellRendererPixbuf* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkCellRendererPixbuf* gobj () const
 Provides access to the underlying C GObject. More...

 
 CellRendererPixbuf ()
 
Glib::PropertyProxy_WriteOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf ()
 The pixbuf to render. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf_expander_open ()
 Pixbuf for open expander. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf_expander_open () const
 Pixbuf for open expander. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf_expander_closed ()
 Pixbuf for closed expander. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf_expander_closed () const
 Pixbuf for closed expander. More...

 
Glib::PropertyProxy< Gtk::IconSizeproperty_icon_size ()
 The Gtk::IconSize value that specifies the size of the rendered icon. More...

 
Glib::PropertyProxy_ReadOnly< Gtk::IconSizeproperty_icon_size () const
 The Gtk::IconSize value that specifies the size of the rendered icon. More...

 
Glib::PropertyProxy< Glib::ustringproperty_icon_name ()
 The name of the themed icon to display. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_icon_name () const
 The name of the themed icon to display. More...

 
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > property_gicon ()
 The GIcon representing the icon to display. More...

 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > property_gicon () const
 The GIcon representing the icon to display. More...

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

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

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

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

 
CellEditablestart_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. 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 set_is_expander (bool is_expander=true)
 Sets whether the given Gtk::CellRenderer is an expander. More...

 
bool get_is_expander () const
 Checks whether the given Gtk::CellRenderer is an expander. More...

 
void set_is_expanded (bool is_expanded=true)
 Sets whether the given Gtk::CellRenderer is expanded. More...

 
bool get_is_expanded () const
 Checks whether the given Gtk::CellRenderer is expanded. 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
 A get_state() convenience overload. 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::ustringproperty_cell_background ()
 Cell background color as a string. 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
 
- 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
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (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) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *data) const
 

Static Public Member Functions

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

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

 

Related Functions

(Note that these are not member functions.)

Gtk::CellRendererPixbufwrap (GtkCellRendererPixbuf* 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
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 
- 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 CellEditablestart_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(). More...

 
virtual void on_editing_started (CellEditable* editable, const Glib::ustring& path)
 This is a default handler for the signal signal_editing_started(). More...

 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- 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)
 

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.

Constructor & Destructor Documentation

Gtk::CellRendererPixbuf::CellRendererPixbuf ( CellRendererPixbuf&&  src)
noexcept
Gtk::CellRendererPixbuf::CellRendererPixbuf ( const CellRendererPixbuf )
delete
Gtk::CellRendererPixbuf::~CellRendererPixbuf ( )
overridenoexcept
Gtk::CellRendererPixbuf::CellRendererPixbuf ( )

Member Function Documentation

static GType Gtk::CellRendererPixbuf::get_type ( )
static

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

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

Provides access to the underlying C GObject.

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

Provides access to the underlying C GObject.

CellRendererPixbuf& Gtk::CellRendererPixbuf::operator= ( CellRendererPixbuf&&  src)
noexcept
CellRendererPixbuf& Gtk::CellRendererPixbuf::operator= ( const CellRendererPixbuf )
delete
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.
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.
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.
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.
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.
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.
Glib::PropertyProxy_WriteOnly< Glib::RefPtr<Gdk::Pixbuf> > Gtk::CellRendererPixbuf::property_pixbuf ( )

The pixbuf to render.

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< Glib::RefPtr<Gdk::Pixbuf> > Gtk::CellRendererPixbuf::property_pixbuf_expander_closed ( )

Pixbuf for closed expander.

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< Glib::RefPtr<Gdk::Pixbuf> > Gtk::CellRendererPixbuf::property_pixbuf_expander_closed ( ) const

Pixbuf for closed expander.

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< Glib::RefPtr<Gdk::Pixbuf> > Gtk::CellRendererPixbuf::property_pixbuf_expander_open ( )

Pixbuf for open expander.

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< Glib::RefPtr<Gdk::Pixbuf> > Gtk::CellRendererPixbuf::property_pixbuf_expander_open ( ) const

Pixbuf for open expander.

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

Gtk::CellRendererPixbuf* wrap ( GtkCellRendererPixbuf *  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.