Source code Contents Index

TextTag

Description

This module provides access to text tags inside an editor widget.

Synopsis

module Index data TextTag createTextTag :: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => Editor -> i1 -> i2 -> [Config TextTag] -> IO TextTag addTextTag :: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => TextTag -> i1 -> i2 -> IO () lowerTextTag :: TextTag -> IO () raiseTextTag :: TextTag -> IO () removeTextTag :: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => TextTag -> i1 -> i2 -> IO () lmargin1 :: Distance -> Config TextTag getLmargin1 :: TextTag -> IO Distance lmargin2 :: Distance -> Config TextTag getLmargin2 :: TextTag -> IO Distance rmargin :: Distance -> Config TextTag getRmargin :: TextTag -> IO Distance offset :: Distance -> Config TextTag getOffset :: TextTag -> IO Distance overstrike :: Toggle -> Config TextTag getOverstrike :: TextTag -> IO Toggle underlined :: Toggle -> Config TextTag getUnderlined :: TextTag -> IO Toggle bgstipple :: BitMapHandle -> Config TextTag getBgstipple :: TextTag -> IO BitMapHandle fgstipple :: BitMapHandle -> Config TextTag getFgstipple :: TextTag -> IO BitMapHandle

Documentation

module Index

data TextTag

The TextTag datatype.

createTextTag

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => Editor the concerned editor widget. -> i1 the start index. -> i2 the end index. -> [Config TextTag] the list of configuration options for this text tag. -> IO TextTag A text tag. Creates a text tag inside an editor widget and returns a handler.

addTextTag :: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => TextTag -> i1 -> i2 -> IO ()

lowerTextTag

:: TextTag the concerned text tag. -> IO () None. Lowers the text tag.

raiseTextTag

:: TextTag the concerned text tag. -> IO () None. Raises the given text tag.

removeTextTag

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex) => TextTag the concerned text tag. -> i1 the start index. -> i2 the end index. -> IO () None. Removes the specified text range from a text tag.

lmargin1 :: Distance -> Config TextTag

Sets the normal left intend for a line.

getLmargin1 :: TextTag -> IO Distance

Gets the normal left intend for a line.

lmargin2 :: Distance -> Config TextTag

Sets the intend for a part of a line that gets wrapped.

getLmargin2 :: TextTag -> IO Distance

Gets the intend for a part of a line that gets wrapped.

rmargin :: Distance -> Config TextTag

Sets the right-hand margin.

getRmargin :: TextTag -> IO Distance

Gets the right-hand margin.

offset :: Distance -> Config TextTag

Sets the baseline offset (positive for superscripts).

getOffset :: TextTag -> IO Distance

Gets the baseline offset.

overstrike :: Toggle -> Config TextTag

If True, the text is drawn with a horizontal line through it.

getOverstrike :: TextTag -> IO Toggle

Gets the current overstrike setting.

underlined :: Toggle -> Config TextTag

If True, the text is underlined.

getUnderlined :: TextTag -> IO Toggle

Gets the current underline setting.

bgstipple :: BitMapHandle -> Config TextTag

Sets a stipple pattern for the background colour.

getBgstipple :: TextTag -> IO BitMapHandle

Gets the stipple pattern for the background colour.

fgstipple :: BitMapHandle -> Config TextTag

Sets a stipple pattern for the foreground colour.

getFgstipple :: TextTag -> IO BitMapHandle

Gets the stipple pattern for the foreground colour.

Produced by Haddock version 0.3