CellRendererSpinner

open class CellRendererSpinner(pointer: <Error class: unknown class><<Error class: unknown class>>) : CellRenderer

Renders a spinning animation in a cell

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

Skipped during bindings generation

  • method active: Property has no getter nor setter

  • method pulse: Property has no getter nor setter

  • method size: Property has no getter nor setter

Constructors

Link copied to clipboard
constructor()

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

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val gtkCellRendererPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkCellRendererSpinnerPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open var sensitive: Boolean
Link copied to clipboard
open var visible: Boolean

Functions

Link copied to clipboard
open fun activate(event: <Error class: unknown class>, widget: Widget, path: String, backgroundArea: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): Boolean

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.

Link copied to clipboard
fun connectEditingCanceled(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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.

Link copied to clipboard
fun connectEditingStarted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (editable: CellEditable, path: String) -> Unit): <Error class: unknown class>

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.

Link copied to clipboard
open fun getAlignedArea(widget: Widget, flags: CellRendererState, cellArea: <Error class: unknown class>, alignedArea: <Error class: unknown class>)

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

Link copied to clipboard

Checks whether the given GtkCellRenderer is expanded.

Link copied to clipboard

Checks whether the given GtkCellRenderer is an expander.

Link copied to clipboard
open fun getPreferredSize(widget: Widget, minimumSize: Requisition?, naturalSize: Requisition?)

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

Link copied to clipboard

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

Link copied to clipboard
open fun getSensitive(): Boolean

Returns the cell renderer’s sensitivity.

Link copied to clipboard
open fun getState(widget: Widget? = null, cellState: CellRendererState): StateFlags

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

Link copied to clipboard
open fun getVisible(): Boolean

Returns the cell renderer’s visibility.

Link copied to clipboard

Checks whether the cell renderer can do something when activated.

Link copied to clipboard
open fun setAlignment(xalign: Float, yalign: Float)

Sets the renderer’s alignment within its available space.

Link copied to clipboard
open fun setFixedSize(width: Int, height: Int)

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

Link copied to clipboard
open fun setIsExpanded(isExpanded: Boolean)

Sets whether the given GtkCellRenderer is expanded.

Link copied to clipboard
open fun setIsExpander(isExpander: Boolean)

Sets whether the given GtkCellRenderer is an expander.

Link copied to clipboard
open fun setPadding(xpad: Int, ypad: Int)

Sets the renderer’s padding.

Link copied to clipboard
open fun setSensitive(sensitive: Boolean)

Sets the cell renderer’s sensitivity.

Link copied to clipboard
open fun setVisible(visible: Boolean)

Sets the cell renderer’s visibility.

Link copied to clipboard
open fun startEditing(event: <Error class: unknown class>? = null, widget: Widget, path: String, backgroundArea: <Error class: unknown class>, cellArea: <Error class: unknown class>, flags: CellRendererState): CellEditable?

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

Link copied to clipboard
open fun stopEditing(canceled: Boolean)

Informs the cell renderer that the editing is stopped. If @canceled is true, the cell renderer will emit the GtkCellRenderer::editing-canceled signal.