Safe Haskell	None
Language	Haskell98

HTk.Components.Index

Description

This module exports basic types and classes on index positions, e.g. inside an editor or entry widget.

Synopsis

Documentation

data EndOfText Source #

The EndOfText datatype - a handle indexing the last position inside the concerned widget.

Constructors

EndOfText

Instances

Eq EndOfText Source #
Methods (==) :: EndOfText -> EndOfText -> Bool # (/=) :: EndOfText -> EndOfText -> Bool #
Read EndOfText Source #	Internal.
Methods readsPrec :: Int -> ReadS EndOfText # readList :: ReadS [EndOfText] # readPrec :: ReadPrec EndOfText # readListPrec :: ReadPrec [EndOfText] #
Show EndOfText Source #	Internal.
Methods showsPrec :: Int -> EndOfText -> ShowS # show :: EndOfText -> String # showList :: [EndOfText] -> ShowS #
GUIValue EndOfText Source #	Internal.
Methods cdefault :: EndOfText Source # toGUIValue :: EndOfText -> GUIVALUE Source # maybeGUIValue :: GUIVALUE -> Maybe EndOfText Source # fromGUIValue :: GUIVALUE -> EndOfText Source #
HasIndex Editor EndOfText BaseIndex Source #	The `EndOfText` index is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> EndOfText -> IO BaseIndex 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 (Entry a) EndOfText BaseIndex Source #	The `EndOfText` index is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> EndOfText -> IO BaseIndex Source #

class HasIndex w i b where Source #

Internal.

Minimal complete definition

getBaseIndex

Methods

getBaseIndex :: w -> i -> IO b Source #

Instances

HasIndex Editor BaseIndex BaseIndex Source #	A base index is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> BaseIndex -> IO BaseIndex Source #
HasIndex Editor Pixels BaseIndex Source #	A position in pixels is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> Pixels -> IO BaseIndex Source #
HasIndex Editor EndOfText BaseIndex Source #	The `EndOfText` index is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> EndOfText -> IO BaseIndex Source #
HasIndex Editor EmbeddedTextWin BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> EmbeddedTextWin -> IO BaseIndex Source #
HasIndex Editor Mark BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> Mark -> IO BaseIndex Source #
HasIndex Editor i BaseIndex => HasIndex Editor i (Distance, Distance) Source #	Internal.
Methods getBaseIndex :: Editor -> i -> IO (Distance, Distance) Source #
HasIndex Editor i BaseIndex => HasIndex Editor (i, IndexModifier) BaseIndex Source #	A pair of a valid index and an index modifier is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (i, IndexModifier) -> IO BaseIndex Source #
HasIndex Editor i BaseIndex => HasIndex Editor (i, [IndexModifier]) BaseIndex Source #	A pair of a valid index and a list of index modifiers is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (i, [IndexModifier]) -> IO BaseIndex Source #
HasIndex Editor (Distance, Distance) BaseIndex Source #	A pair of line and character is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (Distance, Distance) -> IO BaseIndex Source #
HasIndex Editor (TextTag, Last) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, Last) -> IO BaseIndex Source #
HasIndex Editor (TextTag, First) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, First) -> IO BaseIndex 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 #
HasIndex (Entry a) i BaseIndex => HasIndex (Entry a) i Int Source #	Internal.
Methods getBaseIndex :: Entry a -> i -> IO Int Source #
HasIndex (Entry a) XCoord BaseIndex Source #	An `XCoord` is a valid index for an entry widget.
Methods getBaseIndex :: Entry a -> XCoord -> IO BaseIndex Source #
HasIndex (Entry a) EndOfText BaseIndex Source #	The `EndOfText` index is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> EndOfText -> IO BaseIndex Source #
HasIndex (Entry a) BaseIndex BaseIndex Source #	A base index is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> BaseIndex -> IO BaseIndex Source #
HasIndex (Entry a) Int BaseIndex Source #	An integer value is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> Int -> IO BaseIndex Source #
(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 #
HasIndex (Entry a) (ICursor (Entry a)) BaseIndex Source #	The entries insertion cursor is a valid index for an entry widget.
Methods getBaseIndex :: Entry a -> ICursor (Entry a) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), Last) BaseIndex Source #	The selection end is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), Last) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), First) BaseIndex Source #	The selection start is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), First) -> IO BaseIndex Source #

data BaseIndex Source #

The BaseIndex datatype - an index handle specified by an index number, an index position (line, char) or an index text (see text marks).

Constructors

IndexNo Int	entries, listboxes
IndexPos Position	text widgets
IndexText String	listboxes, "end" etc.

Instances

Read BaseIndex Source #	Internal.
Methods readsPrec :: Int -> ReadS BaseIndex # readList :: ReadS [BaseIndex] # readPrec :: ReadPrec BaseIndex # readListPrec :: ReadPrec [BaseIndex] #
Show BaseIndex Source #	Internal.
Methods showsPrec :: Int -> BaseIndex -> ShowS # show :: BaseIndex -> String # showList :: [BaseIndex] -> ShowS #
GUIValue BaseIndex Source #	Internal.
Methods cdefault :: BaseIndex Source # toGUIValue :: BaseIndex -> GUIVALUE Source # maybeGUIValue :: GUIVALUE -> Maybe BaseIndex Source # fromGUIValue :: GUIVALUE -> BaseIndex Source #
HasIndex Editor BaseIndex BaseIndex Source #	A base index is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> BaseIndex -> IO BaseIndex Source #
HasIndex Editor Pixels BaseIndex Source #	A position in pixels is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> Pixels -> IO BaseIndex Source #
HasIndex Editor EndOfText BaseIndex Source #	The `EndOfText` index is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> EndOfText -> IO BaseIndex Source #
HasIndex Editor EmbeddedTextWin BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> EmbeddedTextWin -> IO BaseIndex Source #
HasIndex Editor Mark BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> Mark -> IO BaseIndex Source #
HasIndex Editor i BaseIndex => HasIndex Editor (i, IndexModifier) BaseIndex Source #	A pair of a valid index and an index modifier is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (i, IndexModifier) -> IO BaseIndex Source #
HasIndex Editor i BaseIndex => HasIndex Editor (i, [IndexModifier]) BaseIndex Source #	A pair of a valid index and a list of index modifiers is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (i, [IndexModifier]) -> IO BaseIndex Source #
HasIndex Editor (Distance, Distance) BaseIndex Source #	A pair of line and character is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> (Distance, Distance) -> IO BaseIndex Source #
HasIndex Editor (TextTag, Last) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, Last) -> IO BaseIndex Source #
HasIndex Editor (TextTag, First) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, First) -> IO BaseIndex Source #
HasIndex (Entry a) XCoord BaseIndex Source #	An `XCoord` is a valid index for an entry widget.
Methods getBaseIndex :: Entry a -> XCoord -> IO BaseIndex Source #
HasIndex (Entry a) EndOfText BaseIndex Source #	The `EndOfText` index is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> EndOfText -> IO BaseIndex Source #
HasIndex (Entry a) BaseIndex BaseIndex Source #	A base index is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> BaseIndex -> IO BaseIndex Source #
HasIndex (Entry a) Int BaseIndex Source #	An integer value is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> Int -> IO BaseIndex Source #
HasIndex (Entry a) (ICursor (Entry a)) BaseIndex Source #	The entries insertion cursor is a valid index for an entry widget.
Methods getBaseIndex :: Entry a -> ICursor (Entry a) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), Last) BaseIndex Source #	The selection end is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), Last) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), First) BaseIndex Source #	The selection start is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), First) -> IO BaseIndex Source #

data Pixels Source #

The Pixels datatype - a handle indexing a position inside a widget with its coordinates.

Constructors

Pixels Distance Distance

Instances

Show Pixels Source #	Internal.
Methods showsPrec :: Int -> Pixels -> ShowS # show :: Pixels -> String # showList :: [Pixels] -> ShowS #
HasIndex Editor Pixels BaseIndex Source #	A position in pixels is a valid index for an editor widget.
Methods getBaseIndex :: Editor -> Pixels -> IO BaseIndex 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 #

data First Source #

The First datatype - a handle indexing the first entry e.g. inside a listbox.

Constructors

First

Instances

Show First Source #	Internal.
Methods showsPrec :: Int -> First -> ShowS # show :: First -> String # showList :: [First] -> ShowS #
HasIndex Editor (TextTag, First) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, First) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), First) BaseIndex Source #	The selection start is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), First) -> IO BaseIndex Source #

data Last Source #

The Last datatype - a handle indexing the last entry e.g. inside a listbox.

Constructors

Last

Instances

Show Last Source #	Internal.
Methods showsPrec :: Int -> Last -> ShowS # show :: Last -> String # showList :: [Last] -> ShowS #
HasIndex Editor (TextTag, Last) BaseIndex Source #	Internal.
Methods getBaseIndex :: Editor -> (TextTag, Last) -> IO BaseIndex Source #
HasIndex (Entry a) (Selection (Entry a), Last) BaseIndex Source #	The selection end is a valid index position for an entry widget.
Methods getBaseIndex :: Entry a -> (Selection (Entry a), Last) -> IO BaseIndex Source #