CellRendererPixbuf

A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render either a given #GdkPixbuf (set via the #GtkCellRendererPixbuf:pixbuf property) or a named icon (set via the #GtkCellRendererPixbuf:icon-name property).

To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative pixbufs, when the #GtkCellRenderer:is-expander property is true. If the #GtkCellRenderer:is-expanded property is true and the #GtkCellRendererPixbuf:pixbuf-expander-open property is set to a pixbuf, it renders that pixbuf, if the #GtkCellRenderer:is-expanded property is false and the #GtkCellRendererPixbuf:pixbuf-expander-closed property is set to a pixbuf, it renders that one.

class CellRendererPixbuf : CellRenderer {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

CellRendererPixbuf self();

static CellRendererPixbufGidBuilder builder();

bool followState [@property getter];

bool followState [@property setter];

gio.icon.Icon gicon [@property getter];

gio.icon.Icon gicon [@property setter];

string iconName [@property getter];

string iconName [@property setter];

gdkpixbuf.pixbuf.Pixbuf pixbuf [@property getter];

gdkpixbuf.pixbuf.Pixbuf pixbuf [@property setter];

gdkpixbuf.pixbuf.Pixbuf pixbufExpanderClosed [@property getter];

gdkpixbuf.pixbuf.Pixbuf pixbufExpanderClosed [@property setter];

gdkpixbuf.pixbuf.Pixbuf pixbufExpanderOpen [@property getter];

gdkpixbuf.pixbuf.Pixbuf pixbufExpanderOpen [@property setter];

string stockDetail [@property getter];

string stockDetail [@property setter];

string stockId [@property getter];

string stockId [@property setter];

uint stockSize [@property getter];

uint stockSize [@property setter];

cairo.surface.Surface surface [@property getter];

cairo.surface.Surface surface [@property setter];

this();

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkCellRendererPixbuf. Adjust rendering parameters using object properties. Object properties can be set globally (with gobject.object.ObjectWrap.set). Also, with #GtkTreeViewColumn, you can bind a property to a value in a #GtkTreeModel. For example, you can bind the “pixbuf” property on the cell renderer to a pixbuf value in the model, thus rendering a different image in each row of the #GtkTreeView.

Members

Functions

self CellRendererPixbuf self(): Returns this, for use in with statements.

Properties

_gType GType _gType [@property getter]
followState bool followState [@property getter]: Get followState property.
followState bool followState [@property setter]: Set followState property.
gicon gio.icon.Icon gicon [@property getter]: Get gicon property.
gicon gio.icon.Icon gicon [@property setter]: Set gicon property.
iconName string iconName [@property getter]: Get iconName property.
iconName string iconName [@property setter]: Set iconName property.
pixbuf gdkpixbuf.pixbuf.Pixbuf pixbuf [@property getter]
pixbuf gdkpixbuf.pixbuf.Pixbuf pixbuf [@property setter]
pixbufExpanderClosed gdkpixbuf.pixbuf.Pixbuf pixbufExpanderClosed [@property getter]
pixbufExpanderClosed gdkpixbuf.pixbuf.Pixbuf pixbufExpanderClosed [@property setter]
pixbufExpanderOpen gdkpixbuf.pixbuf.Pixbuf pixbufExpanderOpen [@property getter]
pixbufExpanderOpen gdkpixbuf.pixbuf.Pixbuf pixbufExpanderOpen [@property setter]
stockDetail string stockDetail [@property getter]
stockDetail string stockDetail [@property setter]
stockId string stockId [@property getter]
stockId string stockId [@property setter]
stockSize uint stockSize [@property getter]: Get stockSize property.
stockSize uint stockSize [@property setter]: Set stockSize property.
surface cairo.surface.Surface surface [@property getter]
surface cairo.surface.Surface surface [@property setter]

Static functions

_getGType GType _getGType()
builder CellRendererPixbufGidBuilder builder(): Get builder for gtk.cell_renderer_pixbuf.CellRendererPixbuf

Inherited Members

From CellRenderer

_getGType GType _getGType()
_gType GType _gType [@property getter]
self CellRenderer self(): Returns this, for use in with statements.
builder CellRendererGidBuilder builder(): Get builder for gtk.cell_renderer.CellRenderer
cellBackground string cellBackground [@property setter]
cellBackgroundGdk gdk.color.Color cellBackgroundGdk [@property getter]: Get cellBackgroundGdk property.
cellBackgroundGdk gdk.color.Color cellBackgroundGdk [@property setter]: Set cellBackgroundGdk property.
cellBackgroundRgba gdk.rgba.RGBA cellBackgroundRgba [@property getter]: Get cellBackgroundRgba property.
cellBackgroundRgba gdk.rgba.RGBA cellBackgroundRgba [@property setter]: Set cellBackgroundRgba property.
cellBackgroundSet bool cellBackgroundSet [@property getter]
cellBackgroundSet bool cellBackgroundSet [@property setter]
editing bool editing [@property getter]
height int height [@property getter]
height int height [@property setter]
isExpanded bool isExpanded [@property getter]
isExpanded bool isExpanded [@property setter]
isExpander bool isExpander [@property getter]
isExpander bool isExpander [@property setter]
mode gtk.types.CellRendererMode mode [@property getter]
mode gtk.types.CellRendererMode mode [@property setter]
sensitive bool sensitive [@property getter]
sensitive bool sensitive [@property setter]
visible bool visible [@property getter]
visible bool visible [@property setter]
width int width [@property getter]
width int width [@property setter]
xalign float xalign [@property getter]
xalign float xalign [@property setter]
xpad uint xpad [@property getter]
xpad uint xpad [@property setter]
yalign float yalign [@property getter]
yalign float yalign [@property setter]
ypad uint ypad [@property getter]
ypad uint ypad [@property setter]
activate bool activate(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Passes an activate event to the cell renderer for possible processing. Some cell renderers may use events; for example, #GtkCellRendererToggle toggles when it gets a mouse click.
getAlignedArea void getAlignedArea(gtk.widget.Widget widget, gtk.types.CellRendererState flags, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle alignedArea): Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle.
getAlignment void getAlignment(float xalign, float yalign): Fills in xalign and yalign with the appropriate values of cell.
getFixedSize void getFixedSize(int width, int height): Fills in width and height with the appropriate size of cell.
getPadding void getPadding(int xpad, int ypad): Fills in xpad and ypad with the appropriate values of cell.
getPreferredHeight void getPreferredHeight(gtk.widget.Widget widget, int minimumSize, int naturalSize): Retreives a renderer’s natural size when rendered to widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(gtk.widget.Widget widget, int width, int minimumHeight, int naturalHeight): Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.
getPreferredSize void getPreferredSize(gtk.widget.Widget widget, gtk.requisition.Requisition minimumSize, gtk.requisition.Requisition naturalSize): Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.
getPreferredWidth void getPreferredWidth(gtk.widget.Widget widget, int minimumSize, int naturalSize): Retreives a renderer’s natural size when rendered to widget.
getPreferredWidthForHeight void getPreferredWidthForHeight(gtk.widget.Widget widget, int height, int minimumWidth, int naturalWidth): Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.
getRequestMode gtk.types.SizeRequestMode getRequestMode(): Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
getSensitive bool getSensitive(): Returns the cell renderer’s sensitivity.
getSize void getSize(gtk.widget.Widget widget, gdk.rectangle.Rectangle cellArea, int xOffset, int yOffset, int width, int height): Obtains the width and height needed to render the cell. Used by view widgets to determine the appropriate size for the cell_area passed to gtk.cell_renderer.CellRenderer.render. If cell_area is not null, fills in the x and y offsets (if set) of the cell relative to this location.
getState gtk.types.StateFlags getState(gtk.widget.Widget widget, gtk.types.CellRendererState cellState): Translates the cell renderer state to #GtkStateFlags, based on the cell renderer and widget sensitivity, and the given #GtkCellRendererState.
getVisible bool getVisible(): Returns the cell renderer’s visibility.
isActivatable bool isActivatable(): Checks whether the cell renderer can do something when activated.
render void render(cairo.context.Context cr, gtk.widget.Widget widget, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Invokes the virtual render function of the #GtkCellRenderer. 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 #GtkCellRenderer 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.
setAlignment void setAlignment(float xalign, float yalign): Sets the renderer’s alignment within its available space.
setFixedSize void setFixedSize(int width, int height): Sets the renderer size to be explicit, independent of the properties set.
setPadding void setPadding(int xpad, int ypad): Sets the renderer’s padding.
setSensitive void setSensitive(bool sensitive): Sets the cell renderer’s sensitivity.
setVisible void setVisible(bool visible): Sets the cell renderer’s visibility.
startEditing gtk.cell_editable.CellEditable startEditing(gdk.event.Event event, gtk.widget.Widget widget, string path, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags): Starts editing the contents of this cell, through a new #GtkCellEditable widget created by the #GtkCellRendererClass.start_editing virtual function.
stopEditing void stopEditing(bool canceled): Informs the cell renderer that the editing is stopped. If canceled is true, the cell renderer will emit the #GtkCellRenderer::editing-canceled signal.
connectEditingCanceled gulong connectEditingCanceled(T callback, Flag!"After" after): Connect to EditingCanceled signal.
connectEditingStarted gulong connectEditingStarted(T callback, Flag!"After" after): Connect to EditingStarted signal.

gtk cell_renderer_pixbuf classes