| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.Spinner
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
- 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, MonadIO m) => Bool -> m (GValueConstruct o)
- getSpinnerActive :: (MonadIO m, IsSpinner o) => o -> m Bool
- setSpinnerActive :: (MonadIO m, IsSpinner o) => o -> Bool -> m ()
Exported types
Memory-managed wrapper type.
Instances
| Eq Spinner Source # | |
| GObject Spinner Source # | |
Defined in GI.Gtk.Objects.Spinner | |
| ManagedPtrNewtype Spinner Source # | |
Defined in GI.Gtk.Objects.Spinner Methods toManagedPtr :: Spinner -> ManagedPtr Spinner | |
| TypedObject Spinner Source # | |
Defined in GI.Gtk.Objects.Spinner | |
| HasParentTypes Spinner Source # | |
Defined in GI.Gtk.Objects.Spinner | |
| IsGValue (Maybe Spinner) Source # | Convert |
Defined in GI.Gtk.Objects.Spinner Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Spinner -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Spinner) | |
| type ParentTypes Spinner Source # | |
Defined in GI.Gtk.Objects.Spinner | |
class (GObject o, IsDescendantOf Spinner o) => IsSpinner o Source #
Instances
| (GObject o, IsDescendantOf Spinner o) => IsSpinner o Source # | |
Defined in GI.Gtk.Objects.Spinner | |
Methods
Click to display all available methods, including inherited ones
Methods
activate, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, childFocus, childNotify, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forceFloating, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, start, stealData, stealQdata, stop, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetStateFlags, watchClosure.
Getters
getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getCanDefault, getCanFocus, getChildRequisition, getChildVisible, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReceivesDefault, setRedrawOnAllocate, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m Spinner | Returns: a new |
Returns a new spinner widget. Not yet started.
Since: 2.20
start
Arguments
| :: (HasCallStack, MonadIO m, IsSpinner a) | |
| => a |
|
| -> m () |
Starts the animation of the spinner.
Since: 2.20
stop
Arguments
| :: (HasCallStack, MonadIO m, IsSpinner a) | |
| => a |
|
| -> m () |
Stops the animation of the spinner.
Since: 2.20
Properties
active
No description available in the introspection data.
constructSpinnerActive :: (IsSpinner 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.
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
setspinner [ #active:=value ]