Safe Haskell	None
Language	Haskell98

HTk.Widgets.ListBox

Description

HTk's listbox widget . A scrollable widget that displays a set of text lines with selection functionality.

Synopsis

Documentation

data ListBox a Source #

The ListBox datatype - parametrised over the type of the list elements.

Instances

Eq (ListBox a) Source #
Methods (==) :: ListBox a -> ListBox a -> Bool # (/=) :: ListBox a -> ListBox a -> Bool #
Destroyable (ListBox a) Source #	A listbox widget can be destroyed.
Methods destroy :: ListBox a -> IO () #
Synchronized (ListBox a) Source #	You can synchronize on a listbox object (in JAVA style).
Methods synchronize :: ListBox a -> IO b -> IO b #
GUIObject (ListBox a) Source #	Internal.
Methods toGUIObject :: ListBox a -> GUIOBJECT Source # cname :: ListBox a -> String Source # cset :: GUIValue a => ListBox a -> ConfigID -> a -> IO (ListBox a) Source # cget :: GUIValue a => ListBox a -> ConfigID -> IO a Source #
HasEnable (ListBox a) Source #	A listbox is a stateful widget - it can be enabled or disabled.
Methods state :: State -> Config (ListBox a) Source # getState :: ListBox a -> IO State Source # disable :: Config (ListBox a) Source # enable :: Config (ListBox a) Source # isEnabled :: ListBox a -> IO Bool Source #
HasGrid (ListBox a) Source #
Methods setgrid :: Toggle -> Config (ListBox a) Source # getGrid :: ListBox a -> IO Toggle Source #
HasFont (ListBox a) Source #	You can specify the font of a listbox.
Methods font :: FontDesignator f => f -> Config (ListBox a) Source # getFont :: ListBox a -> IO Font Source #
HasBorder (ListBox a) Source #	A listbox widget has a configureable border.
Methods borderwidth :: Distance -> Config (ListBox a) Source # getBorderwidth :: ListBox a -> IO Distance Source # relief :: Relief -> Config (ListBox a) Source # getRelief :: ListBox a -> IO Relief Source #
HasSize (ListBox a) Source #	You can specify the size of a listbox.
Methods width :: Distance -> Config (ListBox a) Source # getWidth :: ListBox a -> IO Distance Source # height :: Distance -> Config (ListBox a) Source # getHeight :: ListBox a -> IO Distance Source # size :: Size -> Config (ListBox a) Source # getSize :: ListBox a -> IO Size Source #
HasColour (ListBox a) Source #	A listbox widget has a foreground and background colour.
Methods legalColourID :: ListBox a -> ConfigID -> Bool Source # setColour :: ListBox a -> ConfigID -> Colour -> IO (ListBox a) Source # getColour :: ListBox a -> ConfigID -> IO Colour Source #
HasTooltip (ListBox a) Source #	A listbox can have a tooltip (only displayed if you are using tixwish).
Methods tooltip :: String -> ListBox a -> IO (ListBox a) Source # destroyTooltip :: ListBox a -> IO () Source #
Widget (ListBox a) Source #	A listbox widget has standard widget properties (concerning focus, cursor).
Methods cursor :: CursorDesignator ch => ch -> Config (ListBox a) Source # getCursor :: ListBox a -> IO Cursor Source # takeFocus :: Bool -> Config (ListBox a) Source # getTakeFocus :: ListBox a -> IO Bool Source #
GUIValue a => CanBeSubwidget (ListBox a) Source #
Methods createAsSubwidget :: GUIOBJECT -> IO (ListBox a) 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 #
HasSelection (ListBox a) Source #	You can select entries inside a listbox widget.
Methods clearSelection :: ListBox a -> IO () Source #
HasXSelection (ListBox a) Source #	A listbox widget has an X selection.
Methods exportSelection :: Bool -> Config (ListBox a) Source # getExportSelection :: ListBox a -> IO Bool Source #
HasIndex (ListBox a) i Int => HasBBox (ListBox a) i Source #	You can find out the bounding box of a list box element.
Methods bbox :: ListBox a -> i -> IO (Maybe (Distance, Distance, Distance, Distance)) Source #
HasSelectionBaseIndexRange (ListBox a) Int Source #	You can select a range of entries inside a listbox widget.
Methods getSelectionStart :: ListBox a -> IO (Maybe Int) Source # getSelectionEnd :: ListBox a -> IO (Maybe Int) Source # getSelectionRange :: ListBox a -> IO (Maybe (Int, Int)) Source #
HasIndex (ListBox a) i Int => HasSelectionIndex (ListBox a) i Source #	A listbox'es entries are selectable.
Methods selection :: i -> Config (ListBox a) Source # isSelected :: ListBox a -> i -> IO Bool Source #
(HasIndex (ListBox a) i1 Int, HasIndex (ListBox a) i2 Int) => HasSelectionIndexRange (ListBox a) i1 i2 Source #	You can select a range of elements inside a listbox widget.
Methods selectionRange :: i1 -> i2 -> Config (ListBox a) Source #
HasIndex (ListBox a) Pixels Int Source #	A position in pixels is a valid index position inside an editor widget.
Methods getBaseIndex :: ListBox a -> Pixels -> IO Int Source #
HasIndex (ListBox a) EndOfText Int Source #	The `EndOfText` index is a valid index position inside a listbox widget.
Methods getBaseIndex :: ListBox a -> EndOfText -> IO Int Source #
HasIndex (ListBox a) Int Int Source #	An integer value is a valid index position inside a listbox widget.
Methods getBaseIndex :: ListBox a -> Int -> IO Int Source #
(Eq a, GUIValue a, GUIValue [a]) => HasIndex (ListBox a) Int (ListBoxElem a) Source #	Internal.
Methods getBaseIndex :: ListBox a -> Int -> IO (ListBoxElem a) Source #
(GUIValue a, GUIValue [a]) => HasValue (ListBox a) [a] Source #	The value of a listbox is the list of the displayed objects (these are instances of class `GUIValue` and therefore instances of class `Show`).
Methods value :: [a] -> Config (ListBox a) Source # getValue :: ListBox a -> IO [a] Source #
HasSelectionBaseIndex (ListBox a) [Int] Source #	You can select a range of elements inside a listbox widget.
Methods getSelection :: ListBox a -> IO (Maybe [Int]) Source #
(Eq a, GUIValue a) => HasIndex (ListBox [a]) (ListBoxElem a) Int Source #	A listbox element is a valid index position inside an editor widget.
Methods getBaseIndex :: ListBox [a] -> ListBoxElem a -> IO Int Source #

newListBox Source #

Arguments

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

Constructs a new listbox widget and returns a handler.

data SelectMode Source #

Constructors

Single
Browse
Multiple
Extended

Instances

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

selectMode Source #

Arguments

:: GUIValue a
=> SelectMode	the select mode to set.
-> ListBox a	the concerned listbox.
-> IO (ListBox a)	The concerned listbox.

Sets the select mode of a listbox.

getSelectMode Source #

Arguments

:: GUIValue a
=> ListBox a	the concerned listbox.
-> IO SelectMode	The current select mode.

Gets the set select mode from a listbox.

activateElem Source #

Arguments

:: HasIndex (ListBox a) i Int
=> ListBox a	the concerned listbox.
-> i	the index of the line to activate.
-> IO ()	Nothing.

Activates the specified line.

selectionAnchor Source #

Arguments

:: HasIndex (ListBox a) i Int
=> ListBox a	the concerned listbox.
-> i	the index of the line to anchor the selection at.
-> IO ()	Nothing.

Anchors the selection at the specified line.

data Eq a => ListBoxElem a Source #

The ListBoxElem datatype.

Constructors

ListBoxElem a

Instances

Eq a => Eq (ListBoxElem a) Source #
Methods (==) :: ListBoxElem a -> ListBoxElem a -> Bool # (/=) :: ListBoxElem a -> ListBoxElem a -> Bool #
(Eq a, GUIValue a, GUIValue [a]) => HasIndex (ListBox a) Int (ListBoxElem a) Source #	Internal.
Methods getBaseIndex :: ListBox a -> Int -> IO (ListBoxElem a) Source #
(Eq a, GUIValue a) => HasIndex (ListBox [a]) (ListBoxElem a) Int Source #	A listbox element is a valid index position inside an editor widget.
Methods getBaseIndex :: ListBox [a] -> ListBoxElem a -> IO Int Source #

elemNotFound :: IOError Source #