Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker GObject.InitiallyUnowned
Gtk.CellRenderer
Gtk.CellRendererSpinner

Class Gtk.CellRendererSpinner

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkCellRendererSpinner
Class :	CellRendererSpinner
Extends:	Gtk.CellRenderer

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

Properties
Properties		Defined By
	active : gboolean	Gtk.CellRendererSpinner
	cell_background : String	Gtk.CellRenderer
	cell_background_gdk : Gdk.Color	Gtk.CellRenderer
	cell_background_rgba : Gdk.RGBA Cell background as a GdkRGBA Cell background as a GdkRGBA	Gtk.CellRenderer
	cell_background_set : gboolean	Gtk.CellRenderer
	editing : gboolean read only	Gtk.CellRenderer
	g_type_instance : GObject.TypeInstance	GObject.InitiallyUnowned
	height : gint32	Gtk.CellRenderer
	is_expanded : gboolean	Gtk.CellRenderer
	is_expander : gboolean	Gtk.CellRenderer
	mode : Gtk.CellRendererMode	Gtk.CellRenderer
	parent : Gtk.CellRenderer read only	Gtk.CellRendererSpinner
	parent_instance : GObject.InitiallyUnowned read only	Gtk.CellRenderer
	priv : Gtk.CellRendererSpinnerPrivate read only	Gtk.CellRendererSpinner
	pulse : guint32 Pulse of the spinner. 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. By default, the GtkSpinner widget draws one full cycle of the animation, consisting of 12 frames, in 750 milliseconds.	Gtk.CellRendererSpinner
	qdata : GLib.Data read only	GObject.InitiallyUnowned
	ref_count : guint32 read only	GObject.InitiallyUnowned
	sensitive : gboolean	Gtk.CellRenderer
	size : Gtk.IconSize The GtkIconSize value that specifies the size of the rendered spinner. The GtkIconSize value that specifies the size of the rendered spinner.	Gtk.CellRendererSpinner
	visible : gboolean	Gtk.CellRenderer
	width : gint32	Gtk.CellRenderer
	xalign : gfloat	Gtk.CellRenderer
	xpad : guint32	Gtk.CellRenderer
	yalign : gfloat	Gtk.CellRenderer
	ypad : guint32	Gtk.CellRenderer

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.CellRendererSpinner (Object *properties) Create a new Gtk.CellRendererSpinner Create a new Gtk.CellRendererSpinner Parameters: Object properties*
	activate (Event *event, Widget widget, String path, RectangleInt background_area, RectangleInt cell_area, CellRendererState flags) : gboolean Passes an activate event to the cell renderer for possible processing. 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. Parameters: Gdk.Event event Required (not null) a GdkEvent Gtk.Widget widget Required (not null) widget that received the event String path Required (not null) widget-dependent string representation of the event location; e.g. for GtkTreeView, a string representation of GtkTreePath cairo.RectangleInt background_area Required (not null) background area as passed to gtk_cell_renderer_render() cairo.RectangleInt cell_area Required (not null) cell area as passed to gtk_cell_renderer_render() Gtk.CellRendererState flags Required (not null) render flags Returns: gboolean TRUE if the event was consumed/handled	Gtk.CellRenderer
	get_aligned_area (Widget *widget, CellRendererState flags, RectangleInt cell_area) : cairo.RectangleInt Gets the aligned area used by cell* inside cell_area. Gets the aligned area used by cell inside cell_area. Used for finding the appropriate edit and focus rectangle. Parameters: Gtk.Widget widget Required (not null) the GtkWidget this cell will be rendering to Gtk.CellRendererState flags Required (not null) render flags cairo.RectangleInt cell_area Required (not null) cell area which would be passed to gtk_cell_renderer_render() Returns: cairo.RectangleInt	Gtk.CellRenderer
	get_alignment () : Object Fills in xalign and yalign with the appropriate values of cell. Fills in xalign and yalign with the appropriate values of cell. Returns: xalign: gfloat yalign: gfloat	Gtk.CellRenderer
	get_fixed_size () : Object Fills in width and height with the appropriate size of cell. Fills in width and height with the appropriate size of cell. Returns: width: gint32 height: gint32	Gtk.CellRenderer
	get_padding () : Object Fills in xpad and ypad with the appropriate values of cell. Fills in xpad and ypad with the appropriate values of cell. Returns: xpad: gint32 ypad: gint32	Gtk.CellRenderer
	get_preferred_height (Widget *widget) : Object Retreives a renderer's natural size when rendered to widget. Retreives a renderer's natural size when rendered to widget. Parameters: Gtk.Widget widget* Required (not null) the GtkWidget this cell will be rendering to Returns: minimum_size: gint32 natural_size: gint32	Gtk.CellRenderer
	get_preferred_height_for_width (Widget *widget, gint32 width) : Object Retreives a cell renderers's minimum and natural height if it were rendered to Retreives a cell renderers's minimum and natural height if it were rendered to Parameters: Gtk.Widget widget* Required (not null) the GtkWidget this cell will be rendering to gint32 width Required (not null) the size which is available for allocation Returns: minimum_height: gint32 natural_height: gint32	Gtk.CellRenderer
	get_preferred_size (Widget *widget) : Object Retrieves the minimum and natural size of a cell taking into account the widget's preference for height-for-width management. Retrieves the minimum and natural size of a cell taking into account the widget's preference for height-for-width management. Parameters: Gtk.Widget widget* Required (not null) the GtkWidget this cell will be rendering to Returns: minimum_size: Gtk.Requisition natural_size: Gtk.Requisition	Gtk.CellRenderer
	get_preferred_width (Widget *widget) : Object Retreives a renderer's natural size when rendered to widget. Retreives a renderer's natural size when rendered to widget. Parameters: Gtk.Widget widget* Required (not null) the GtkWidget this cell will be rendering to Returns: minimum_size: gint32 natural_size: gint32	Gtk.CellRenderer
	get_preferred_width_for_height (Widget *widget, gint32 height) : Object Retreives a cell renderers's minimum and natural width if it were rendered to Retreives a cell renderers's minimum and natural width if it were rendered to Parameters: Gtk.Widget widget* Required (not null) the GtkWidget this cell will be rendering to gint32 height Required (not null) the size which is available for allocation Returns: minimum_width: gint32 natural_width: gint32	Gtk.CellRenderer
	get_request_mode () : Gtk.SizeRequestMode Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout. Returns: Gtk.SizeRequestMode The GtkSizeRequestMode preferred by this renderer.	Gtk.CellRenderer
	get_sensitive () : gboolean Returns the cell renderer's sensitivity. Returns the cell renderer's sensitivity. Returns: gboolean TRUE if the cell renderer is sensitive	Gtk.CellRenderer
	get_size (Widget *widget, RectangleInt cell_area) : Object Obtains the width and height needed to render the cell. 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. Please note that the values set in width and height, as well as those in x_offset and y_offset are inclusive of the xpad and ypad properties. Parameters: Gtk.Widget widget Required (not null) the widget the renderer is rendering to cairo.RectangleInt cell_area The area a cell will be allocated, or NULL Returns: x_offset: gint32 y_offset: gint32 width: gint32 height: gint32	Gtk.CellRenderer
	get_state (Widget *widget, CellRendererState cell_state) : Gtk.StateFlags Translates the cell renderer state to GtkStateFlags, based on the cell renderer and widget sensitivity, and the given GtkCellRendererState. Translates the cell renderer state to GtkStateFlags, based on the cell renderer and widget sensitivity, and the given GtkCellRendererState. Parameters: Gtk.Widget widget* Required (not null) a GtkWidget, or NULL Gtk.CellRendererState cell_state Required (not null) cell renderer state Returns: Gtk.StateFlags the widget state flags applying to cell	Gtk.CellRenderer
	get_visible () : gboolean Returns the cell renderer's visibility. Returns the cell renderer's visibility. Returns: gboolean TRUE if the cell renderer is visible	Gtk.CellRenderer
	is_activatable () : gboolean Checks whether the cell renderer can do something when activated. Checks whether the cell renderer can do something when activated. Returns: gboolean TRUE if the cell renderer can do anything when activated	Gtk.CellRenderer
	render (Context cr, Widget *widget, RectangleInt background_area, RectangleInt cell_area, CellRendererState flags) : none Invokes the virtual render function of the GtkCellRenderer. Invokes the virtual render function of the GtkCellRenderer. The three passed-in rectangles are areas in cr. Most renderers will draw within 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 Parameters: cairo.Context cr Required (not null) a cairo context to draw to Gtk.Widget widget Required (not null) the widget owning window cairo.RectangleInt background_area Required (not null) entire cell area (including tree expanders and maybe padding on the sides) cairo.RectangleInt cell_area Required (not null) area normally rendered by a cell renderer Gtk.CellRendererState flags Required (not null) flags that affect rendering Returns: none	Gtk.CellRenderer
	set_alignment (gfloat *xalign, gfloat yalign) : none Sets the renderer's alignment within its available space. Sets the renderer's alignment within its available space. Parameters: gfloat xalign* Required (not null) the x alignment of the cell renderer gfloat yalign Required (not null) the y alignment of the cell renderer Returns: none	Gtk.CellRenderer
	set_fixed_size (gint32 *width, gint32 height) : none Sets the renderer size to be explicit, independent of the properties set. Sets the renderer size to be explicit, independent of the properties set. Parameters: gint32 width* Required (not null) the width of the cell renderer, or -1 gint32 height Required (not null) the height of the cell renderer, or -1 Returns: none	Gtk.CellRenderer
	set_padding (gint32 *xpad, gint32 ypad) : none Sets the renderer's padding. Sets the renderer's padding. Parameters: gint32 xpad* Required (not null) the x padding of the cell renderer gint32 ypad Required (not null) the y padding of the cell renderer Returns: none	Gtk.CellRenderer
	set_sensitive (gboolean *sensitive) : none Sets the cell renderer's sensitivity. Sets the cell renderer's sensitivity. Parameters: gboolean sensitive* Required (not null) the sensitivity of the cell Returns: none	Gtk.CellRenderer
	set_visible (gboolean *visible) : none Sets the cell renderer's visibility. Sets the cell renderer's visibility. Parameters: gboolean visible* Required (not null) the visibility of the cell Returns: none	Gtk.CellRenderer
	start_editing (Event *event, Widget widget, String path, RectangleInt background_area, RectangleInt cell_area, CellRendererState flags) : Gtk.CellEditable Passes an activate event to the cell renderer for possible processing. Passes an activate event to the cell renderer for possible processing. Parameters: Gdk.Event event* Required (not null) a GdkEvent Gtk.Widget widget Required (not null) widget that received the event String path Required (not null) widget-dependent string representation of the event location; e.g. for GtkTreeView, a string representation of GtkTreePath cairo.RectangleInt background_area Required (not null) background area as passed to gtk_cell_renderer_render() cairo.RectangleInt cell_area Required (not null) cell area as passed to gtk_cell_renderer_render() Gtk.CellRendererState flags Required (not null) render flags Returns: Gtk.CellEditable A new GtkCellEditable, or NULL	Gtk.CellRenderer
	stop_editing (gboolean *canceled) : none Informs the cell renderer that the editing is stopped. Informs the cell renderer that the editing is stopped. If canceled* is TRUE, the cell renderer will emit the GtkCellRenderer::editing-canceled signal. This function should be called by cell renderer implementations in response to the GtkCellEditable::editing-done signal of GtkCellEditable. Parameters: gboolean canceled Required (not null) TRUE if the editing has been canceled Returns: none	Gtk.CellRenderer

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	editing_canceled (CellRenderer *self) : none This signal gets emitted when the user cancels the process of editing a cell. 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. Parameters: Gtk.CellRenderer self* Returns: {none}	Gtk.CellRenderer
	editing_started (CellRenderer *self, CellEditable editable, String path) : none This signal gets emitted when a cell starts to be edited. 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. Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of editable before doing any specific setup, as in the following example: \|[ static void text_editing_started (GtkCellRenderer cell, GtkCellEditable editable, const gchar path, gpointer data) { if (GTK_IS_ENTRY (editable)) { GtkEntry entry = GTK_ENTRY (editable); /* ... create a GtkEntryCompletion / gtk_entry_set_completion (entry, completion); } } ]\| Parameters: Gtk.CellRenderer self* Gtk.CellEditable editable String path Returns: {none}	Gtk.CellRenderer