Ardour  9.0-pre0-582-g084a23a80d
Gtk::CellRendererPixbuf Class Reference

#include <cellrendererpixbuf.h>

Inheritance diagram for Gtk::CellRendererPixbuf:
[legend]

Public Member Functions

virtual ~CellRendererPixbuf ()
 
GtkCellRendererPixbufgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRendererPixbufgobj () const
 Provides access to the underlying C GtkObject. More...
 
 CellRendererPixbuf ()
 
Glib::PropertyProxy< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gdk::Pixbuf > > property_pixbuf () const
 
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< Glib::ustring > property_stock_id ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_stock_id () const
 
Glib::PropertyProxy< guint > property_stock_size ()
 
Glib::PropertyProxy_ReadOnly< guint > property_stock_size () const
 
Glib::PropertyProxy< Glib::ustring > property_stock_detail ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_stock_detail () const
 
Glib::PropertyProxy< Glib::ustring > property_icon_name ()
 
Glib::PropertyProxy_ReadOnly< Glib::ustring > property_icon_name () const
 
Glib::PropertyProxy< bool > property_follow_state ()
 
Glib::PropertyProxy_ReadOnly< bool > property_follow_state () const
 
Glib::PropertyProxy< Glib::RefPtr< Gio::Icon > > property_gicon ()
 
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Gio::Icon > > property_gicon () const
 
virtual Glib::PropertyProxy_Base _property_renderable ()
 
- Public Member Functions inherited from Gtk::CellRenderer
virtual ~CellRenderer ()
 
GtkCellRenderergobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkCellRenderergobj () 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
 
void get_size (Widget &widget, int &x_offset, int &y_offset, int &width, int &height) const
 
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)
 
bool activate (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags)
 
CellEditablestart_editing (GdkEvent *event, Widget &widget, const Glib::ustring &path, const Gdk::Rectangle &background_area, const Gdk::Rectangle &cell_area, CellRendererState flags=CellRendererState(0))
 
void set_fixed_size (int width, int height)
 
void get_fixed_size (int &width, int &height) const
 
void set_alignment (float xalign, float yalign)
 
void get_alignment (float &xalign, float &yalign) const
 
void set_padding (int xpad, int ypad)
 
void get_padding (int &xpad, int &ypad) const
 
void set_visible (bool visible=true)
 
bool get_visible () const
 
void set_sensitive (bool sensitive=true)
 
bool get_sensitive () const
 
void editing_canceled ()
 
void stop_editing (bool canceled=false)
 
Glib::SignalProxy0< void > signal_editing_canceled ()
 
Glib::SignalProxy2< void, CellEditable *, const Glib::ustring & > signal_editing_started ()
 
Glib::PropertyProxy< CellRendererModeproperty_mode ()
 
Glib::PropertyProxy_ReadOnly< CellRendererModeproperty_mode () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< float > property_xalign ()
 
Glib::PropertyProxy_ReadOnly< float > property_xalign () const
 
Glib::PropertyProxy< float > property_yalign ()
 
Glib::PropertyProxy_ReadOnly< float > property_yalign () const
 
Glib::PropertyProxy< unsigned int > property_xpad ()
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_xpad () const
 
Glib::PropertyProxy< unsigned int > property_ypad ()
 
Glib::PropertyProxy_ReadOnly< unsigned int > property_ypad () const
 
Glib::PropertyProxy< int > property_width ()
 
Glib::PropertyProxy_ReadOnly< int > property_width () const
 
Glib::PropertyProxy< int > property_height ()
 
Glib::PropertyProxy_ReadOnly< int > property_height () const
 
Glib::PropertyProxy< bool > property_is_expander ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expander () const
 
Glib::PropertyProxy< bool > property_is_expanded ()
 
Glib::PropertyProxy_ReadOnly< bool > property_is_expanded () const
 
Glib::PropertyProxy_WriteOnly< Glib::ustring > property_cell_background ()
 
Glib::PropertyProxy< Gdk::Colorproperty_cell_background_gdk ()
 
Glib::PropertyProxy_ReadOnly< Gdk::Colorproperty_cell_background_gdk () const
 
Glib::PropertyProxy< bool > property_cell_background_set ()
 
Glib::PropertyProxy_ReadOnly< bool > property_cell_background_set () const
 
Glib::PropertyProxy_ReadOnly< bool > property_editing () const
 
- Public Member Functions inherited from Gtk::Object
virtual ~Object ()
 
GtkObjectgobj ()
 Provides access to the underlying C GtkObject. More...
 
const GtkObjectgobj () const
 Provides access to the underlying C GtkObject. More...
 
Glib::PropertyProxy< void * > property_user_data ()
 
Glib::PropertyProxy_ReadOnly< void * > property_user_data () const
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

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

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.

Definition at line 58 of file cellrendererpixbuf.h.

Constructor & Destructor Documentation

◆ ~CellRendererPixbuf()

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

◆ CellRendererPixbuf()

Gtk::CellRendererPixbuf::CellRendererPixbuf ( )

Member Function Documentation

◆ _property_renderable()

virtual Glib::PropertyProxy_Base Gtk::CellRendererPixbuf::_property_renderable ( )
virtual

Returns the property that this CellRenderer renders. For instance, property_text for CellRendererText, and property_active for CellRendererToggle Needs to be overridden in derived classes.

Reimplemented from Gtk::CellRenderer.

◆ gobj() [1/2]

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

Provides access to the underlying C GtkObject.

Definition at line 95 of file cellrendererpixbuf.h.

◆ gobj() [2/2]

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

Provides access to the underlying C GtkObject.

Definition at line 98 of file cellrendererpixbuf.h.

◆ property_follow_state() [1/2]

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.

◆ property_follow_state() [2/2]

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.

◆ property_gicon() [1/2]

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.

◆ property_gicon() [2/2]

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.

◆ property_icon_name() [1/2]

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.

◆ property_icon_name() [2/2]

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.

◆ property_pixbuf() [1/2]

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.

◆ property_pixbuf() [2/2]

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.

◆ property_pixbuf_expander_closed() [1/2]

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.

◆ property_pixbuf_expander_closed() [2/2]

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.

◆ property_pixbuf_expander_open() [1/2]

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.

◆ property_pixbuf_expander_open() [2/2]

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.

◆ property_stock_detail() [1/2]

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.

◆ property_stock_detail() [2/2]

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.

◆ property_stock_id() [1/2]

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.

◆ property_stock_id() [2/2]

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.

◆ property_stock_size() [1/2]

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.

◆ property_stock_size() [2/2]

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

◆ wrap()

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: