HTk.Widgets.ListBox

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

Documentation

data ListBox a

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

Instances

Eq (ListBox a)

Methods

(==) :: ListBox a -> ListBox a -> Bool

(/=) :: ListBox a -> ListBox a -> Bool

Destroyable (ListBox a)

A listbox widget can be destroyed.

Methods

destroy :: ListBox a -> IO ()

Synchronized (ListBox a)

You can synchronize on a listbox object (in JAVA style).

Methods

synchronize :: ListBox a -> IO b -> IO b

GUIObject (ListBox a)

Internal.

Methods

toGUIObject :: ListBox a -> GUIOBJECT

cname :: ListBox a -> String

cset :: GUIValue a => ListBox a -> ConfigID -> a -> IO (ListBox a)

cget :: GUIValue a => ListBox a -> ConfigID -> IO a

HasEnable (ListBox a)

A listbox is a stateful widget - it can be enabled or disabled.

Methods

state :: State -> Config (ListBox a)

getState :: ListBox a -> IO State

disable :: Config (ListBox a)

enable :: Config (ListBox a)

isEnabled :: ListBox a -> IO Bool

HasGrid (ListBox a)

Methods

setgrid :: Toggle -> Config (ListBox a)

getGrid :: ListBox a -> IO Toggle

HasFont (ListBox a)

You can specify the font of a listbox.

Methods

font :: FontDesignator f => f -> Config (ListBox a)

getFont :: ListBox a -> IO Font

HasBorder (ListBox a)

A listbox widget has a configureable border.

Methods

borderwidth :: Distance -> Config (ListBox a)

getBorderwidth :: ListBox a -> IO Distance

relief :: Relief -> Config (ListBox a)

getRelief :: ListBox a -> IO Relief

HasSize (ListBox a)

You can specify the size of a listbox.

Methods

width :: Distance -> Config (ListBox a)

getWidth :: ListBox a -> IO Distance

height :: Distance -> Config (ListBox a)

getHeight :: ListBox a -> IO Distance

size :: Size -> Config (ListBox a)

getSize :: ListBox a -> IO Size

HasColour (ListBox a)

A listbox widget has a foreground and background colour.

Methods

legalColourID :: ListBox a -> ConfigID -> Bool

setColour :: ListBox a -> ConfigID -> Colour -> IO (ListBox a)

getColour :: ListBox a -> ConfigID -> IO Colour

HasTooltip (ListBox a)

A listbox can have a tooltip (only displayed if you are using tixwish).

Methods

tooltip :: String -> ListBox a -> IO (ListBox a)

destroyTooltip :: ListBox a -> IO ()

Widget (ListBox a)

A listbox widget has standard widget properties (concerning focus, cursor).

Methods

cursor :: CursorDesignator ch => ch -> Config (ListBox a)

getCursor :: ListBox a -> IO Cursor

takeFocus :: Bool -> Config (ListBox a)

getTakeFocus :: ListBox a -> IO Bool

GUIValue a => CanBeSubwidget (ListBox a)

Methods

createAsSubwidget :: GUIOBJECT -> IO (ListBox a)

HasScroller (ListBox a)

A listbox is a scrollable widget.

Methods

isWfOrientation :: ListBox a -> Orientation -> Bool

scrollbar :: Orientation -> ScrollBar -> Config (ListBox a)

moveto :: Orientation -> ListBox a -> Fraction -> IO ()

scroll :: Orientation -> ListBox a -> Int -> ScrollUnit -> IO ()

view :: Orientation -> ListBox a -> IO (Fraction, Fraction)

HasSelection (ListBox a)

You can select entries inside a listbox widget.

Methods

clearSelection :: ListBox a -> IO ()

HasXSelection (ListBox a)

A listbox widget has an X selection.

Methods

exportSelection :: Bool -> Config (ListBox a)

getExportSelection :: ListBox a -> IO Bool

HasIndex (ListBox a) i Int => HasBBox (ListBox a) i

You can find out the bounding box of a list box element.

Methods

bbox :: ListBox a -> i -> IO (Maybe (Distance, Distance, Distance, Distance))

HasSelectionBaseIndexRange (ListBox a) Int

You can select a range of entries inside a listbox widget.

Methods

getSelectionStart :: ListBox a -> IO (Maybe Int)

getSelectionEnd :: ListBox a -> IO (Maybe Int)

getSelectionRange :: ListBox a -> IO (Maybe (Int, Int))

HasIndex (ListBox a) i Int => HasSelectionIndex (ListBox a) i

A listbox'es entries are selectable.

Methods

selection :: i -> Config (ListBox a)

isSelected :: ListBox a -> i -> IO Bool

(HasIndex (ListBox a) i1 Int, HasIndex (ListBox a) i2 Int) => HasSelectionIndexRange (ListBox a) i1 i2

You can select a range of elements inside a listbox widget.

Methods

selectionRange :: i1 -> i2 -> Config (ListBox a)

HasIndex (ListBox a) Pixels Int

A position in pixels is a valid index position inside an editor widget.

Methods

getBaseIndex :: ListBox a -> Pixels -> IO Int

HasIndex (ListBox a) EndOfText Int

The EndOfText index is a valid index position inside a listbox widget.

Methods

getBaseIndex :: ListBox a -> EndOfText -> IO Int

HasIndex (ListBox a) Int Int

An integer value is a valid index position inside a listbox widget.

Methods

getBaseIndex :: ListBox a -> Int -> IO Int

(Eq a, GUIValue a, GUIValue [a]) => HasIndex (ListBox a) Int (ListBoxElem a)

Internal.

Methods

getBaseIndex :: ListBox a -> Int -> IO (ListBoxElem a)

(GUIValue a, GUIValue [a]) => HasValue (ListBox a) [a]

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)

getValue :: ListBox a -> IO [a]

HasSelectionBaseIndex (ListBox a) [Int]

You can select a range of elements inside a listbox widget.

Methods

getSelection :: ListBox a -> IO (Maybe [Int])

(Eq a, GUIValue a) => HasIndex (ListBox [a]) (ListBoxElem a) Int

A listbox element is a valid index position inside an editor widget.

Methods

getBaseIndex :: ListBox [a] -> ListBoxElem a -> IO Int

newListBox

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

Constructors

Single

Browse

Multiple

Extended

Instances

Enum SelectMode

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

Methods

(==) :: SelectMode -> SelectMode -> Bool

(/=) :: SelectMode -> SelectMode -> Bool

Ord SelectMode

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

Methods

readsPrec :: Int -> ReadS SelectMode

readList :: ReadS [SelectMode]

readPrec :: ReadPrec SelectMode

readListPrec :: ReadPrec [SelectMode]

Show SelectMode

Methods

showsPrec :: Int -> SelectMode -> ShowS

show :: SelectMode -> String

showList :: [SelectMode] -> ShowS

GUIValue SelectMode

Methods

cdefault :: SelectMode

toGUIValue :: SelectMode -> GUIVALUE

maybeGUIValue :: GUIVALUE -> Maybe SelectMode

fromGUIValue :: GUIVALUE -> SelectMode

selectMode

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

Arguments

:: GUIValue a

=> ListBox a

the concerned listbox.

-> IO SelectMode

The current select mode.

Gets the set select mode from a listbox.

activateElem

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

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

The ListBoxElem datatype.

Constructors

ListBoxElem a

Instances

Eq a => Eq (ListBoxElem a)

Methods

(==) :: ListBoxElem a -> ListBoxElem a -> Bool

(/=) :: ListBoxElem a -> ListBoxElem a -> Bool

(Eq a, GUIValue a, GUIValue [a]) => HasIndex (ListBox a) Int (ListBoxElem a)

Internal.

Methods

getBaseIndex :: ListBox a -> Int -> IO (ListBoxElem a)

(Eq a, GUIValue a) => HasIndex (ListBox [a]) (ListBoxElem a) Int

A listbox element is a valid index position inside an editor widget.

Methods

getBaseIndex :: ListBox [a] -> ListBoxElem a -> IO Int

elemNotFound :: IOError