HTk.Textitems.TextTag

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

Documentation

data TextTag

The TextTag datatype.

Instances

Eq TextTag

Internal.

Destroyable TextTag

A text tag can be destroyed.

Synchronized TextTag

You can synchronize on a text tag object.

GUIObject TextTag

Internal.

HasJustify TextTag

A text tag has a configureable text justification.

HasFont TextTag

A text tag has a configureable font.

HasBorder TextTag

A text tag has a configureable border.

HasColour TextTag

A text tag has a configureable foregroud and background colour.

HasLineSpacing TextTag

A text tag has a configureable line spacing.

HasTabulators TextTag

A text tag has adjustable tab stops.

HasIndex Editor (TextTag, Last) BaseIndex

Internal.

HasIndex Editor (TextTag, First) BaseIndex

Internal.

createTextTag

Arguments

:: (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

Arguments

:: (HasIndex Editor i1 BaseIndex, HasIndex Editor i2 BaseIndex)

=> TextTag

the concerned text tag.

-> i1

the start index.

-> i2

the end index.

-> IO ()

None.

Adds the specified text range to a text tag.

lowerTextTag

Arguments

:: TextTag

the concerned text tag.

-> IO ()

None.

Lowers the text tag.

raiseTextTag

Arguments

:: TextTag

the concerned text tag.

-> IO ()

None.

Raises the given text tag.

removeTextTag

Arguments

:: (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.