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

Renders a pixbuf in a cell. More...

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

Public Member Functions

virtual ~CellRendererPixbuf ()
 
GtkCellRendererPixbuf* gobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRendererPixbuf* gobj () const
 Provides access to the underlying C GtkObject. More...
 
 CellRendererPixbuf ()
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf ()
 The pixbuf to render. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf () const
 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< Glib::ustringproperty_stock_id ()
 The stock ID of the stock icon to render. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_stock_id () const
 The stock ID of the stock icon to render. More...
 
Glib::PropertyProxy< guint > property_stock_size ()
 The GtkIconSize value that specifies the size of the rendered icon. More...
 
Glib::PropertyProxy_ReadOnly< guint > property_stock_size () const
 The GtkIconSize value that specifies the size of the rendered icon. More...
 
Glib::PropertyProxy< Glib::ustringproperty_stock_detail ()
 Render detail to pass to the theme engine. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_stock_detail () const
 Render detail to pass to the theme engine. More...
 
Glib::PropertyProxy< Glib::ustringproperty_icon_name ()
 The name of the icon from the icon theme. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_icon_name () const
 The name of the icon from the icon theme. More...
 
Glib::PropertyProxy< bool > property_follow_state ()
 Whether the rendered pixbuf should be colorized according to the state. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_follow_state () const
 Whether the rendered pixbuf should be colorized according to the state. More...
 
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > property_gicon ()
 The GIcon being displayed. More...
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > property_gicon () const
 The GIcon being displayed. More...
 
- Public Member Functions inherited from Gtk::CellRenderer
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
 

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
 
- Protected Member Functions inherited from Gtk::CellRenderer
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)
 

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 stock icon (set via the stock_id 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

virtual Gtk::CellRendererPixbuf::~CellRendererPixbuf ( )
virtual
Gtk::CellRendererPixbuf::CellRendererPixbuf ( )

Member Function Documentation

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

Provides access to the underlying C GtkObject.

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

Provides access to the underlying C GtkObject.

Glib::PropertyProxy< bool > Gtk::CellRendererPixbuf::property_follow_state ( )

Whether the rendered pixbuf should be colorized according to the state.

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::CellRendererPixbuf::property_follow_state ( ) const

Whether the rendered pixbuf should be colorized according to the state.

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<Gio::Icon> > Gtk::CellRendererPixbuf::property_gicon ( )

The GIcon being displayed.

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

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 icon from the icon theme.

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 icon from the icon theme.

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

The pixbuf to render.

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

The pixbuf to render.

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_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::ustring > Gtk::CellRendererPixbuf::property_stock_detail ( )

Render detail to pass to the theme engine.

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_stock_detail ( ) const

Render detail to pass to the theme engine.

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

The stock ID of the stock icon to render.

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_stock_id ( ) const

The stock ID of the stock icon to render.

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< guint > Gtk::CellRendererPixbuf::property_stock_size ( )

The GtkIconSize value that specifies the size of the rendered icon.

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< guint > Gtk::CellRendererPixbuf::property_stock_size ( ) const

The GtkIconSize value that specifies the size of the rendered icon.

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.

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