GI.Gtk.Objects.CellRendererSpinner

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

To start the animation in a cell, set the CellRendererSpinner:active property to True and increment the CellRendererSpinner: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. treeViewColumnAddAttribute.

Exported types

newtype CellRendererSpinner

Memory-managed wrapper type.

Constructors

CellRendererSpinner (ManagedPtr CellRendererSpinner)

Instances

GObject CellRendererSpinner

Methods

gobjectType :: CellRendererSpinner -> IO GType

IsObject CellRendererSpinner

IsCellRenderer CellRendererSpinner

IsCellRendererSpinner CellRendererSpinner

class GObject o => IsCellRendererSpinner o

Type class for types which can be safely cast to CellRendererSpinner, for instance with toCellRendererSpinner.

Instances

(GObject a, UnknownAncestorError Constraint CellRendererSpinner a) => IsCellRendererSpinner a

IsCellRendererSpinner CellRendererSpinner

toCellRendererSpinner :: (MonadIO m, IsCellRendererSpinner o) => o -> m CellRendererSpinner

Cast to CellRendererSpinner, for types for which this is known to be safe. For general casts, use castTo.

noCellRendererSpinner :: Maybe CellRendererSpinner

A convenience alias for Nothing :: Maybe CellRendererSpinner.

Methods

new

cellRendererSpinnerNew

Arguments

:: (HasCallStack, MonadIO m)

=> m CellRendererSpinner

Returns: a new CellRenderer

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

Since: 2.20

Properties

active

No description available in the introspection data.

constructCellRendererSpinnerActive :: IsCellRendererSpinner o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “active” property. This is rarely needed directly, but it is used by new.

getCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> m Bool

Get the value of the “active” property. When overloading is enabled, this is equivalent to

get cellRendererSpinner #active

setCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> Bool -> m ()

Set the value of the “active” property. When overloading is enabled, this is equivalent to

set cellRendererSpinner [ #active := value ]

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.

By default, the Spinner widget draws one full cycle of the animation, consisting of 12 frames, in 750 milliseconds.

Since: 2.20

constructCellRendererSpinnerPulse :: IsCellRendererSpinner o => Word32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “pulse” property. This is rarely needed directly, but it is used by new.

getCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> m Word32

Get the value of the “pulse” property. When overloading is enabled, this is equivalent to

get cellRendererSpinner #pulse

setCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> Word32 -> m ()

Set the value of the “pulse” property. When overloading is enabled, this is equivalent to

set cellRendererSpinner [ #pulse := value ]

size

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

Since: 2.20

constructCellRendererSpinnerSize :: IsCellRendererSpinner o => IconSize -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “size” property. This is rarely needed directly, but it is used by new.

getCellRendererSpinnerSize :: (MonadIO m, IsCellRendererSpinner o) => o -> m IconSize

Get the value of the “size” property. When overloading is enabled, this is equivalent to

get cellRendererSpinner #size

setCellRendererSpinnerSize :: (MonadIO m, IsCellRendererSpinner o) => o -> IconSize -> m ()

Set the value of the “size” property. When overloading is enabled, this is equivalent to

set cellRendererSpinner [ #size := value ]