| ||||||||
| ||||||||
| ||||||||
Description | ||||||||
A tag that can be applied to text in a TextBuffer | ||||||||
Synopsis | ||||||||
Detail | ||||||||
You may wish to begin by reading the text widget conceptual overview which gives an overview of all the objects and data types related to the text widget and how they work together. Tags should be in the TextTagTable for a given Graphics.UI.Gtk.Multiline.TextBuffer.TextBuffer before using them with that buffer. Graphics.UI.Gtk.Multiline.TextBuffer.textBufferCreateTag is the best way to create tags. The textTagInvisible property was not implemented for Gtk+ 2.0; it's planned to be implemented in future releases. | ||||||||
Class Hierarchy | ||||||||
| GObject | +----TextTag | ||||||||
Types | ||||||||
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| ||||||||
| ||||||||
Constructors | ||||||||
| ||||||||
Creates a TextTag.
| ||||||||
Methods | ||||||||
| ||||||||
Sets the priority of a TextTag. Valid priorities are start at 0 and go to one less than Graphics.UI.Gtk.Multiline.TextTagTable.textTagTableGetSize. Each tag in a table has a unique priority; setting the priority of one tag shifts the priorities of all the other tags in the table to maintain a unique priority for each tag. Higher priority tags "win" if two tags both set the same text attribute. When adding a tag to a tag table, it will be assigned the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with Graphics.UI.Gtk.Multiline.TextBuffer.textBufferCreateTag, which adds the tag to the buffer's table automatically. | ||||||||
| ||||||||
Get the tag priority. | ||||||||
| ||||||||
| ||||||||
| ||||||||
Creates a TextAttributes, which describes a set of properties on some text. | ||||||||
| ||||||||
| ||||||||
| ||||||||
Copies the values from src to dest so that dest has the same values as src. | ||||||||
| ||||||||
This function is use internal for transform TextAttributes. Don't expoert this function. | ||||||||
Attributes | ||||||||
| ||||||||
Name used to refer to the text tag. Nothing for anonymous tags. Default value: Nothing | ||||||||
| ||||||||
Background color as a string. Default value: "" | ||||||||
| ||||||||
Whether this tag affects the background color. Default value: False | ||||||||
| ||||||||
Whether the background color fills the entire line height or only the height of the tagged characters. Default value: False | ||||||||
| ||||||||
Whether this tag affects background height. Default value: False | ||||||||
| ||||||||
Background color as a (possibly unallocated) GdkColor. | ||||||||
| ||||||||
Bitmap to use as a mask when drawing the text background. | ||||||||
| ||||||||
Whether this tag affects the background stipple. Default value: False | ||||||||
| ||||||||
Foreground color as a string. Default value: "" | ||||||||
| ||||||||
Whether this tag affects the foreground color. Default value: False | ||||||||
| ||||||||
Foreground color as a (possibly unallocated) GdkColor. | ||||||||
| ||||||||
Bitmap to use as a mask when drawing the text foreground. | ||||||||
| ||||||||
Whether this tag affects the foreground stipple. Default value: False | ||||||||
| ||||||||
Text direction, e.g. right-to-left or left-to-right. Default value: TextDirLtr | ||||||||
| ||||||||
Whether the text can be modified by the user. Default value: True | ||||||||
| ||||||||
Whether this tag affects text editability. Default value: False | ||||||||
| ||||||||
Font description as a string, e.g. "Sans Italic 12". Default value: "" | ||||||||
| ||||||||
Font description as a FontDescription struct. | ||||||||
| ||||||||
Name of the font family, e.g. Sans, Helvetica, Times, Monospace. Default value: "" | ||||||||
| ||||||||
Whether this tag affects the font family. Default value: False | ||||||||
| ||||||||
Font style as a Style, e.g. StyleItalic. Default value: StyleNormal | ||||||||
| ||||||||
Whether this tag affects the font style. Default value: False | ||||||||
| ||||||||
Custom tabs for this text. textTagTabs :: TextTagClass self => Attr self TabArray Whether this tag affects tabs. Default value: False | ||||||||
| ||||||||
Font variant as a Variant, e.g. VariantSmallCaps. Default value: VariantNormal | ||||||||
| ||||||||
Whether this tag affects the font variant. Default value: False | ||||||||
| ||||||||
Font weight as an integer, see predefined values in Graphics.Rendering.Pango.Enums.Weight; for example, Graphics.Rendering.Pango.Enums.WeightBold. Allowed values: >= 0 Default value: 400 | ||||||||
| ||||||||
Whether this tag affects the font weight. Default value: False | ||||||||
| ||||||||
Font stretch as a Stretch, e.g. StretchCondensed. Default value: StretchNormal | ||||||||
| ||||||||
Whether this tag affects the font stretch. | ||||||||
| ||||||||
Font size in Pango units. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the font size. Default value: False | ||||||||
| ||||||||
Font size as a scale factor relative to the default font size. This properly adapts to theme changes etc. so is recommended. Allowed values: >= 0 Default value: 1 | ||||||||
| ||||||||
Whether this tag scales the font size by a factor. Default value: False | ||||||||
| ||||||||
Font size in points. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Left, right, or center justification. Default value: JustifyLeft | ||||||||
| ||||||||
Whether this tag affects paragraph justification. Default value: False | ||||||||
| ||||||||
The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If not set, an appropriate default will be used. Default value: "" | ||||||||
| ||||||||
Whether this tag affects the language the text is rendered as. Default value: False | ||||||||
| ||||||||
Width of the left margin in pixels. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the left margin. Default value: False | ||||||||
| ||||||||
Width of the right margin in pixels. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the right margin. Default value: False | ||||||||
| ||||||||
Amount to indent the paragraph, in pixels. Default value: 0 | ||||||||
| ||||||||
Whether this tag affects indentation. Default value: False | ||||||||
| ||||||||
Offset of text above the baseline (below the baseline if rise is negative) in pixels. Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the rise. | ||||||||
| ||||||||
Pixels of blank space above paragraphs. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the number of pixels above lines. Default value: False | ||||||||
| ||||||||
Pixels of blank space below paragraphs. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the number of pixels below lines. Default value: False | ||||||||
| ||||||||
Pixels of blank space between wrapped lines in a paragraph. Allowed values: >= 0 Default value: 0 | ||||||||
| ||||||||
Whether this tag affects the number of pixels between wrapped lines. Default value: False | ||||||||
| ||||||||
Whether to strike through the text. Default value: False | ||||||||
| ||||||||
Whether this tag affects strikethrough. Default value: False | ||||||||
| ||||||||
Style of underline for this text. Default value: UnderlineNone | ||||||||
| ||||||||
Whether this tag affects underlining. Default value: False | ||||||||
| ||||||||
Whether to wrap lines never, at word boundaries, or at character boundaries. Default value: WrapNone | ||||||||
| ||||||||
Whether this tag affects line wrap mode. Default value: False | ||||||||
| ||||||||
Whether this text is hidden. Note that there may still be problems with the support for invisible text, in particular when navigating programmatically inside a buffer containing invisible segments. Default value: False | ||||||||
| ||||||||
Whether this tag affects text visibility. Default value: False | ||||||||
| ||||||||
The paragraph background color as a string. Default value: "" | ||||||||
| ||||||||
Whether this tag affects the paragraph background color. Default value: False | ||||||||
| ||||||||
The paragraph background color as a as a (possibly unallocated) Color. | ||||||||
| ||||||||
'priority' property. See textTagGetPriority and textTagSetPriority | ||||||||
Signals | ||||||||
| ||||||||
An event has occurred that affects the given tag.
| ||||||||
Deprecated | ||||||||
| ||||||||
An event has occurred that affects the given tag.
| ||||||||
Produced by Haddock version 2.6.1 |