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

GI.Handy.Objects.Arrows

Contents

Exported types
Methods
Properties

Description

No description available in the introspection data.

Synopsis

newtype Arrows = Arrows (ManagedPtr Arrows)
class (GObject o, IsDescendantOf Arrows o) => IsArrows o
toArrows :: (MonadIO m, IsArrows o) => o -> m Arrows
noArrows :: Maybe Arrows
arrowsAnimate :: (HasCallStack, MonadIO m, IsArrows a) => a -> m ()
arrowsGetCount :: (HasCallStack, MonadIO m, IsArrows a) => a -> m Word32
arrowsGetDirection :: (HasCallStack, MonadIO m, IsArrows a) => a -> m ArrowsDirection
arrowsGetDuration :: (HasCallStack, MonadIO m, IsArrows a) => a -> m Word32
arrowsNew :: (HasCallStack, MonadIO m) => m Arrows
arrowsSetCount :: (HasCallStack, MonadIO m, IsArrows a) => a -> Word32 -> m ()
arrowsSetDirection :: (HasCallStack, MonadIO m, IsArrows a) => a -> ArrowsDirection -> m ()
arrowsSetDuration :: (HasCallStack, MonadIO m, IsArrows a) => a -> Word32 -> m ()
constructArrowsCount :: IsArrows o => Word32 -> IO (GValueConstruct o)
getArrowsCount :: (MonadIO m, IsArrows o) => o -> m Word32
setArrowsCount :: (MonadIO m, IsArrows o) => o -> Word32 -> m ()
constructArrowsDirection :: IsArrows o => ArrowsDirection -> IO (GValueConstruct o)
getArrowsDirection :: (MonadIO m, IsArrows o) => o -> m ArrowsDirection
setArrowsDirection :: (MonadIO m, IsArrows o) => o -> ArrowsDirection -> m ()
constructArrowsDuration :: IsArrows o => Word32 -> IO (GValueConstruct o)
getArrowsDuration :: (MonadIO m, IsArrows o) => o -> m Word32
setArrowsDuration :: (MonadIO m, IsArrows o) => o -> Word32 -> m ()

Exported types

newtype Arrows Source #

Memory-managed wrapper type.

Constructors

Arrows (ManagedPtr Arrows)

Instances

GObject Arrows Source #
Instance details Defined in GI.Handy.Objects.Arrows Methods gobjectType :: IO GType #
HasParentTypes Arrows Source #
Instance details Defined in GI.Handy.Objects.Arrows
type ParentTypes Arrows Source #
Instance details Defined in GI.Handy.Objects.Arrows type ParentTypes Arrows = DrawingArea ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': ([] :: [Type])))))

class (GObject o, IsDescendantOf Arrows o) => IsArrows o Source #

Type class for types which can be safely cast to Arrows, for instance with toArrows.

Instances

(GObject o, IsDescendantOf Arrows o) => IsArrows o Source #
Instance details Defined in GI.Handy.Objects.Arrows

toArrows :: (MonadIO m, IsArrows o) => o -> m Arrows Source #

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

noArrows :: Maybe Arrows Source #

A convenience alias for Nothing :: Maybe Arrows.

Methods

animate

arrowsAnimate Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> m ()

Render the arrows animation.

getCount

arrowsGetCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> m Word32	Returns: the current number of arrows

Get the number of errors in displayed in the widget.

getDirection

arrowsGetDirection Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> m ArrowsDirection	Returns: the arrows direction

Get the direction the arrows point to

getDuration

arrowsGetDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> m Word32	Returns: the arrows

Get the duration of the arrows animation.

new

arrowsNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Arrows	Returns: the newly created `Arrows` widget

Create a new Arrows widget.

setCount

arrowsSetCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> Word32	`count`: the number of arrows to display
-> m ()

Set the number of arrows to display.

setDirection

arrowsSetDirection Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> ArrowsDirection	`direction`: the arrows direction
-> m ()

Set the direction the arrows should point to.

setDuration

arrowsSetDuration Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrows a)
=> a	`self`: a `Arrows`
-> Word32	`duration`: the duration of the animation in ms
-> m ()

Set the duration of the arrow animation.

Properties

count

No description available in the introspection data.

constructArrowsCount :: IsArrows o => Word32 -> IO (GValueConstruct o) Source #

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

getArrowsCount :: (MonadIO m, IsArrows o) => o -> m Word32 Source #

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

get arrows #count

setArrowsCount :: (MonadIO m, IsArrows o) => o -> Word32 -> m () Source #

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

set arrows [ #count := value ]

direction

No description available in the introspection data.

constructArrowsDirection :: IsArrows o => ArrowsDirection -> IO (GValueConstruct o) Source #

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

getArrowsDirection :: (MonadIO m, IsArrows o) => o -> m ArrowsDirection Source #

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

get arrows #direction

setArrowsDirection :: (MonadIO m, IsArrows o) => o -> ArrowsDirection -> m () Source #

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

set arrows [ #direction := value ]

duration

No description available in the introspection data.

constructArrowsDuration :: IsArrows o => Word32 -> IO (GValueConstruct o) Source #

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

getArrowsDuration :: (MonadIO m, IsArrows o) => o -> m Word32 Source #

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

get arrows #duration

setArrowsDuration :: (MonadIO m, IsArrows o) => o -> Word32 -> m () Source #

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

set arrows [ #duration := value ]