Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.Spinner

Contents

Exported types
Methods
Properties
- active

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 => IsSpinner o
toSpinner :: (MonadIO m, IsSpinner o) => o -> m Spinner
noSpinner :: Maybe Spinner
spinnerNew :: (HasCallStack, MonadIO m) => m Spinner
spinnerStart :: (HasCallStack, MonadIO m, IsSpinner a) => a -> m ()
spinnerStop :: (HasCallStack, MonadIO m, IsSpinner a) => a -> m ()
constructSpinnerActive :: IsSpinner o => Bool -> IO (GValueConstruct o)
getSpinnerActive :: (MonadIO m, IsSpinner o) => o -> m Bool
setSpinnerActive :: (MonadIO m, IsSpinner o) => o -> Bool -> m ()

Exported types

newtype Spinner Source #

Memory-managed wrapper type.

Constructors

Spinner (ManagedPtr Spinner)

Instances

GObject Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner Methods gobjectType :: Spinner -> IO GType #
IsImplementorIface Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
IsObject Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
IsBuildable Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
IsWidget Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner
IsSpinner Spinner Source #
Instance details Defined in GI.Gtk.Objects.Spinner

class GObject o => IsSpinner o Source #

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

Instances

(GObject a, (UnknownAncestorError Spinner a :: Constraint)) => IsSpinner a Source #
Instance details Defined in GI.Gtk.Objects.Spinner
IsSpinner Spinner 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.

noSpinner :: Maybe Spinner Source #

A convenience alias for Nothing :: Maybe Spinner.

Methods

new

spinnerNew Source #

Arguments

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

Returns a new spinner widget. Not yet started.

Since: 2.20

start

spinnerStart Source #

Arguments

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

Starts the animation of the spinner.

Since: 2.20

stop

spinnerStop Source #

Arguments

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

Stops the animation of the spinner.

Since: 2.20

Properties

active

No description available in the introspection data.

constructSpinnerActive :: IsSpinner o => Bool -> IO (GValueConstruct o) Source #

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

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

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

get spinner #active

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

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

set spinner [ #active := value ]