CellRendererPixbuf

Renders a pixbuf in a cell

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 {

protected

GtkCellRendererPixbuf* gtkCellRendererPixbuf;

GtkCellRendererPixbuf* getCellRendererPixbufStruct(bool transferOwnership);

void* getStruct();

this(GtkCellRendererPixbuf* gtkCellRendererPixbuf, bool ownedRef);

static GType getType();

this();

}

Constructors

this this(GtkCellRendererPixbuf* gtkCellRendererPixbuf, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new #GtkCellRendererPixbuf. Adjust rendering parameters using object properties. Object properties can be set globally (with g_object_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

getCellRendererPixbufStruct GtkCellRendererPixbuf* getCellRendererPixbufStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkCellRendererPixbuf GtkCellRendererPixbuf* gtkCellRendererPixbuf;: the main Gtk struct

Inherited Members

From CellRenderer

gtkCellRenderer GtkCellRenderer* gtkCellRenderer;: the main Gtk struct
getCellRendererStruct GtkCellRenderer* getCellRendererStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
activate bool activate(Event event, Widget widget, string path, GdkRectangle* backgroundArea, GdkRectangle* cellArea, GtkCellRendererState 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(Widget widget, GtkCellRendererState flags, GdkRectangle* cellArea, GdkRectangle 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.
getIsExpanded bool getIsExpanded(): Checks whether the given #GtkCellRenderer is expanded.
getIsExpander bool getIsExpander(): Checks whether the given #GtkCellRenderer is an expander.
getPadding void getPadding(int xpad, int ypad): Fills in @xpad and @ypad with the appropriate values of @cell.
getPreferredHeight void getPreferredHeight(Widget widget, int minimumSize, int naturalSize): Retrieves a renderer’s natural size when rendered to @widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(Widget widget, int width, int minimumHeight, int naturalHeight): Retrieves a cell renderers’s minimum and natural height if it were rendered to @widget with the specified @width.
getPreferredSize void getPreferredSize(Widget widget, Requisition minimumSize, 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(Widget widget, int minimumSize, int naturalSize): Retrieves a renderer’s natural size when rendered to @widget.
getPreferredWidthForHeight void getPreferredWidthForHeight(Widget widget, int height, int minimumWidth, int naturalWidth): Retrieves a cell renderers’s minimum and natural width if it were rendered to @widget with the specified @height.
getRequestMode GtkSizeRequestMode 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.
getState GtkStateFlags getState(Widget widget, GtkCellRendererState 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.
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.
setIsExpanded void setIsExpanded(bool isExpanded): Sets whether the given #GtkCellRenderer is expanded.
setIsExpander void setIsExpander(bool isExpander): Sets whether the given #GtkCellRenderer is an expander.
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.
snapshot void snapshot(Snapshot snapshot, Widget widget, GdkRectangle* backgroundArea, GdkRectangle* cellArea, GtkCellRendererState 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.
startEditing CellEditableIF startEditing(Event event, Widget widget, string path, GdkRectangle* backgroundArea, GdkRectangle* cellArea, GtkCellRendererState 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.
addOnEditingCanceled gulong addOnEditingCanceled(void delegate(CellRenderer) dlg, ConnectFlags connectFlags): This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.
addOnEditingStarted gulong addOnEditingStarted(void delegate(CellEditableIF, string, CellRenderer) dlg, ConnectFlags connectFlags): This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on @editable, e.g. adding a #GtkEntryCompletion or setting up additional columns in a #GtkComboBox.