Safe Haskell	None
Language	Haskell98

HTk.Widgets.Editor

Description

HTk's editor widget. A text container for editing purposes. An editor widget can contain text tags, to which you can bind events, and also embedded windows.

Synopsis

Documentation

data Editor Source #

The Editor datatpe.

Instances

Eq Editor Source #
Methods (==) :: Editor -> Editor -> Bool # (/=) :: Editor -> Editor -> Bool #
Destroyable Editor Source #	An editor widget can be destroyed.
Methods destroy :: Editor -> IO () #
Synchronized Editor Source #	You can synchronize on an editor widget.
Methods synchronize :: Editor -> IO b -> IO b #
GUIObject Editor Source #	Internal.
Methods toGUIObject :: Editor -> GUIOBJECT Source # cname :: Editor -> String Source # cset :: GUIValue a => Editor -> ConfigID -> a -> IO Editor Source # cget :: GUIValue a => Editor -> ConfigID -> IO a Source #
HasEnable Editor Source #	A editor widget is a stateful widget, it can be enabled or disabled.
Methods state :: State -> Config Editor Source # getState :: Editor -> IO State Source # disable :: Config Editor Source # enable :: Config Editor Source # isEnabled :: Editor -> IO Bool Source #
HasFont Editor Source #	You can specify the font of an editor widget.
Methods font :: FontDesignator f => f -> Config Editor Source # getFont :: Editor -> IO Font Source #
HasBorder Editor Source #	A editor widget has a configureable border.
Methods borderwidth :: Distance -> Config Editor Source # getBorderwidth :: Editor -> IO Distance Source # relief :: Relief -> Config Editor Source # getRelief :: Editor -> IO Relief Source #
HasSize Editor Source #	You can specify the size of an editor widget.
Methods width :: Distance -> Config Editor Source # getWidth :: Editor -> IO Distance Source # height :: Distance -> Config Editor Source # getHeight :: Editor -> IO Distance Source # size :: Size -> Config Editor Source # getSize :: Editor -> IO Size Source #
HasColour Editor Source #	An editor widget has a foreground and background colour.
Methods legalColourID :: Editor -> ConfigID -> Bool Source # setColour :: Editor -> ConfigID -> Colour -> IO Editor Source # getColour :: Editor -> ConfigID -> IO Colour Source #
HasTooltip Editor Source #	An editor widget can have a tooltip.
Methods tooltip :: String -> Editor -> IO Editor Source # destroyTooltip :: Editor -> IO () Source #
Widget Editor Source #	An editor widget has standard widget properties (concerning focus, cursor).
Methods cursor :: CursorDesignator ch => ch -> Config Editor Source # getCursor :: Editor -> IO Cursor Source # takeFocus :: Bool -> Config Editor Source # getTakeFocus :: Editor -> IO Bool Source #
Container Editor Source #	An editor is also a container for widgets, because it can contain widgets in embedded windows.

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 #
HasSelection Editor Source #	You can select text inside an editor widget.
Methods clearSelection :: Editor -> IO () Source #
HasXSelection Editor Source #	An editor widget has an X selection.
Methods exportSelection :: Bool -> Config Editor Source # getExportSelection :: Editor -> IO Bool Source #
HasInsertionCursor Editor Source #	An editor widget has an insertion cursor.

HasLineSpacing Editor Source #	You can adjust the line spacing of an editor widget.
Methods spaceAbove :: Distance -> Config Editor Source # getSpaceAbove :: Editor -> IO Distance Source # spaceWrap :: Distance -> Config Editor Source # getSpaceWrap :: Editor -> IO Distance Source # spaceBelow :: Distance -> Config Editor Source # getSpaceBelow :: Editor -> IO Distance Source #
HasTabulators Editor Source #	An editor widget has adjustable tab stops.
Methods tabs :: String -> Config Editor Source # getTabs :: Editor -> IO String Source #
HasMarkupText Editor Source #	An editor widget is a container for markup text.
Methods new :: [MarkupText] -> Editor -> IO Editor Source # insertAt :: [MarkupText] -> Position -> Config Editor Source # clear :: Config Editor Source #
GUIValue a => HasValue Editor a Source #	An editor widget has a value (its textual content).
Methods value :: a -> Config Editor Source # getValue :: Editor -> IO a Source #
HasIndex Editor i BaseIndex => HasBBox Editor i Source #	You can find out the bounding box of characters inside an editor widget.
Methods bbox :: Editor -> i -> IO (Maybe (Distance, Distance, Distance, Distance)) Source #
HasIndex Editor i BaseIndex => HasSelectionIndex Editor i Source #	An editor widget's characters are selectable.
Methods selection :: i -> Config Editor Source # isSelected :: Editor -> i -> IO Bool Source #
HasIndex Editor i BaseIndex => HasInsertionCursorIndexSet Editor i Source #	The insertion cursor of an editor widget can be set by a base index.
Methods insertionCursor :: i -> Config Editor Source #
(HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => HasSelectionIndexRange Editor i1 i2 Source #	You can select a text range inside an editor widget.
Methods selectionRange :: i1 -> i2 -> Config Editor 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 (Distance, Distance) Source #	Internal.
Methods getBaseIndex :: Editor -> i -> IO (Distance, Distance) Source #
HasSelectionBaseIndexRange Editor (Distance, Distance) Source #	You can select a text range inside an editor widget.
Methods getSelectionStart :: Editor -> IO (Maybe (Distance, Distance)) Source # getSelectionEnd :: Editor -> IO (Maybe (Distance, Distance)) Source # getSelectionRange :: Editor -> IO (Maybe ((Distance, Distance), (Distance, Distance))) Source #
HasSelectionBaseIndex Editor ((Distance, Distance), (Distance, Distance)) Source #	You can select a text range inside an editor widget.
Methods getSelection :: Editor -> IO (Maybe ((Distance, Distance), (Distance, Distance))) Source #
HasInsertionCursorIndexGet Editor (Distance, Distance) Source #	You can get the position of the insertion cursor of an editor widget.
Methods getInsertionCursor :: Editor -> 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 #

newEditor Source #

Arguments

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

Constructs a new editor widget and returns it as a value.

deleteText Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	the concerned index.
-> IO ()	None.

Deletes the character at the specified index.

deleteTextRange Source #

Arguments

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex)
=> Editor	the start index.
-> i1	the end index.
-> i2
-> IO ()	None.

Deletes the text in the specified range.

getTextRange Source #

Arguments

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex)
=> Editor	the concerned editor widget.
-> i1	the start index.
-> i2	the end index.
-> IO String	The editor's text in the specified range.

Gets the text in the specified range.

insertText Source #

Arguments

:: (HasIndex Editor i BaseIndex, GUIValue a)
=> Editor	the concerned editor widget.
-> i	the index to insert the text.
-> a	the text to insert.
-> IO ()	None.

Inserts the given text at the specified index.

insertNewline Source #

Arguments

:: Editor	the concerned editor widget.
-> IO ()	None.

Inserts a newline character at the end of the editor widget.

getTextLine Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	an index in the requested text line.
-> IO String	The requested line of text.

Gets a text line from an editor widget.

appendText Source #

Arguments

:: Editor	the concerned editor widget.
-> String	the text to append.
-> IO ()	None.

Appends text at the end of the editor widget.

getIndexPosition Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	the concerned index.
-> IO Position	The requested position.

Returns the position on the text widget for a given index.

compareIndices Source #

Arguments

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex)
=> Editor	the concerned editor widget.
-> String	an operation given as a string
-> i1	the first index.
-> i2	the second index.
-> IO Bool	`True` or `False`, depending on the given operation.

Compares two indizes.

writeTextToFile Source #

Arguments

:: Editor	the concerned editor widget.
-> FilePath	the name of the file.
-> IO ()	None.

Writes the contained text to a file.

readTextFromFile Source #

Arguments

:: Editor	the concerned editor widget.
-> FilePath	the name of the file.
-> IO ()	None.

Reads a text from a file and inserts it into the editor pane.

class GUIObject w => HasTabulators w where Source #

Widgets with adjustable tab stops instantiate the class HasTabulators.

Methods

tabs :: String -> Config w Source #

getTabs :: w -> IO String Source #

Instances

HasTabulators Editor Source #	An editor widget has adjustable tab stops.
Methods tabs :: String -> Config Editor Source # getTabs :: Editor -> IO String Source #
HasTabulators TextTag Source #	A text tag has adjustable tab stops.
Methods tabs :: String -> Config TextTag Source # getTabs :: TextTag -> IO String Source #

class GUIObject w => HasLineSpacing w where Source #

Widgets with an adjustable line spacing instantiate the class HasLineSpacing.

Methods

spaceAbove :: Distance -> Config w Source #

getSpaceAbove :: w -> IO Distance Source #

spaceWrap :: Distance -> Config w Source #

getSpaceWrap :: w -> IO Distance Source #

spaceBelow :: Distance -> Config w Source #

getSpaceBelow :: w -> IO Distance Source #

Instances

HasLineSpacing Editor Source #	You can adjust the line spacing of an editor widget.
Methods spaceAbove :: Distance -> Config Editor Source # getSpaceAbove :: Editor -> IO Distance Source # spaceWrap :: Distance -> Config Editor Source # getSpaceWrap :: Editor -> IO Distance Source # spaceBelow :: Distance -> Config Editor Source # getSpaceBelow :: Editor -> IO Distance Source #
HasLineSpacing TextTag Source #	A text tag has a configureable line spacing.
Methods spaceAbove :: Distance -> Config TextTag Source # getSpaceAbove :: TextTag -> IO Distance Source # spaceWrap :: Distance -> Config TextTag Source # getSpaceWrap :: TextTag -> IO Distance Source # spaceBelow :: Distance -> Config TextTag Source # getSpaceBelow :: TextTag -> IO Distance Source #

adjustViewTo Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	the index to adjust the view to.
-> IO ()	None.

Adjusts the view so that the character at the specified position is visible.

scanMark Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	the concerned index.
-> IO ()	None.

Anchor a scrolling operation.

scanDragTo Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> i	the concerned index.
-> IO ()	None.

Scroll based on a new position.

data SearchDirection Source #

The SearchDirection datatype.

Constructors

Forward
Backward

Instances

Enum SearchDirection Source #
Methods succ :: SearchDirection -> SearchDirection # pred :: SearchDirection -> SearchDirection # toEnum :: Int -> SearchDirection # fromEnum :: SearchDirection -> Int # enumFrom :: SearchDirection -> [SearchDirection] # enumFromThen :: SearchDirection -> SearchDirection -> [SearchDirection] # enumFromTo :: SearchDirection -> SearchDirection -> [SearchDirection] # enumFromThenTo :: SearchDirection -> SearchDirection -> SearchDirection -> [SearchDirection] #
Eq SearchDirection Source #
Methods (==) :: SearchDirection -> SearchDirection -> Bool # (/=) :: SearchDirection -> SearchDirection -> Bool #
Ord SearchDirection Source #
Methods compare :: SearchDirection -> SearchDirection -> Ordering # (<) :: SearchDirection -> SearchDirection -> Bool # (<=) :: SearchDirection -> SearchDirection -> Bool # (>) :: SearchDirection -> SearchDirection -> Bool # (>=) :: SearchDirection -> SearchDirection -> Bool # max :: SearchDirection -> SearchDirection -> SearchDirection # min :: SearchDirection -> SearchDirection -> SearchDirection #
Show SearchDirection Source #	Internal.
Methods showsPrec :: Int -> SearchDirection -> ShowS # show :: SearchDirection -> String # showList :: [SearchDirection] -> ShowS #

data SearchMode Source #

The SearchMode datatype.

Constructors

Exact
Nocase

Instances

Enum SearchMode Source #
Methods succ :: SearchMode -> SearchMode # pred :: SearchMode -> SearchMode # toEnum :: Int -> SearchMode # fromEnum :: SearchMode -> Int # enumFrom :: SearchMode -> [SearchMode] # enumFromThen :: SearchMode -> SearchMode -> [SearchMode] # enumFromTo :: SearchMode -> SearchMode -> [SearchMode] # enumFromThenTo :: SearchMode -> SearchMode -> SearchMode -> [SearchMode] #
Eq SearchMode Source #
Methods (==) :: SearchMode -> SearchMode -> Bool # (/=) :: SearchMode -> SearchMode -> Bool #
Ord SearchMode Source #
Methods compare :: SearchMode -> SearchMode -> Ordering # (<) :: SearchMode -> SearchMode -> Bool # (<=) :: SearchMode -> SearchMode -> Bool # (>) :: SearchMode -> SearchMode -> Bool # (>=) :: SearchMode -> SearchMode -> Bool # max :: SearchMode -> SearchMode -> SearchMode # min :: SearchMode -> SearchMode -> SearchMode #
Show SearchMode Source #	Internal.
Methods showsPrec :: Int -> SearchMode -> ShowS # show :: SearchMode -> String # showList :: [SearchMode] -> ShowS #

data SearchSwitch Source #

The SearchSwitch datatype.

Constructors

SearchSwitch
Fields searchdirection :: SearchDirection searchmode :: SearchMode rexexp :: Bool

Instances

Show SearchSwitch Source #	Internal.
Methods showsPrec :: Int -> SearchSwitch -> ShowS # show :: SearchSwitch -> String # showList :: [SearchSwitch] -> ShowS #

search Source #

Arguments

:: HasIndex Editor i BaseIndex
=> Editor	the concerned editor widget.
-> SearchSwitch	the search switch.
-> String	the searched text or regular expression.
-> i	the start index.
-> IO (Maybe BaseIndex)	The index of the first match (if successful).

Searches for text inside an editor widget.

newtype IndexModifiers Source #

The IndexModifiers datatype.

Constructors

IndexModifiers [IndexModifier]

Instances

Show IndexModifiers Source #	Internal.
Methods showsPrec :: Int -> IndexModifiers -> ShowS # show :: IndexModifiers -> String # showList :: [IndexModifiers] -> ShowS #

data IndexModifier Source #

The IndexModifier datatype.

Constructors

ForwardChars Int
BackwardChars Int
ForwardLines Int
BackwardLines Int
LineStart
LineEnd
WordStart
WordEnd

Instances

Show IndexModifier Source #	Internal.
Methods showsPrec :: Int -> IndexModifier -> ShowS # show :: IndexModifier -> String # showList :: [IndexModifier] -> ShowS #
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 #

data WrapMode Source #

The WrapMode datatype.

Constructors

NoWrap
CharWrap
WordWrap

Instances

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

wrap :: WrapMode -> Config Editor Source #

Sets the editor's wrap mode.

getWrapMode :: Editor -> IO WrapMode Source #

Gets the editor's wrap mode.