CellRendererSpinner

GtkCellRendererSpinner renders a spinning animation in a cell, very similar to #GtkSpinner. It can often be used as an alternative to a #GtkCellRendererProgress for displaying indefinite activity, instead of actual progress.

To start the animation in a cell, set the #GtkCellRendererSpinner:active property to %TRUE and increment the #GtkCellRendererSpinner:pulse property at regular intervals. The usual way to set the cell renderer properties for each cell is to bind them to columns in your tree model using e.g. gtk_tree_view_column_add_attribute().

class CellRendererSpinner : CellRenderer {

protected

GtkCellRendererSpinner* gtkCellRendererSpinner;

GtkCellRendererSpinner* getCellRendererSpinnerStruct(bool transferOwnership);

void* getStruct();

this(GtkCellRendererSpinner* gtkCellRendererSpinner, bool ownedRef);

static GType getType();

this();

}

Constructors

this this(GtkCellRendererSpinner* gtkCellRendererSpinner, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Returns a new cell renderer which will show a spinner to indicate activity.

Members

Functions

getCellRendererSpinnerStruct GtkCellRendererSpinner* getCellRendererSpinnerStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkCellRendererSpinner GtkCellRendererSpinner* gtkCellRendererSpinner;: 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.
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): Retreives a renderer’s natural size when rendered to @widget.
getPreferredHeightForWidth void getPreferredHeightForWidth(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(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): Retreives a renderer’s natural size when rendered to @widget.
getPreferredWidthForHeight void getPreferredWidthForHeight(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 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.
getSize void getSize(Widget widget, GdkRectangle* 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_render(). If @cell_area is not %NULL, fills in the x and y offsets (if set) of the cell relative to this location.
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.
render void render(Context cr, 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.
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 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.