Safe Haskell	None
Language	Haskell98

HTk.Widgets.ScrollBar

Description

HTk's scrollbar widget.

A scroll bar is a widget which controls scrolling.

Synopsis

Documentation

class Widget w => HasScroller w where Source #

Scrollable widgets instantiate class HasScroller.

Methods

isWfOrientation :: w -> Orientation -> Bool Source #

scrollbar :: Orientation -> ScrollBar -> Config w Source #

moveto :: Orientation -> w -> Fraction -> IO () Source #

scroll :: Orientation -> w -> Int -> ScrollUnit -> IO () Source #

view :: Orientation -> w -> IO (Fraction, Fraction) Source #

Instances

HasScroller Canvas Source #	A canvas is a scrollable widget.
Methods isWfOrientation :: Canvas -> Orientation -> Bool Source # scrollbar :: Orientation -> ScrollBar -> Config Canvas Source # moveto :: Orientation -> Canvas -> Fraction -> IO () Source # scroll :: Orientation -> Canvas -> Int -> ScrollUnit -> IO () Source # view :: Orientation -> Canvas -> IO (Fraction, Fraction) Source #
HasScroller Editor Source #	An editor is a scrollable widget.
Methods isWfOrientation :: Editor -> Orientation -> Bool Source # scrollbar :: Orientation -> ScrollBar -> Config Editor Source # moveto :: Orientation -> Editor -> Fraction -> IO () Source # scroll :: Orientation -> Editor -> Int -> ScrollUnit -> IO () Source # view :: Orientation -> Editor -> IO (Fraction, Fraction) Source #
HasScroller (ListBox a) Source #	A listbox is a scrollable widget.
Methods isWfOrientation :: ListBox a -> Orientation -> Bool Source # scrollbar :: Orientation -> ScrollBar -> Config (ListBox a) Source # moveto :: Orientation -> ListBox a -> Fraction -> IO () Source # scroll :: Orientation -> ListBox a -> Int -> ScrollUnit -> IO () Source # view :: Orientation -> ListBox a -> IO (Fraction, Fraction) Source #
HasScroller (Entry a) Source #	An entry field is scrollable in horizontal direction.
Methods isWfOrientation :: Entry a -> Orientation -> Bool Source # scrollbar :: Orientation -> ScrollBar -> Config (Entry a) Source # moveto :: Orientation -> Entry a -> Fraction -> IO () Source # scroll :: Orientation -> Entry a -> Int -> ScrollUnit -> IO () Source # view :: Orientation -> Entry a -> IO (Fraction, Fraction) Source #
HasScroller a => HasScroller (ScrollBox a) Source #	A scrollbox has scrollbars.
Methods isWfOrientation :: ScrollBox a -> Orientation -> Bool Source # scrollbar :: Orientation -> ScrollBar -> Config (ScrollBox a) Source # moveto :: Orientation -> ScrollBox a -> Fraction -> IO () Source # scroll :: Orientation -> ScrollBox a -> Int -> ScrollUnit -> IO () Source # view :: Orientation -> ScrollBox a -> IO (Fraction, Fraction) Source #

data ScrollBar Source #

The ScrollBar datatype.

Instances

Eq ScrollBar Source #
Methods (==) :: ScrollBar -> ScrollBar -> Bool # (/=) :: ScrollBar -> ScrollBar -> Bool #
Destroyable ScrollBar Source #	A scrollbar widget can be destroyed.
Methods destroy :: ScrollBar -> IO () #
GUIObject ScrollBar Source #	Internal.
Methods toGUIObject :: ScrollBar -> GUIOBJECT Source # cname :: ScrollBar -> String Source # cset :: GUIValue a => ScrollBar -> ConfigID -> a -> IO ScrollBar Source # cget :: GUIValue a => ScrollBar -> ConfigID -> IO a Source #
HasEnable ScrollBar Source #	A scrollbar widget is a stateful widget, it can be enabled or disabled.
Methods state :: State -> Config ScrollBar Source # getState :: ScrollBar -> IO State Source # disable :: Config ScrollBar Source # enable :: Config ScrollBar Source # isEnabled :: ScrollBar -> IO Bool Source #
HasOrientation ScrollBar Source #	The scrollbars orientation can be `Horizontal` or `Vertical`.
Methods orient :: Orientation -> Config ScrollBar Source # getOrient :: ScrollBar -> IO Orientation Source #
HasBorder ScrollBar Source #	A scrollbar widget has a configureable border.
Methods borderwidth :: Distance -> Config ScrollBar Source # getBorderwidth :: ScrollBar -> IO Distance Source # relief :: Relief -> Config ScrollBar Source # getRelief :: ScrollBar -> IO Relief Source #
HasSize ScrollBar Source #	You can specify the width of a scrollbar.
Methods width :: Distance -> Config ScrollBar Source # getWidth :: ScrollBar -> IO Distance Source # height :: Distance -> Config ScrollBar Source # getHeight :: ScrollBar -> IO Distance Source # size :: Size -> Config ScrollBar Source # getSize :: ScrollBar -> IO Size Source #
HasColour ScrollBar Source #	A scrollbar widget has a background and activebackground (regarding slider) colour.
Methods legalColourID :: ScrollBar -> ConfigID -> Bool Source # setColour :: ScrollBar -> ConfigID -> Colour -> IO ScrollBar Source # getColour :: ScrollBar -> ConfigID -> IO Colour Source #
HasTooltip ScrollBar Source #	A scrollbar can have a tooltip.
Methods tooltip :: String -> ScrollBar -> IO ScrollBar Source # destroyTooltip :: ScrollBar -> IO () Source #
Widget ScrollBar Source #	A scrollbar widget has standard widget properties (concerning focus, cursor).
Methods cursor :: CursorDesignator ch => ch -> Config ScrollBar Source # getCursor :: ScrollBar -> IO Cursor Source # takeFocus :: Bool -> Config ScrollBar Source # getTakeFocus :: ScrollBar -> IO Bool Source #
HasSlider ScrollBar Source #	The scrollbar has a configureable slider component.
Methods repeatInterval :: Int -> Config (Slider ScrollBar) Source # getRepeatInterval :: Slider ScrollBar -> IO Int Source # repeatDelay :: Int -> Config (Slider ScrollBar) Source # getRepeatDelay :: Slider ScrollBar -> IO Int Source #

newScrollBar Source #

Arguments

:: Container par
=> par	the parent widget, which has to be a container widget (an instance of `class Container`).
-> [Config ScrollBar]	the list of configuration options for this scrollbar.
-> IO ScrollBar	A scrollbar widget.

Constructs a new scrollbar widget and returns a handler.

data ScrollUnit Source #

The ScrollUnit datatype - units for scrolling operations.

Constructors

Units
Pages

Instances

Read ScrollUnit Source #	Internal.
Methods readsPrec :: Int -> ReadS ScrollUnit # readList :: ReadS [ScrollUnit] # readPrec :: ReadPrec ScrollUnit # readListPrec :: ReadPrec [ScrollUnit] #
Show ScrollUnit Source #	Internal.
Methods showsPrec :: Int -> ScrollUnit -> ShowS # show :: ScrollUnit -> String # showList :: [ScrollUnit] -> ShowS #
GUIValue ScrollUnit Source #	Internal.
Methods cdefault :: ScrollUnit Source # toGUIValue :: ScrollUnit -> GUIVALUE Source # maybeGUIValue :: GUIVALUE -> Maybe ScrollUnit Source # fromGUIValue :: GUIVALUE -> ScrollUnit Source #

newtype Slider w Source #

The Slider datatype.

Constructors

Slider w

Instances

GUIObject w => GUIObject (Slider w) Source #	Internal.
Methods toGUIObject :: Slider w -> GUIOBJECT Source # cname :: Slider w -> String Source # cset :: GUIValue a => Slider w -> ConfigID -> a -> IO (Slider w) Source # cget :: GUIValue a => Slider w -> ConfigID -> IO a Source #
HasSize (Slider (Scale a)) Source #	A scale's slider has a configureable size.
Methods width :: Distance -> Config (Slider (Scale a)) Source # getWidth :: Slider (Scale a) -> IO Distance Source # height :: Distance -> Config (Slider (Scale a)) Source # getHeight :: Slider (Scale a) -> IO Distance Source # size :: Size -> Config (Slider (Scale a)) Source # getSize :: Slider (Scale a) -> IO Size Source #
(HasSlider w, GUIObject w) => HasColour (Slider w) Source #	The slider component has a configureable foreground and background colour.
Methods legalColourID :: Slider w -> ConfigID -> Bool Source # setColour :: Slider w -> ConfigID -> Colour -> IO (Slider w) Source # getColour :: Slider w -> ConfigID -> IO Colour Source #
ScaleValue a => HasIncrement (Slider (Scale a)) a Source #	A scale's slider has a configureable resulution.
Methods increment :: a -> Config (Slider (Scale a)) Source # getIncrement :: Slider (Scale a) -> IO a Source #

class Widget w => HasSlider w where Source #

Widgets with sliders (scale widget, scrollbar) instantiate the class HasSlider.

Methods

repeatInterval :: Int -> Config (Slider w) Source #

getRepeatInterval :: Slider w -> IO Int Source #

repeatDelay :: Int -> Config (Slider w) Source #

getRepeatDelay :: Slider w -> IO Int Source #

Instances

HasSlider ScrollBar Source #	The scrollbar has a configureable slider component.
Methods repeatInterval :: Int -> Config (Slider ScrollBar) Source # getRepeatInterval :: Slider ScrollBar -> IO Int Source # repeatDelay :: Int -> Config (Slider ScrollBar) Source # getRepeatDelay :: Slider ScrollBar -> IO Int Source #
HasSlider (Scale a) Source #	A scale widget has a configureable slider.
Methods repeatInterval :: Int -> Config (Slider (Scale a)) Source # getRepeatInterval :: Slider (Scale a) -> IO Int Source # repeatDelay :: Int -> Config (Slider (Scale a)) Source # getRepeatDelay :: Slider (Scale a) -> IO Int Source #

data ScrollBarElem Source #

The ScrollBarElem datatype - representing the elements of the scrollbar.

Constructors

Arrow1
Trough1
ScrollBarSlider
Trough2
Arrow2

Instances

Enum ScrollBarElem Source #
Methods succ :: ScrollBarElem -> ScrollBarElem # pred :: ScrollBarElem -> ScrollBarElem # toEnum :: Int -> ScrollBarElem # fromEnum :: ScrollBarElem -> Int # enumFrom :: ScrollBarElem -> [ScrollBarElem] # enumFromThen :: ScrollBarElem -> ScrollBarElem -> [ScrollBarElem] # enumFromTo :: ScrollBarElem -> ScrollBarElem -> [ScrollBarElem] # enumFromThenTo :: ScrollBarElem -> ScrollBarElem -> ScrollBarElem -> [ScrollBarElem] #
Eq ScrollBarElem Source #
Methods (==) :: ScrollBarElem -> ScrollBarElem -> Bool # (/=) :: ScrollBarElem -> ScrollBarElem -> Bool #
Ord ScrollBarElem Source #
Methods compare :: ScrollBarElem -> ScrollBarElem -> Ordering # (<) :: ScrollBarElem -> ScrollBarElem -> Bool # (<=) :: ScrollBarElem -> ScrollBarElem -> Bool # (>) :: ScrollBarElem -> ScrollBarElem -> Bool # (>=) :: ScrollBarElem -> ScrollBarElem -> Bool # max :: ScrollBarElem -> ScrollBarElem -> ScrollBarElem # min :: ScrollBarElem -> ScrollBarElem -> ScrollBarElem #
Read ScrollBarElem Source #	Internal.
Methods readsPrec :: Int -> ReadS ScrollBarElem # readList :: ReadS [ScrollBarElem] # readPrec :: ReadPrec ScrollBarElem # readListPrec :: ReadPrec [ScrollBarElem] #
Show ScrollBarElem Source #	Internal.
Methods showsPrec :: Int -> ScrollBarElem -> ShowS # show :: ScrollBarElem -> String # showList :: [ScrollBarElem] -> ShowS #
GUIValue ScrollBarElem Source #	Internal.
Methods cdefault :: ScrollBarElem Source # toGUIValue :: ScrollBarElem -> GUIVALUE Source # maybeGUIValue :: GUIVALUE -> Maybe ScrollBarElem Source # fromGUIValue :: GUIVALUE -> ScrollBarElem Source #

activateScrollBarElem Source #

Arguments

:: ScrollBar	the concerned scrollbar.
-> ScrollBarElem	the element to activate.
-> IO ()	None.

Sets the active element (which can be arrow1, arrow2 or slider).

getActivatedElem Source #

Arguments

:: ScrollBar	the concerned scrollbar.
-> IO (Maybe ScrollBarElem)	`Just [elem]` if an element is active, otherwise `Nothing`.

Gets the active element (arrow1, arrow2 or slider).

type Fraction = Double Source #

Fractions are floating point values between 0 and 1 representing relative positions within the scrolled range.

fraction Source #

Arguments

:: ScrollBar	the concerned scrollbar.
-> Position	the conderned position.
-> IO Fraction	The fraction indicating the relative location in the through.

Returns a fraction between 0 and 1 indicating the relative location of the given position in the through.

identify Source #

Arguments

:: ScrollBar	the concerned scrollbar.
-> Position	the concerned position.
-> IO (Maybe ScrollBarElem)	`Just [elem]` if `[elem]` is under the given position, otherwise `Nothing`.

Returns the ScrollBarElem to indicate what is under the given position.

setView Source #

Arguments

:: ScrollBar	the concerned scrollbar.
-> Fraction	fraction between 0 and 1 representing the relative position of the top left of the display.
-> Fraction	fraction between 0 and 1 representing the relative position of the bottom right of the display.
-> IO ()	None.

Sets the scrollbar parameters.