| 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.CellRendererSpinner
Description
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.
Synopsis
- newtype CellRendererSpinner = CellRendererSpinner (ManagedPtr CellRendererSpinner)
- class (GObject o, IsDescendantOf CellRendererSpinner o) => IsCellRendererSpinner o
- toCellRendererSpinner :: (MonadIO m, IsCellRendererSpinner o) => o -> m CellRendererSpinner
- noCellRendererSpinner :: Maybe CellRendererSpinner
- cellRendererSpinnerNew :: (HasCallStack, MonadIO m) => m CellRendererSpinner
- constructCellRendererSpinnerActive :: IsCellRendererSpinner o => Bool -> IO (GValueConstruct o)
- getCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> m Bool
- setCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> Bool -> m ()
- constructCellRendererSpinnerPulse :: IsCellRendererSpinner o => Word32 -> IO (GValueConstruct o)
- getCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> m Word32
- setCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> Word32 -> m ()
- constructCellRendererSpinnerSize :: IsCellRendererSpinner o => IconSize -> IO (GValueConstruct o)
- getCellRendererSpinnerSize :: (MonadIO m, IsCellRendererSpinner o) => o -> m IconSize
- setCellRendererSpinnerSize :: (MonadIO m, IsCellRendererSpinner o) => o -> IconSize -> m ()
Exported types
newtype CellRendererSpinner Source #
Memory-managed wrapper type.
Constructors
| CellRendererSpinner (ManagedPtr CellRendererSpinner) |
Instances
| Eq CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner Methods (==) :: CellRendererSpinner -> CellRendererSpinner -> Bool # (/=) :: CellRendererSpinner -> CellRendererSpinner -> Bool # | |
| IsGValue CellRendererSpinner Source # | Convert |
Defined in GI.Gtk.Objects.CellRendererSpinner Methods toGValue :: CellRendererSpinner -> IO GValue # fromGValue :: GValue -> IO CellRendererSpinner # | |
| GObject CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner Methods gobjectType :: IO GType # | |
| HasParentTypes CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
| type ParentTypes CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
class (GObject o, IsDescendantOf CellRendererSpinner o) => IsCellRendererSpinner o Source #
Type class for types which can be safely cast to CellRendererSpinner, for instance with toCellRendererSpinner.
Instances
| (GObject o, IsDescendantOf CellRendererSpinner o) => IsCellRendererSpinner o Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
toCellRendererSpinner :: (MonadIO m, IsCellRendererSpinner o) => o -> m CellRendererSpinner Source #
Cast to CellRendererSpinner, for types for which this is known to be safe. For general casts, use castTo.
noCellRendererSpinner :: Maybe CellRendererSpinner Source #
A convenience alias for Nothing :: Maybe CellRendererSpinner.
Methods
Overloaded methods
new
cellRendererSpinnerNew Source #
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m CellRendererSpinner | Returns: a new |
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) Source #
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 Source #
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 () Source #
Set the value of the “active” property.
When overloading is enabled, this is equivalent to
setcellRendererSpinner [ #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) Source #
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 Source #
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 () Source #
Set the value of the “pulse” property.
When overloading is enabled, this is equivalent to
setcellRendererSpinner [ #pulse:=value ]
size
The IconSize value that specifies the size of the rendered spinner.
Since: 2.20
constructCellRendererSpinnerSize :: IsCellRendererSpinner o => IconSize -> IO (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “size” property.
When overloading is enabled, this is equivalent to
setcellRendererSpinner [ #size:=value ]