gtk.text_tag

Module for [TextTag] class

Types 3

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 #GtkTextTagTable for a given #GtkTextBuffer before using them with that buffer.

gtk.text_buffer.TextBuffer.createTag is the best way to create tags. See “gtk3-demo” for numerous examples.

For each property of #GtkTextTag, there is a “set” property, e.g. “font-set” corresponds to “font”. These “set” properties reflect whether a property has been set or not. They are maintained by GTK+ and you should not set them independently.

Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
TextTag self() nothrowReturns `this`, for use in `with` statements.
TextTagGidBuilder builder() static nothrowGet builder for [gtk.text_tag.TextTag] Returns: New builder object
bool accumulativeMargin() @property nothrowGet `accumulativeMargin` property. Returns: Whether the margins accumulate or override each other.
void accumulativeMargin(bool propval) @property nothrowSet `accumulativeMargin` property. Params: propval = Whether the margins accumulate or override each other.
void background(string propval) @property nothrow
bool backgroundFullHeight() @property nothrow
void backgroundFullHeight(bool propval) @property nothrow
bool backgroundFullHeightSet() @property nothrow
void backgroundFullHeightSet(bool propval) @property nothrow
gdk.color.Color backgroundGdk() @property nothrowGet `backgroundGdk` property. Returns: Background color as a #GdkColor.
void backgroundGdk(gdk.color.Color propval) @property nothrowSet `backgroundGdk` property. Params: propval = Background color as a #GdkColor.
gdk.rgba.RGBA backgroundRgba() @property nothrowGet `backgroundRgba` property. Returns: Background color as a #GdkRGBA.
void backgroundRgba(gdk.rgba.RGBA propval) @property nothrowSet `backgroundRgba` property. Params: propval = Background color as a #GdkRGBA.
bool backgroundSet() @property nothrow
void backgroundSet(bool propval) @property nothrow
void direction(gtk.types.TextDirection propval) @property nothrow
bool editable() @property nothrow
void editable(bool propval) @property nothrow
bool editableSet() @property nothrow
void editableSet(bool propval) @property nothrow
bool fallback() @property nothrowGet `fallback` property. Returns: Whether font fallback is enabled.
void fallback(bool propval) @property nothrowSet `fallback` property. Params: propval = Whether font fallback is enabled.
bool fallbackSet() @property nothrow
void fallbackSet(bool propval) @property nothrow
string family() @property nothrow
void family(string propval) @property nothrow
bool familySet() @property nothrow
void familySet(bool propval) @property nothrow
string font() @property nothrowGet `font` property. Returns: Font description as string, e.g. \"Sans Italic 12\".
void font(string propval) @property nothrowSet `font` property. Params: propval = Font description as string, e.g. \"Sans Italic 12\".
void fontDesc(pango.font_description.FontDescription propval) @property nothrow
string fontFeatures() @property nothrowGet `fontFeatures` property. Returns: OpenType font features, as a string.
void fontFeatures(string propval) @property nothrowSet `fontFeatures` property. Params: propval = OpenType font features, as a string.
bool fontFeaturesSet() @property nothrow
void fontFeaturesSet(bool propval) @property nothrow
void foreground(string propval) @property nothrow
gdk.color.Color foregroundGdk() @property nothrowGet `foregroundGdk` property. Returns: Foreground color as a #GdkColor.
void foregroundGdk(gdk.color.Color propval) @property nothrowSet `foregroundGdk` property. Params: propval = Foreground color as a #GdkColor.
gdk.rgba.RGBA foregroundRgba() @property nothrowGet `foregroundRgba` property. Returns: Foreground color as a #GdkRGBA.
void foregroundRgba(gdk.rgba.RGBA propval) @property nothrowSet `foregroundRgba` property. Params: propval = Foreground color as a #GdkRGBA.
bool foregroundSet() @property nothrow
void foregroundSet(bool propval) @property nothrow
int indent() @property nothrow
void indent(int propval) @property nothrow
bool indentSet() @property nothrow
void indentSet(bool propval) @property nothrow
bool invisible() @property nothrowGet `invisible` property. Returns: Whether this text is hidden.
void invisible(bool propval) @property nothrowSet `invisible` property. Params: propval = Whether this text is hidden.
bool invisibleSet() @property nothrow
void invisibleSet(bool propval) @property nothrow
void justification(gtk.types.Justification propval) @property nothrow
bool justificationSet() @property nothrow
void justificationSet(bool propval) @property nothrow
string language() @property nothrowGet `language` property. Returns: 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.
void language(string propval) @property nothrowSet `language` property. Params: propval = 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.
bool languageSet() @property nothrow
void languageSet(bool propval) @property nothrow
int leftMargin() @property nothrow
void leftMargin(int propval) @property nothrow
bool leftMarginSet() @property nothrow
void leftMarginSet(bool propval) @property nothrow
int letterSpacing() @property nothrowGet `letterSpacing` property. Returns: Extra spacing between graphemes, in Pango units.
void letterSpacing(int propval) @property nothrowSet `letterSpacing` property. Params: propval = Extra spacing between graphemes, in Pango units.
bool letterSpacingSet() @property nothrow
void letterSpacingSet(bool propval) @property nothrow
string name() @property nothrow
void paragraphBackground(string propval) @property nothrowSet `paragraphBackground` property. Params: propval = The paragraph background color as a string.
gdk.color.Color paragraphBackgroundGdk() @property nothrowGet `paragraphBackgroundGdk` property. Returns: The paragraph background color as a #GdkColor.
void paragraphBackgroundGdk(gdk.color.Color propval) @property nothrowSet `paragraphBackgroundGdk` property. Params: propval = The paragraph background color as a #GdkColor.
gdk.rgba.RGBA paragraphBackgroundRgba() @property nothrowGet `paragraphBackgroundRgba` property. Returns: The paragraph background color as a #GdkRGBA.
void paragraphBackgroundRgba(gdk.rgba.RGBA propval) @property nothrowSet `paragraphBackgroundRgba` property. Params: propval = The paragraph background color as a #GdkRGBA.
bool paragraphBackgroundSet() @property nothrow
void paragraphBackgroundSet(bool propval) @property nothrow
int pixelsAboveLines() @property nothrow
void pixelsAboveLines(int propval) @property nothrow
bool pixelsAboveLinesSet() @property nothrow
void pixelsAboveLinesSet(bool propval) @property nothrow
int pixelsBelowLines() @property nothrow
void pixelsBelowLines(int propval) @property nothrow
bool pixelsBelowLinesSet() @property nothrow
void pixelsBelowLinesSet(bool propval) @property nothrow
int pixelsInsideWrap() @property nothrow
void pixelsInsideWrap(int propval) @property nothrow
bool pixelsInsideWrapSet() @property nothrow
void pixelsInsideWrapSet(bool propval) @property nothrow
int rightMargin() @property nothrow
void rightMargin(int propval) @property nothrow
bool rightMarginSet() @property nothrow
void rightMarginSet(bool propval) @property nothrow
int rise() @property nothrow
void rise(int propval) @property nothrow
bool riseSet() @property nothrow
void riseSet(bool propval) @property nothrow
double scale() @property nothrow
void scale(double propval) @property nothrow
bool scaleSet() @property nothrow
void scaleSet(bool propval) @property nothrow
int size() @property nothrow
void size(int propval) @property nothrow
double sizePoints() @property nothrow
void sizePoints(double propval) @property nothrow
bool sizeSet() @property nothrow
void sizeSet(bool propval) @property nothrow
pango.types.Stretch stretch() @property nothrow
void stretch(pango.types.Stretch propval) @property nothrow
bool stretchSet() @property nothrow
void stretchSet(bool propval) @property nothrow
bool strikethrough() @property nothrow
void strikethrough(bool propval) @property nothrow
gdk.rgba.RGBA strikethroughRgba() @property nothrowGet `strikethroughRgba` property. Returns: This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.
void strikethroughRgba(gdk.rgba.RGBA propval) @property nothrowSet `strikethroughRgba` property. Params: propval = This property modifies the color of strikeouts. If not set, strikeouts will use the forground color.
bool strikethroughRgbaSet() @property nothrowGet `strikethroughRgbaSet` property. Returns: If the #GtkTextTag:strikethrough-rgba property has been set.
void strikethroughRgbaSet(bool propval) @property nothrowSet `strikethroughRgbaSet` property. Params: propval = If the #GtkTextTag:strikethrough-rgba property has been set.
bool strikethroughSet() @property nothrow
void strikethroughSet(bool propval) @property nothrow
pango.types.Style style() @property nothrow
void style(pango.types.Style propval) @property nothrow
bool styleSet() @property nothrow
void styleSet(bool propval) @property nothrow
pango.tab_array.TabArray tabs() @property nothrow
void tabs(pango.tab_array.TabArray propval) @property nothrow
bool tabsSet() @property nothrow
void tabsSet(bool propval) @property nothrow
pango.types.Underline underline() @property nothrow
void underline(pango.types.Underline propval) @property nothrow
gdk.rgba.RGBA underlineRgba() @property nothrowGet `underlineRgba` property. Returns: This property modifies the color of underlines. If not set, underlines will use the forground color.
void underlineRgba(gdk.rgba.RGBA propval) @property nothrowSet `underlineRgba` property. Params: propval = This property modifies the color of underlines. If not set, underlines will use the forground color.
bool underlineRgbaSet() @property nothrowGet `underlineRgbaSet` property. Returns: If the #GtkTextTag:underline-rgba property has been set.
void underlineRgbaSet(bool propval) @property nothrowSet `underlineRgbaSet` property. Params: propval = If the #GtkTextTag:underline-rgba property has been set.
bool underlineSet() @property nothrow
void underlineSet(bool propval) @property nothrow
pango.types.Variant variant() @property nothrow
void variant(pango.types.Variant propval) @property nothrow
bool variantSet() @property nothrow
void variantSet(bool propval) @property nothrow
int weight() @property nothrow
void weight(int propval) @property nothrow
bool weightSet() @property nothrow
void weightSet(bool propval) @property nothrow
gtk.types.WrapMode wrapMode() @property nothrow
void wrapMode(gtk.types.WrapMode propval) @property nothrow
bool wrapModeSet() @property nothrow
void wrapModeSet(bool propval) @property nothrow
void changed(bool sizeChanged) nothrowEmits the #GtkTextTagTable::tag-changed signal on the #GtkTextTagTable where the tag is included.
bool event(gobject.object.ObjectWrap eventObject, gdk.event.Event event, gtk.text_iter.TextIter iter) nothrowEmits the “event” signal on the #GtkTextTag.
int getPriority() nothrowGet the tag priority. Returns: The tag’s priority.
void setPriority(int priority) nothrowSets the priority of a #GtkTextTag. Valid priorities start at 0 and go to one less than [gtk.text_tag_table.TextTagTable.getSize]. Each tag in a table has a unique priority; setting the priority of...
gulong connectEvent(T)(T callback, Flag!"After" after = No.After) if (isCallable!T && is(ReturnType!T == bool) && (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gobject.object.ObjectWrap))) && (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == gdk.event.Event))) && (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] == gtk.text_iter.TextIter))) && (Parameters!T.length < 4 || (ParameterStorageClassTuple!T[3] == ParameterStorageClass.none && is(Parameters!T[3] : gtk.text_tag.TextTag))) && Parameters!T.length < 5) nothrowConnect to `Event` signal.
Constructors
this(void * ptr, Flag!"Take" take)
this(string name = null)Creates a #GtkTextTag. Configure the tag using object arguments, i.e. using [gobject.object.ObjectWrap.set].

Fluent builder implementation template for gtk.text_tag.TextTag

Methods
T accumulativeMargin(bool propval) nothrowSet `accumulativeMargin` property. Params: propval = Whether the margins accumulate or override each other.
T background(string propval) nothrow
T backgroundFullHeight(bool propval) nothrow
T backgroundFullHeightSet(bool propval) nothrow
T backgroundGdk(gdk.color.Color propval) nothrowSet `backgroundGdk` property. Params: propval = Background color as a #GdkColor. Returns: Builder instance for fluent chaining
T backgroundRgba(gdk.rgba.RGBA propval) nothrowSet `backgroundRgba` property. Params: propval = Background color as a #GdkRGBA. Returns: Builder instance for fluent chaining
T backgroundSet(bool propval) nothrow
T editable(bool propval) nothrow
T editableSet(bool propval) nothrow
T fallback(bool propval) nothrowSet `fallback` property. Params: propval = Whether font fallback is enabled.
T fallbackSet(bool propval) nothrow
T family(string propval) nothrow
T familySet(bool propval) nothrow
T font(string propval) nothrowSet `font` property. Params: propval = Font description as string, e.g. \"Sans Italic 12\".
T fontFeatures(string propval) nothrowSet `fontFeatures` property. Params: propval = OpenType font features, as a string. Returns: Builder instance for fluent chaining
T fontFeaturesSet(bool propval) nothrow
T foreground(string propval) nothrow
T foregroundGdk(gdk.color.Color propval) nothrowSet `foregroundGdk` property. Params: propval = Foreground color as a #GdkColor. Returns: Builder instance for fluent chaining
T foregroundRgba(gdk.rgba.RGBA propval) nothrowSet `foregroundRgba` property. Params: propval = Foreground color as a #GdkRGBA. Returns: Builder instance for fluent chaining
T foregroundSet(bool propval) nothrow
T indent(int propval) nothrow
T indentSet(bool propval) nothrow
T invisible(bool propval) nothrowSet `invisible` property. Params: propval = Whether this text is hidden.
T invisibleSet(bool propval) nothrow
T justificationSet(bool propval) nothrow
T language(string propval) nothrowSet `language` property. Params: propval = 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.
T languageSet(bool propval) nothrow
T leftMargin(int propval) nothrow
T leftMarginSet(bool propval) nothrow
T letterSpacing(int propval) nothrowSet `letterSpacing` property. Params: propval = Extra spacing between graphemes, in Pango units. Returns: Builder instance for fluent chaining
T letterSpacingSet(bool propval) nothrow
T name(string propval) nothrow
T paragraphBackground(string propval) nothrowSet `paragraphBackground` property. Params: propval = The paragraph background color as a string. Returns: Builder instance for fluent chaining
T paragraphBackgroundGdk(gdk.color.Color propval) nothrowSet `paragraphBackgroundGdk` property. Params: propval = The paragraph background color as a #GdkColor. Returns: Builder instance for fluent chaining
T paragraphBackgroundRgba(gdk.rgba.RGBA propval) nothrowSet `paragraphBackgroundRgba` property. Params: propval = The paragraph background color as a #GdkRGBA. Returns: Builder instance for fluent chaining
T paragraphBackgroundSet(bool propval) nothrow
T pixelsAboveLines(int propval) nothrow
T pixelsAboveLinesSet(bool propval) nothrow
T pixelsBelowLines(int propval) nothrow
T pixelsBelowLinesSet(bool propval) nothrow
T pixelsInsideWrap(int propval) nothrow
T pixelsInsideWrapSet(bool propval) nothrow
T rightMargin(int propval) nothrow
T rightMarginSet(bool propval) nothrow
T rise(int propval) nothrow
T riseSet(bool propval) nothrow
T scale(double propval) nothrow
T scaleSet(bool propval) nothrow
T size(int propval) nothrow
T sizePoints(double propval) nothrow
T sizeSet(bool propval) nothrow
T stretch(pango.types.Stretch propval) nothrow
T stretchSet(bool propval) nothrow
T strikethrough(bool propval) nothrow
T strikethroughRgba(gdk.rgba.RGBA propval) nothrowSet `strikethroughRgba` property. Params: propval = This property modifies the color of strikeouts. If not set, strikeouts will use the forground color. Returns: Builder instance for fluent chaining
T strikethroughRgbaSet(bool propval) nothrowSet `strikethroughRgbaSet` property. Params: propval = If the #GtkTextTag:strikethrough-rgba property has been set. Returns: Builder instance for fluent chaining
T strikethroughSet(bool propval) nothrow
T style(pango.types.Style propval) nothrow
T styleSet(bool propval) nothrow
T tabs(pango.tab_array.TabArray propval) nothrow
T tabsSet(bool propval) nothrow
T underline(pango.types.Underline propval) nothrow
T underlineRgba(gdk.rgba.RGBA propval) nothrowSet `underlineRgba` property. Params: propval = This property modifies the color of underlines. If not set, underlines will use the forground color.
T underlineRgbaSet(bool propval) nothrowSet `underlineRgbaSet` property. Params: propval = If the #GtkTextTag:underline-rgba property has been set. Returns: Builder instance for fluent chaining
T underlineSet(bool propval) nothrow
T variant(pango.types.Variant propval) nothrow
T variantSet(bool propval) nothrow
T weight(int propval) nothrow
T weightSet(bool propval) nothrow
T wrapMode(gtk.types.WrapMode propval) nothrow
T wrapModeSet(bool propval) nothrow

Fluent builder for gtk.text_tag.TextTag

Methods
TextTag build() nothrowCreate object from builder. Returns: New object