Graphics.UI.Gtk.Misc.Arrow

gtk3-0.14.6: Binding to the Gtk+ 3 graphical user interface library

Maintainer | gtk2hs-users@lists.sourceforge.net
Stability | provisional
Portability | portable (depends on GHC)
Safe Haskell | None
Language | Haskell98

Graphics.UI.Gtk.Misc.Arrow

Contents

- Detail
- Class Hierarchy
- Types
- Constructors
- Methods
- Attributes

Description

Displays an arrow

Synopsis

- data Arrow
- class MiscClass o => ArrowClass o
- castToArrow :: GObjectClass obj => obj -> Arrow
- gTypeArrow :: GType
- toArrow :: ArrowClass o => o -> Arrow
- data ArrowType
  - = ArrowUp
  - | ArrowDown
  - | ArrowLeft
  - | ArrowRight
  - | ArrowNone
- data ShadowType
  - = ShadowNone
  - | ShadowIn
  - | ShadowOut
  - | ShadowEtchedIn
  - | ShadowEtchedOut
- arrowNew :: ArrowType -> ShadowType -> IO Arrow
- arrowSet :: ArrowClass self => self -> ArrowType -> ShadowType -> IO ()
- arrowArrowType :: ArrowClass self => Attr self ArrowType
- arrowShadowType :: ArrowClass self => Attr self ShadowType

# Detail

`Arrow` 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 ammended in versions of Gtk to come.

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

# Class Hierarchy

    | GObject
    | +----Object
    | +----Widget
    | +----Misc
    | +----Arrow

# Types

data Arrow #

Instances

Eq Arrow # |
Methods (==) :: Arrow -> Arrow -> Bool # (/=) :: Arrow -> Arrow -> Bool #
Ord Arrow # |
Methods compare :: Arrow -> Arrow -> Ordering # (<) :: Arrow -> Arrow -> Bool # (<=) :: Arrow -> Arrow -> Bool # (>) :: Arrow -> Arrow -> Bool # (>=) :: Arrow -> Arrow -> Bool # max :: Arrow -> Arrow -> Arrow # min :: Arrow -> Arrow -> Arrow #
GObjectClass Arrow # |
Methods toGObject :: Arrow -> GObject # unsafeCastGObject :: GObject -> Arrow #
ArrowClass Arrow # |
MiscClass Arrow # |
WidgetClass Arrow # |

class MiscClass o => ArrowClass o #

Instances

ArrowClass Arrow # |

castToArrow :: GObjectClass obj => obj -> Arrow #

gTypeArrow :: GType #

toArrow :: ArrowClass o => o -> Arrow #

data ArrowType #

Arrow directions for the arrow widget

Constructors

ArrowUp |
ArrowDown |
ArrowLeft |
ArrowRight |
ArrowNone |

Instances

Enum ArrowType # |
Methods succ :: ArrowType -> ArrowType # pred :: ArrowType -> ArrowType # toEnum :: Int -> ArrowType # fromEnum :: ArrowType -> Int # enumFrom :: ArrowType -> [ArrowType] # enumFromThen :: ArrowType -> ArrowType -> [ArrowType] # enumFromTo :: ArrowType -> ArrowType -> [ArrowType] # enumFromThenTo :: ArrowType -> ArrowType -> ArrowType -> [ArrowType] #
Eq ArrowType # |
Methods (==) :: ArrowType -> ArrowType -> Bool # (/=) :: ArrowType -> ArrowType -> Bool #
Show ArrowType # |
Methods showsPrec :: Int -> ArrowType -> ShowS # show :: ArrowType -> String # showList :: [ArrowType] -> ShowS #

data ShadowType #

Shadow types

Constructors

ShadowNone |
ShadowIn |
ShadowOut |
ShadowEtchedIn |
ShadowEtchedOut |

Instances

Enum ShadowType # |
Methods succ :: ShadowType -> ShadowType # pred :: ShadowType -> ShadowType # toEnum :: Int -> ShadowType # fromEnum :: ShadowType -> Int # enumFrom :: ShadowType -> [ShadowType] # enumFromThen :: ShadowType -> ShadowType -> [ShadowType] # enumFromTo :: ShadowType -> ShadowType -> [ShadowType] # enumFromThenTo :: ShadowType -> ShadowType -> ShadowType -> [ShadowType] #
Eq ShadowType # |
Methods (==) :: ShadowType -> ShadowType -> Bool # (/=) :: ShadowType -> ShadowType -> Bool #
Show ShadowType # |
Methods showsPrec :: Int -> ShadowType -> ShowS # show :: ShadowType -> String # showList :: [ShadowType] -> ShowS #

# Constructors

arrowNew :: ArrowType -> ShadowType -> IO Arrow #

Creates a new arrow widget.

# Methods

arrowSet :: ArrowClass self => self -> ArrowType -> ShadowType -> IO () #

Sets the direction and style of the `Arrow`.

# Attributes

arrowArrowType :: ArrowClass self => Attr self ArrowType #

The direction the arrow should point.

Default value: `ArrowRight`

arrowShadowType :: ArrowClass self => Attr self ShadowType #

Appearance of the shadow surrounding the arrow.

Default value: `ShadowOut`