TextTag

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.

class TextTag : ObjectWrap {}

Constructors

this
this(void* ptr, Flag!"Take" take)
this
this(string name)

Creates a #GtkTextTag. Configure the tag using object arguments, i.e. using gobject.object.ObjectWrap.set.

Members

Functions

changed
void changed(bool sizeChanged)

Emits the #GtkTextTagTable::tag-changed signal on the #GtkTextTagTable where the tag is included.

connectEvent
gulong connectEvent(T callback, Flag!"After" after)

Connect to Event signal.

event
bool event(gobject.object.ObjectWrap eventObject, gdk.event.Event event, gtk.text_iter.TextIter iter)

Emits the “event” signal on the #GtkTextTag.

getPriority
int getPriority()

Get the tag priority.

self
TextTag self()

Returns this, for use in with statements.

setPriority
void setPriority(int priority)

Sets 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 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 gtk.text_buffer.TextBuffer.createTag, which adds the tag to the buffer’s table automatically.

Properties

_gType
GType _gType [@property getter]
accumulativeMargin
bool accumulativeMargin [@property getter]

Get accumulativeMargin property.

accumulativeMargin
bool accumulativeMargin [@property setter]

Set accumulativeMargin property.

background
string background [@property setter]
backgroundFullHeight
bool backgroundFullHeight [@property getter]
backgroundFullHeight
bool backgroundFullHeight [@property setter]
backgroundFullHeightSet
bool backgroundFullHeightSet [@property getter]
backgroundFullHeightSet
bool backgroundFullHeightSet [@property setter]
backgroundGdk
gdk.color.Color backgroundGdk [@property getter]

Get backgroundGdk property.

backgroundGdk
gdk.color.Color backgroundGdk [@property setter]

Set backgroundGdk property.

backgroundRgba
gdk.rgba.RGBA backgroundRgba [@property getter]

Get backgroundRgba property.

backgroundRgba
gdk.rgba.RGBA backgroundRgba [@property setter]

Set backgroundRgba property.

backgroundSet
bool backgroundSet [@property getter]
backgroundSet
bool backgroundSet [@property setter]
direction
gtk.types.TextDirection direction [@property getter]
direction
gtk.types.TextDirection direction [@property setter]
editable
bool editable [@property getter]
editable
bool editable [@property setter]
editableSet
bool editableSet [@property getter]
editableSet
bool editableSet [@property setter]
fallback
bool fallback [@property getter]

Get fallback property.

fallback
bool fallback [@property setter]

Set fallback property.

fallbackSet
bool fallbackSet [@property getter]
fallbackSet
bool fallbackSet [@property setter]
family
string family [@property getter]
family
string family [@property setter]
familySet
bool familySet [@property getter]
familySet
bool familySet [@property setter]
font
string font [@property getter]

Get font property.

font
string font [@property setter]

Set font property.

fontDesc
pango.font_description.FontDescription fontDesc [@property getter]
fontDesc
pango.font_description.FontDescription fontDesc [@property setter]
fontFeatures
string fontFeatures [@property getter]

Get fontFeatures property.

fontFeatures
string fontFeatures [@property setter]

Set fontFeatures property.

fontFeaturesSet
bool fontFeaturesSet [@property getter]
fontFeaturesSet
bool fontFeaturesSet [@property setter]
foreground
string foreground [@property setter]
foregroundGdk
gdk.color.Color foregroundGdk [@property getter]

Get foregroundGdk property.

foregroundGdk
gdk.color.Color foregroundGdk [@property setter]

Set foregroundGdk property.

foregroundRgba
gdk.rgba.RGBA foregroundRgba [@property getter]

Get foregroundRgba property.

foregroundRgba
gdk.rgba.RGBA foregroundRgba [@property setter]

Set foregroundRgba property.

foregroundSet
bool foregroundSet [@property getter]
foregroundSet
bool foregroundSet [@property setter]
indent
int indent [@property getter]
indent
int indent [@property setter]
indentSet
bool indentSet [@property getter]
indentSet
bool indentSet [@property setter]
invisible
bool invisible [@property getter]

Get invisible property.

invisible
bool invisible [@property setter]

Set invisible property.

invisibleSet
bool invisibleSet [@property getter]
invisibleSet
bool invisibleSet [@property setter]
justification
gtk.types.Justification justification [@property getter]
justification
gtk.types.Justification justification [@property setter]
justificationSet
bool justificationSet [@property getter]
justificationSet
bool justificationSet [@property setter]
language
string language [@property getter]

Get language property.

language
string language [@property setter]

Set language property.

languageSet
bool languageSet [@property getter]
languageSet
bool languageSet [@property setter]
leftMargin
int leftMargin [@property getter]
leftMargin
int leftMargin [@property setter]
leftMarginSet
bool leftMarginSet [@property getter]
leftMarginSet
bool leftMarginSet [@property setter]
letterSpacing
int letterSpacing [@property getter]

Get letterSpacing property.

letterSpacing
int letterSpacing [@property setter]

Set letterSpacing property.

letterSpacingSet
bool letterSpacingSet [@property getter]
letterSpacingSet
bool letterSpacingSet [@property setter]
name
string name [@property getter]
paragraphBackground
string paragraphBackground [@property setter]

Set paragraphBackground property.

paragraphBackgroundGdk
gdk.color.Color paragraphBackgroundGdk [@property getter]

Get paragraphBackgroundGdk property.

paragraphBackgroundGdk
gdk.color.Color paragraphBackgroundGdk [@property setter]

Set paragraphBackgroundGdk property.

paragraphBackgroundRgba
gdk.rgba.RGBA paragraphBackgroundRgba [@property getter]

Get paragraphBackgroundRgba property.

paragraphBackgroundRgba
gdk.rgba.RGBA paragraphBackgroundRgba [@property setter]

Set paragraphBackgroundRgba property.

paragraphBackgroundSet
bool paragraphBackgroundSet [@property getter]
paragraphBackgroundSet
bool paragraphBackgroundSet [@property setter]
pixelsAboveLines
int pixelsAboveLines [@property getter]
pixelsAboveLines
int pixelsAboveLines [@property setter]
pixelsAboveLinesSet
bool pixelsAboveLinesSet [@property getter]
pixelsAboveLinesSet
bool pixelsAboveLinesSet [@property setter]
pixelsBelowLines
int pixelsBelowLines [@property getter]
pixelsBelowLines
int pixelsBelowLines [@property setter]
pixelsBelowLinesSet
bool pixelsBelowLinesSet [@property getter]
pixelsBelowLinesSet
bool pixelsBelowLinesSet [@property setter]
pixelsInsideWrap
int pixelsInsideWrap [@property getter]
pixelsInsideWrap
int pixelsInsideWrap [@property setter]
pixelsInsideWrapSet
bool pixelsInsideWrapSet [@property getter]
pixelsInsideWrapSet
bool pixelsInsideWrapSet [@property setter]
rightMargin
int rightMargin [@property getter]
rightMargin
int rightMargin [@property setter]
rightMarginSet
bool rightMarginSet [@property getter]
rightMarginSet
bool rightMarginSet [@property setter]
rise
int rise [@property getter]
rise
int rise [@property setter]
riseSet
bool riseSet [@property getter]
riseSet
bool riseSet [@property setter]
scale
double scale [@property getter]
scale
double scale [@property setter]
scaleSet
bool scaleSet [@property getter]
scaleSet
bool scaleSet [@property setter]
size
int size [@property getter]
size
int size [@property setter]
sizePoints
double sizePoints [@property getter]
sizePoints
double sizePoints [@property setter]
sizeSet
bool sizeSet [@property getter]
sizeSet
bool sizeSet [@property setter]
stretch
pango.types.Stretch stretch [@property getter]
stretch
pango.types.Stretch stretch [@property setter]
stretchSet
bool stretchSet [@property getter]
stretchSet
bool stretchSet [@property setter]
strikethrough
bool strikethrough [@property getter]
strikethrough
bool strikethrough [@property setter]
strikethroughRgba
gdk.rgba.RGBA strikethroughRgba [@property getter]

Get strikethroughRgba property.

strikethroughRgba
gdk.rgba.RGBA strikethroughRgba [@property setter]

Set strikethroughRgba property.

strikethroughRgbaSet
bool strikethroughRgbaSet [@property getter]

Get strikethroughRgbaSet property.

strikethroughRgbaSet
bool strikethroughRgbaSet [@property setter]

Set strikethroughRgbaSet property.

strikethroughSet
bool strikethroughSet [@property getter]
strikethroughSet
bool strikethroughSet [@property setter]
style
pango.types.Style style [@property getter]
style
pango.types.Style style [@property setter]
styleSet
bool styleSet [@property getter]
styleSet
bool styleSet [@property setter]
tabs
pango.tab_array.TabArray tabs [@property getter]
tabs
pango.tab_array.TabArray tabs [@property setter]
tabsSet
bool tabsSet [@property getter]
tabsSet
bool tabsSet [@property setter]
underline
pango.types.Underline underline [@property getter]
underline
pango.types.Underline underline [@property setter]
underlineRgba
gdk.rgba.RGBA underlineRgba [@property getter]

Get underlineRgba property.

underlineRgba
gdk.rgba.RGBA underlineRgba [@property setter]

Set underlineRgba property.

underlineRgbaSet
bool underlineRgbaSet [@property getter]

Get underlineRgbaSet property.

underlineRgbaSet
bool underlineRgbaSet [@property setter]

Set underlineRgbaSet property.

underlineSet
bool underlineSet [@property getter]
underlineSet
bool underlineSet [@property setter]
variant
pango.types.Variant variant [@property getter]
variant
pango.types.Variant variant [@property setter]
variantSet
bool variantSet [@property getter]
variantSet
bool variantSet [@property setter]
weight
int weight [@property getter]
weight
int weight [@property setter]
weightSet
bool weightSet [@property getter]
weightSet
bool weightSet [@property setter]
wrapMode
gtk.types.WrapMode wrapMode [@property getter]
wrapMode
gtk.types.WrapMode wrapMode [@property setter]
wrapModeSet
bool wrapModeSet [@property getter]
wrapModeSet
bool wrapModeSet [@property setter]

Static functions

_getGType
GType _getGType()
builder
TextTagGidBuilder builder()

Get builder for gtk.text_tag.TextTag

Inherited Members

From ObjectWrap

_setGObject
void _setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectWrap wrapper.

_cPtr
void* _cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

_ref
void* _ref(void* gObj)

Calls g_object_ref() on a GObject.

_unref
_unref(void* gObj)

Calls g_object_unref() on a GObject.

_getGType
GType _getGType()

Get the GType of an object.

_gType
GType _gType [@property getter]

GObject GType property.

self
ObjectWrap self()

Convenience method to return this cast to a type. For use in D with statements.

_getDObject
T _getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
gulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectWrap target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectWrap.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectWrap.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectWrap refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectWrap.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectWrap.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectWrap.ref_ and gobject.object.ObjectWrap.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
gulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.