Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
treeViewColumnAddAttribute
.
Synopsis
- newtype CellRendererSpinner = CellRendererSpinner (ManagedPtr CellRendererSpinner)
- class (GObject o, IsDescendantOf CellRendererSpinner o) => IsCellRendererSpinner o
- toCellRendererSpinner :: (MonadIO m, IsCellRendererSpinner o) => o -> m CellRendererSpinner
- cellRendererSpinnerNew :: (HasCallStack, MonadIO m) => m CellRendererSpinner
- constructCellRendererSpinnerActive :: (IsCellRendererSpinner o, MonadIO m) => Bool -> m (GValueConstruct o)
- getCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> m Bool
- setCellRendererSpinnerActive :: (MonadIO m, IsCellRendererSpinner o) => o -> Bool -> m ()
- constructCellRendererSpinnerPulse :: (IsCellRendererSpinner o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> m Word32
- setCellRendererSpinnerPulse :: (MonadIO m, IsCellRendererSpinner o) => o -> Word32 -> m ()
- constructCellRendererSpinnerSize :: (IsCellRendererSpinner o, MonadIO m) => IconSize -> m (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.
Instances
Eq CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner (==) :: CellRendererSpinner -> CellRendererSpinner -> Bool # (/=) :: CellRendererSpinner -> CellRendererSpinner -> Bool # | |
GObject CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
ManagedPtrNewtype CellRendererSpinner Source # | |
TypedObject CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
HasParentTypes CellRendererSpinner Source # | |
Defined in GI.Gtk.Objects.CellRendererSpinner | |
IsGValue (Maybe CellRendererSpinner) Source # | Convert |
Defined in GI.Gtk.Objects.CellRendererSpinner gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe CellRendererSpinner -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe 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
.
Methods
Click to display all available methods, including inherited ones
Methods
activate, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isActivatable, isFloating, notify, notifyByPspec, ref, refSink, runDispose, snapshot, startEditing, stealData, stealQdata, stopEditing, thawNotify, unref, watchClosure.
Getters
getAlignedArea, getAlignment, getData, getFixedSize, getIsExpanded, getIsExpander, getPadding, getPreferredHeight, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRequestMode, getSensitive, getState, getVisible.
Setters
setAlignment, setData, setDataFull, setFixedSize, setIsExpanded, setIsExpander, setPadding, setProperty, setSensitive, setVisible.
new
cellRendererSpinnerNew Source #
:: (HasCallStack, MonadIO m) | |
=> m CellRendererSpinner | Returns: a new |
Returns a new cell renderer which will show a spinner to indicate activity.
Properties
active
No description available in the introspection data.
constructCellRendererSpinnerActive :: (IsCellRendererSpinner o, MonadIO m) => Bool -> m (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
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 GtkSpinner
widget draws one full cycle of the animation,
consisting of 12 frames, in 750 milliseconds.
constructCellRendererSpinnerPulse :: (IsCellRendererSpinner o, MonadIO m) => Word32 -> m (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
set
cellRendererSpinner [ #pulse:=
value ]
size
The GtkIconSize
value that specifies the size of the rendered spinner.
constructCellRendererSpinnerSize :: (IsCellRendererSpinner o, MonadIO m) => IconSize -> m (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
set
cellRendererSpinner [ #size:=
value ]