Class

GtkCellRendererSpinner

Description [src]

class Gtk.CellRendererSpinner : Gtk.CellRenderer {
  parent: GtkCellRenderer
}

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

Hierarchy

hierarchy this GtkCellRendererSpinner ancestor_0 GtkCellRenderer ancestor_0--this ancestor_1 GInitiallyUnowned ancestor_1--ancestor_0 ancestor_2 GObject ancestor_2--ancestor_1

Constructors

gtk_cell_renderer_spinner_new

Returns a new cell renderer which will show a spinner to indicate activity.

Available since: 2.20

Instance methods

Methods inherited from GtkCellRenderer (24)
gtk_cell_renderer_activate

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.

gtk_cell_renderer_get_aligned_area

Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle.

Available since: 3.0

gtk_cell_renderer_get_alignment

Fills in xalign and yalign with the appropriate values of cell.

Available since: 2.18

gtk_cell_renderer_get_fixed_size

Fills in width and height with the appropriate size of cell.

gtk_cell_renderer_get_padding

Fills in xpad and ypad with the appropriate values of cell.

Available since: 2.18

gtk_cell_renderer_get_preferred_height

Retreives a renderer’s natural size when rendered to widget.

Available since: 3.0

gtk_cell_renderer_get_preferred_height_for_width

Retreives a cell renderers’s minimum and natural height if it were rendered to widget with the specified width.

Available since: 3.0

gtk_cell_renderer_get_preferred_size

Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.

Available since: 3.0

gtk_cell_renderer_get_preferred_width

Retreives a renderer’s natural size when rendered to widget.

Available since: 3.0

gtk_cell_renderer_get_preferred_width_for_height

Retreives a cell renderers’s minimum and natural width if it were rendered to widget with the specified height.

Available since: 3.0

gtk_cell_renderer_get_request_mode

Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.

Available since: 3.0

gtk_cell_renderer_get_sensitive

Returns the cell renderer’s sensitivity.

Available since: 2.18

gtk_cell_renderer_get_size

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.

Deprecated since: 3.0

gtk_cell_renderer_get_state

Translates the cell renderer state to GtkStateFlags, based on the cell renderer and widget sensitivity, and the given GtkCellRendererState.

Available since: 3.0

gtk_cell_renderer_get_visible

Returns the cell renderer’s visibility.

Available since: 2.18

gtk_cell_renderer_is_activatable

Checks whether the cell renderer can do something when activated.

Available since: 3.0

gtk_cell_renderer_render

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.

gtk_cell_renderer_set_alignment

Sets the renderer’s alignment within its available space.

Available since: 2.18

gtk_cell_renderer_set_fixed_size

Sets the renderer size to be explicit, independent of the properties set.

gtk_cell_renderer_set_padding

Sets the renderer’s padding.

Available since: 2.18

gtk_cell_renderer_set_sensitive

Sets the cell renderer’s sensitivity.

Available since: 2.18

gtk_cell_renderer_set_visible

Sets the cell renderer’s visibility.

Available since: 2.18

gtk_cell_renderer_start_editing

Starts editing the contents of this cell, through a new GtkCellEditable widget created by the GtkCellRendererClass.start_editing virtual function.

Methods inherited from GObject (42)

Properties

Gtk.CellRendererSpinner:active
No description available.
Gtk.CellRendererSpinner:pulse

Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout.

Available since: 2.20

Gtk.CellRendererSpinner:size

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

Available since: 2.20

Properties inherited from GtkCellRenderer (16)
Gtk.CellRenderer:cell-background
No description available.
Gtk.CellRenderer:cell-background-gdk

Cell background as a GdkColor.

Deprecated since: 3.4

Gtk.CellRenderer:cell-background-rgba

Cell background as a GdkRGBA.

Available since: 3.0

Gtk.CellRenderer:cell-background-set
No description available.
Gtk.CellRenderer:editing
No description available.
Gtk.CellRenderer:height
No description available.
Gtk.CellRenderer:is-expanded
No description available.
Gtk.CellRenderer:is-expander
No description available.
Gtk.CellRenderer:mode
No description available.
Gtk.CellRenderer:sensitive
No description available.
Gtk.CellRenderer:visible
No description available.
Gtk.CellRenderer:width
No description available.
Gtk.CellRenderer:xalign
No description available.
Gtk.CellRenderer:xpad
No description available.
Gtk.CellRenderer:yalign
No description available.
Gtk.CellRenderer:ypad
No description available.

Signals

Signals inherited from GtkCellRenderer (2)
Gtk.CellRenderer::editing-canceled

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.

Available since: 2.4

Gtk.CellRenderer::editing-started

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.

Available since: 2.6

Signals inherited from GObject (1)

Class structure

struct GtkCellRendererSpinnerClass {
  GtkCellRendererClass parent_class;
  void (* _gtk_reserved1) (
void
  );
  void (* _gtk_reserved2) (
void
  );
  void (* _gtk_reserved3) (
void
  );
  void (* _gtk_reserved4) (
void
  );
  
}
Class members
parent_class
GtkCellRendererClass
  No description available.
_gtk_reserved1
void (* _gtk_reserved1) (
void
  )
  No description available.
_gtk_reserved2
void (* _gtk_reserved2) (
void
  )
  No description available.
_gtk_reserved3
void (* _gtk_reserved3) (
void
  )
  No description available.
_gtk_reserved4
void (* _gtk_reserved4) (
void
  )
  No description available.