Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Spinner

Contents

Exported types
Methods
Properties
- spinning

Description

A GtkSpinner widget displays an icon-size spinning animation. It is often used as an alternative to a ProgressBar for displaying indefinite activity, instead of actual progress.

To start the animation, use spinnerStart, to stop it use spinnerStop.

CSS nodes

GtkSpinner has a single CSS node with the name spinner. When the animation is active, the :checked pseudoclass is added to this node.

Synopsis

newtype Spinner = Spinner (ManagedPtr Spinner)
class (GObject o, IsDescendantOf Spinner o) => IsSpinner o
toSpinner :: (MonadIO m, IsSpinner o) => o -> m Spinner
spinnerGetSpinning :: (HasCallStack, MonadIO m, IsSpinner a) => a -> m Bool
spinnerNew :: (HasCallStack, MonadIO m) => m Spinner
spinnerSetSpinning :: (HasCallStack, MonadIO m, IsSpinner a) => a -> Bool -> m ()
spinnerStart :: (HasCallStack, MonadIO m, IsSpinner a) => a -> m ()
spinnerStop :: (HasCallStack, MonadIO m, IsSpinner a) => a -> m ()
constructSpinnerSpinning :: (IsSpinner o, MonadIO m) => Bool -> m (GValueConstruct o)
getSpinnerSpinning :: (MonadIO m, IsSpinner o) => o -> m Bool
setSpinnerSpinning :: (MonadIO m, IsSpinner o) => o -> Bool -> m ()

Exported types

newtype Spinner Source #

Memory-managed wrapper type.

Constructors

Spinner (ManagedPtr Spinner)

Instances

Instances details

Eq Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner Methods (==) :: Spinner -> Spinner -> Bool (/=) :: Spinner -> Spinner -> Bool
GObject Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
ManagedPtrNewtype Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner Methods toManagedPtr :: Spinner -> ManagedPtr Spinner
TypedObject Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner Methods glibType :: IO GType
IsGValue Spinner Source #	Convert `Spinner` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.Spinner Methods toGValue :: Spinner -> IO GValue fromGValue :: GValue -> IO Spinner
HasParentTypes Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
type ParentTypes Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner type ParentTypes Spinner = '[Widget, Object, ImplementorIface, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Spinner o) => IsSpinner o Source #

Type class for types which can be safely cast to Spinner, for instance with toSpinner.

Instances

Instances details

(GObject o, IsDescendantOf Spinner o) => IsSpinner o Source #
Instance details Defined in GI.Gtk.Objects.Spinner

toSpinner :: (MonadIO m, IsSpinner o) => o -> m Spinner Source #

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

Methods

Overloaded methods

getSpinning

spinnerGetSpinning Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinner a)
=> a	`spinner`: a `Spinner`
-> m Bool	Returns: `True` if the spinner is active

Returns whether the spinner is spinning.

new

spinnerNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Spinner	Returns: a new `Spinner`

Returns a new spinner widget. Not yet started.

setSpinning

spinnerSetSpinning Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinner a)
=> a	`spinner`: a `Spinner`
-> Bool	`spinning`: whether the spinner should be spinning
-> m ()

Sets the activity of the spinner.

start

spinnerStart Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinner a)
=> a	`spinner`: a `Spinner`
-> m ()

Starts the animation of the spinner.

stop

spinnerStop Source #

Arguments

:: (HasCallStack, MonadIO m, IsSpinner a)
=> a	`spinner`: a `Spinner`
-> m ()

Stops the animation of the spinner.

Properties

spinning

No description available in the introspection data.

constructSpinnerSpinning :: (IsSpinner o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSpinnerSpinning :: (MonadIO m, IsSpinner o) => o -> m Bool Source #

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

get spinner #spinning

setSpinnerSpinning :: (MonadIO m, IsSpinner o) => o -> Bool -> m () Source #

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

set spinner [ #spinning := value ]