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.Arrow

Contents

Exported types
Methods
- new
- set
Properties
- arrowType
- shadowType

Description

GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be amended in versions of GTK+ to come.

GtkArrow will fill any space alloted to it, but since it is inherited from Misc, it can be padded and/or aligned, to fill exactly the space the programmer desires.

Arrows are created with a call to arrowNew. The direction or style of an arrow can be changed after creation by using arrowSet.

GtkArrow has been deprecated; you can simply use a Image with a suitable icon name, such as “pan-down-symbolic“. When replacing GtkArrow by an image, pay attention to the fact that GtkArrow is doing automatic flipping between GTK_ARROW_LEFT and GTK_ARROW_RIGHT, depending on the text direction. To get the same effect with an image, use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which react to the text direction.

Synopsis

newtype Arrow = Arrow (ManagedPtr Arrow)
class GObject o => IsArrow o
toArrow :: (MonadIO m, IsArrow o) => o -> m Arrow
noArrow :: Maybe Arrow
arrowNew :: (HasCallStack, MonadIO m) => ArrowType -> ShadowType -> m Arrow
arrowSet :: (HasCallStack, MonadIO m, IsArrow a) => a -> ArrowType -> ShadowType -> m ()
constructArrowArrowType :: IsArrow o => ArrowType -> IO (GValueConstruct o)
getArrowArrowType :: (MonadIO m, IsArrow o) => o -> m ArrowType
setArrowArrowType :: (MonadIO m, IsArrow o) => o -> ArrowType -> m ()
constructArrowShadowType :: IsArrow o => ShadowType -> IO (GValueConstruct o)
getArrowShadowType :: (MonadIO m, IsArrow o) => o -> m ShadowType
setArrowShadowType :: (MonadIO m, IsArrow o) => o -> ShadowType -> m ()

Exported types

newtype Arrow Source #

Memory-managed wrapper type.

Constructors

Arrow (ManagedPtr Arrow)

Instances

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

class GObject o => IsArrow o Source #

Type class for types which can be safely cast to Arrow, for instance with toArrow.

Instances

(GObject a, (UnknownAncestorError Arrow a :: Constraint)) => IsArrow a Source #
Instance details Defined in GI.Gtk.Objects.Arrow
IsArrow Arrow Source #
Instance details Defined in GI.Gtk.Objects.Arrow

toArrow :: (MonadIO m, IsArrow o) => o -> m Arrow Source #

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

noArrow :: Maybe Arrow Source #

A convenience alias for Nothing :: Maybe Arrow.

Methods

new

arrowNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ArrowType	`arrowType`: a valid `ArrowType`.
-> ShadowType	`shadowType`: a valid `ShadowType`.
-> m Arrow	Returns: the new `Arrow` widget.

Deprecated: (Since version 3.14)Use a Image with a suitable icon.

Creates a new Arrow widget.

set

arrowSet Source #

Arguments

:: (HasCallStack, MonadIO m, IsArrow a)
=> a	`arrow`: a widget of type `Arrow`.
-> ArrowType	`arrowType`: a valid `ArrowType`.
-> ShadowType	`shadowType`: a valid `ShadowType`.
-> m ()

Deprecated: (Since version 3.14)Use a Image with a suitable icon.

Sets the direction and style of the Arrow, arrow.

Properties

arrowType

No description available in the introspection data.

constructArrowArrowType :: IsArrow o => ArrowType -> IO (GValueConstruct o) Source #

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

getArrowArrowType :: (MonadIO m, IsArrow o) => o -> m ArrowType Source #

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

get arrow #arrowType

setArrowArrowType :: (MonadIO m, IsArrow o) => o -> ArrowType -> m () Source #

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

set arrow [ #arrowType := value ]

shadowType

No description available in the introspection data.

constructArrowShadowType :: IsArrow o => ShadowType -> IO (GValueConstruct o) Source #

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

getArrowShadowType :: (MonadIO m, IsArrow o) => o -> m ShadowType Source #

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

get arrow #shadowType

setArrowShadowType :: (MonadIO m, IsArrow o) => o -> ShadowType -> m () Source #

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

set arrow [ #shadowType := value ]