TextBuffer

Stores text and attributes for display in a GtkTextView.

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.

class TextBuffer : ObjectG {}

Constructors

this
this(GtkTextBuffer* gtkTextBuffer, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this(TextTagTable table)

Creates a new text buffer.

Members

Aliases

delet
alias delet = delete_
Undocumented in source.

Functions

addMark
void addMark(TextMark mark, TextIter where)

Adds the mark at position @where.

addOnApplyTag
gulong addOnApplyTag(void delegate(TextTag, TextIter, TextIter, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to apply a tag to a range of text in a GtkTextBuffer.

addOnBeginUserAction
gulong addOnBeginUserAction(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted at the beginning of a single user-visible operation on a GtkTextBuffer.

addOnChanged
gulong addOnChanged(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted when the content of a GtkTextBuffer has changed.

addOnDeleteRange
gulong addOnDeleteRange(void delegate(TextIter, TextIter, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to delete a range from a GtkTextBuffer.

addOnEndUserAction
gulong addOnEndUserAction(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted at the end of a single user-visible operation on the GtkTextBuffer.

addOnInsertChildAnchor
gulong addOnInsertChildAnchor(void delegate(TextIter, TextChildAnchor, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to insert a GtkTextChildAnchor in a GtkTextBuffer.

addOnInsertPaintable
gulong addOnInsertPaintable(void delegate(TextIter, PaintableIF, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to insert a GdkPaintable in a GtkTextBuffer.

addOnInsertText
gulong addOnInsertText(void delegate(TextIter, string, int, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to insert text in a GtkTextBuffer.

addOnMarkDeleted
gulong addOnMarkDeleted(void delegate(TextMark, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted as notification after a GtkTextMark is deleted.

addOnMarkSet
gulong addOnMarkSet(void delegate(TextIter, TextMark, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted as notification after a GtkTextMark is set.

addOnModifiedChanged
gulong addOnModifiedChanged(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted when the modified bit of a GtkTextBuffer flips.

addOnPasteDone
gulong addOnPasteDone(void delegate(Clipboard, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted after paste operation has been completed.

addOnRedo
gulong addOnRedo(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted when a request has been made to redo the previously undone operation.

addOnRemoveTag
gulong addOnRemoveTag(void delegate(TextTag, TextIter, TextIter, TextBuffer) dlg, ConnectFlags connectFlags)

Emitted to remove all occurrences of @tag from a range of text in a GtkTextBuffer.

addOnUndo
gulong addOnUndo(void delegate(TextBuffer) dlg, ConnectFlags connectFlags)

Emitted when a request has been made to undo the previous operation or set of operations that have been grouped together.

addSelectionClipboard
void addSelectionClipboard(Clipboard clipboard)

Adds @clipboard to the list of clipboards in which the selection contents of @buffer are available.

applyTag
void applyTag(TextTag tag, TextIter start, TextIter end)

Emits the “apply-tag” signal on @buffer.

applyTagByName
void applyTagByName(string name, TextIter start, TextIter end)

Emits the “apply-tag” signal on @buffer.

backspace
bool backspace(TextIter iter, bool interactive, bool defaultEditable)

Performs the appropriate action as if the user hit the delete key with the cursor at the position specified by @iter.

beginIrreversibleAction
void beginIrreversibleAction()

Denotes the beginning of an action that may not be undone.

beginUserAction
void beginUserAction()

Called to indicate that the buffer operations between here and a call to gtk_text_buffer_end_user_action() are part of a single user-visible operation.

copyClipboard
void copyClipboard(Clipboard clipboard)

Copies the currently-selected text to a clipboard.

createChildAnchor
TextChildAnchor createChildAnchor(TextIter iter)

Creates and inserts a child anchor.

createMark
TextMark createMark(string markName, TextIter where, bool leftGravity)

Creates a mark at position @where.

createTag
TextTag createTag(string tagName, ...)

Creates a tag and adds it to the tag table for buffer. Equivalent to adding a new tag to the buffer's tag table.

cutClipboard
void cutClipboard(Clipboard clipboard, bool defaultEditable)

Copies the currently-selected text to a clipboard, then deletes said text if it’s editable.

deleteInteractive
bool deleteInteractive(TextIter startIter, TextIter endIter, bool defaultEditable)

Deletes all editable text in the given range.

deleteMark
void deleteMark(TextMark mark)

Deletes @mark, so that it’s no longer located anywhere in the buffer.

deleteMarkByName
void deleteMarkByName(string name)

Deletes the mark named @name; the mark must exist.

deleteSelection
bool deleteSelection(bool interactive, bool defaultEditable)

Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text.

delete_
void delete_(TextIter start, TextIter end)

Deletes text between @start and @end.

endIrreversibleAction
void endIrreversibleAction()

Denotes the end of an action that may not be undone.

endUserAction
void endUserAction()

Ends a user-visible operation.

getBounds
void getBounds(TextIter start, TextIter end)

Retrieves the first and last iterators in the buffer, i.e. the entire buffer lies within the range [@start,@end).

getCanRedo
bool getCanRedo()

Gets whether there is a redoable action in the history.

getCanUndo
bool getCanUndo()

Gets whether there is an undoable action in the history.

getCharCount
int getCharCount()

Gets the number of characters in the buffer.

getEnableUndo
bool getEnableUndo()

Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions.

getEndIter
void getEndIter(TextIter iter)

Initializes @iter with the “end iterator,” one past the last valid character in the text buffer.

getHasSelection
bool getHasSelection()

Indicates whether the buffer has some text currently selected.

getInsert
TextMark getInsert()

Returns the mark that represents the cursor (insertion point).

getIterAtChildAnchor
void getIterAtChildAnchor(TextIter iter, TextChildAnchor anchor)

Obtains the location of @anchor within @buffer.

getIterAtLine
bool getIterAtLine(TextIter iter, int lineNumber)

Initializes @iter to the start of the given line.

getIterAtLineIndex
bool getIterAtLineIndex(TextIter iter, int lineNumber, int byteIndex)

Obtains an iterator pointing to @byte_index within the given line.

getIterAtLineOffset
bool getIterAtLineOffset(TextIter iter, int lineNumber, int charOffset)

Obtains an iterator pointing to @char_offset within the given line.

getIterAtMark
void getIterAtMark(TextIter iter, TextMark mark)

Initializes @iter with the current position of @mark.

getIterAtOffset
void getIterAtOffset(TextIter iter, int charOffset)

Initializes @iter to a position @char_offset chars from the start of the entire buffer.

getLineCount
int getLineCount()

Obtains the number of lines in the buffer.

getMark
TextMark getMark(string name)

Returns the mark named @name in buffer @buffer, or %NULL if no such mark exists in the buffer.

getMaxUndoLevels
uint getMaxUndoLevels()

Gets the maximum number of undo levels to perform.

getModified
bool getModified()

Indicates whether the buffer has been modified since the last call to [method@Gtk.TextBuffer.set_modified] set the modification flag to %FALSE.

getSelectionBound
TextMark getSelectionBound()

Returns the mark that represents the selection bound.

getSelectionBounds
bool getSelectionBounds(TextIter start, TextIter end)

Returns %TRUE if some text is selected; places the bounds of the selection in @start and @end.

getSelectionContent
ContentProvider getSelectionContent()

Get a content provider for this buffer.

getSlice
string getSlice(TextIter start, TextIter end, bool includeHiddenChars)

Returns the text in the range [@start,@end).

getStartIter
void getStartIter(TextIter iter)

Initialized @iter with the first position in the text buffer.

getStruct
void* getStruct()

the main Gtk struct as a void*

getTagTable
TextTagTable getTagTable()

Get the GtkTextTagTable associated with this buffer.

getText
string getText()

Obtain the entire text

getText
string getText(TextIter start, TextIter end, bool includeHiddenChars)

Returns the text in the range [@start,@end).

getTextBufferStruct
GtkTextBuffer* getTextBufferStruct(bool transferOwnership)

Get the main Gtk struct

insert
void insert(TextIter iter, string text)

Inserts @len bytes of @text at position @iter.

insertAtCursor
void insertAtCursor(string text)

Inserts @text in @buffer.

insertChildAnchor
void insertChildAnchor(TextIter iter, TextChildAnchor anchor)

Inserts a child widget anchor into the text buffer at @iter.

insertInteractive
bool insertInteractive(TextIter iter, string text, bool defaultEditable)

Inserts @text in @buffer.

insertInteractiveAtCursor
bool insertInteractiveAtCursor(string text, bool defaultEditable)

Inserts @text in @buffer.

insertMarkup
void insertMarkup(TextIter iter, string markup, int len)

Inserts the text in @markup at position @iter.

insertPaintable
void insertPaintable(TextIter iter, PaintableIF paintable)

Inserts an image into the text buffer at @iter.

insertRange
void insertRange(TextIter iter, TextIter start, TextIter end)

Copies text, tags, and paintables between @start and @end and inserts the copy at @iter.

insertRangeInteractive
bool insertRangeInteractive(TextIter iter, TextIter start, TextIter end, bool defaultEditable)

Copies text, tags, and paintables between @start and @end and inserts the copy at @iter.

insertWithTags
void insertWithTags(TextIter iter, string text, TextTag[] tags)

Inserts text into buffer at iter, applying the list of tags to the newly-inserted text. The last tag specified must be NULL to terminate the list. Equivalent to calling gtk_text_buffer_insert(), then gtk_text_buffer_apply_tag() on the inserted text; gtk_text_buffer_insert_with_tags() is just a convenience function.

insertWithTagsByName
void insertWithTagsByName(TextIter iter, string text, string[] tags)

Same as gtk_text_buffer_insert_with_tags(), but allows you to pass in tag names instead of tag objects.

moveMark
void moveMark(TextMark mark, TextIter where)

Moves @mark to the new location @where.

moveMarkByName
void moveMarkByName(string name, TextIter where)

Moves the mark named @name (which must exist) to location @where.

pasteClipboard
void pasteClipboard(Clipboard clipboard, TextIter overrideLocation, bool defaultEditable)

Pastes the contents of a clipboard.

placeCursor
void placeCursor(TextIter where)

This function moves the “insert” and “selection_bound” marks simultaneously.

redo
void redo()

Redoes the next redoable action on the buffer, if there is one.

removeAllTags
void removeAllTags(TextIter start, TextIter end)

Removes all tags in the range between @start and @end.

removeSelectionClipboard
void removeSelectionClipboard(Clipboard clipboard)

Removes a GdkClipboard added with gtk_text_buffer_add_selection_clipboard().

removeTag
void removeTag(TextTag tag, TextIter start, TextIter end)

Emits the “remove-tag” signal.

removeTagByName
void removeTagByName(string name, TextIter start, TextIter end)

Emits the “remove-tag” signal.

selectRange
void selectRange(TextIter ins, TextIter bound)

This function moves the “insert” and “selection_bound” marks simultaneously.

setEnableUndo
void setEnableUndo(bool enableUndo)

Sets whether or not to enable undoable actions in the text buffer.

setMaxUndoLevels
void setMaxUndoLevels(uint maxUndoLevels)

Sets the maximum number of undo levels to perform.

setModified
void setModified(bool setting)

Used to keep track of whether the buffer has been modified since the last time it was saved.

setText
void setText(string text)

Deletes current contents of @buffer, and inserts @text instead.

undo
void undo()

Undoes the last undoable action on the buffer, if there is one.

Static functions

getType
GType getType()

Variables

gtkTextBuffer
GtkTextBuffer* gtkTextBuffer;

the main Gtk struct

Inherited Members

From ObjectG

gObject
GObject* gObject;

the main Gtk struct

ownedRef
bool ownedRef;
Undocumented in source.
getObjectGStruct
GObject* getObjectGStruct(bool transferOwnership)

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

isGcRoot
bool isGcRoot;
Undocumented in source.
signals
DClosure[gulong] signals;
Undocumented in source.
destroyNotify
void destroyNotify(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
toggleNotify
void toggleNotify(ObjectG obj, GObject* object, int isLastRef)
Undocumented in source. Be warned that the author may not have intended to support it.
~this
~this()
Undocumented in source.
opCast
T opCast()
getDObject
RT getDObject(U obj, bool ownedRef)

Gets a D Object from the objects table of associations.

removeGcRoot
void removeGcRoot()
Undocumented in source. Be warned that the author may not have intended to support it.
setProperty
void setProperty(string propertyName, T value)
unref
deprecated void unref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
doref
deprecated ObjectG doref(ObjectG obj)
Undocumented in source. Be warned that the author may not have intended to support it.
addOnNotify
gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags)

The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.

getType
GType getType()
compatControl
size_t compatControl(size_t what, void* data)
interfaceFindProperty
ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName)

Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

interfaceInstallProperty
void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec)

Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

interfaceListProperties
ParamSpec[] interfaceListProperties(TypeInterface gIface)

Lists the properties of an interface.Generally, the interface vtable passed in as @g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

addToggleRef
void addToggleRef(GToggleNotify notify, void* data)

Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.

addWeakPointer
void addWeakPointer(void* weakPointerLocation)

Adds a weak reference from weak_pointer to @object to indicate that the pointer located at @weak_pointer_location is only valid during the lifetime of @object. When the @object is finalized, @weak_pointer will be set to %NULL.

bindProperty
Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags)

Creates a binding between @source_property on @source and @target_property on @target. Whenever the @source_property is changed the @target_property is updated using the same value. For instance:

bindPropertyFull
Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify)

Complete version of g_object_bind_property().

bindPropertyWithClosures
Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.

dupData
void* dupData(string key, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_data() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

dupQdata
void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData)

This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. @dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.

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 g_object_ref_sink().

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 g_object_set_data()).

getProperty
void getProperty(string propertyName, Value value)

Gets a property of an object.

getQdata
void* getQdata(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata().

getValist
void getValist(string firstPropertyName, void* varArgs)

Gets properties of an object.

getv
void getv(string[] names, 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(ParamSpec pspec)

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

doref
alias doref = ref_
Undocumented in source.
ref_
ObjectG ref_()

Increases the reference count of @object.

refSink
ObjectG refSink()

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

removeToggleRef
void removeToggleRef(GToggleNotify notify, void* data)

Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.

removeWeakPointer
void removeWeakPointer(void* weakPointerLocation)

Removes a weak reference from @object that was previously added using g_object_add_weak_pointer(). The @weak_pointer_location has to match the one used with g_object_add_weak_pointer().

replaceData
bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @key on @object with @oldval, and if they are the same, replaces @oldval with @newval.

replaceQdata
bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy)

Compares the user data for the key @quark on @object with @oldval, and if they are the same, replaces @oldval with @newval.

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.

setDataFull
void setDataFull(string key, void* data, GDestroyNotify destroy)

Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.

setProperty
void setProperty(string propertyName, Value value)

Sets a property on an object.

setQdata
void setQdata(GQuark quark, void* data)

This sets an opaque, named pointer on an object. The name is specified through a #GQuark (retrieved e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the @object with g_object_get_qdata() until the @object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using #NULL as pointer essentially removes the data stored.

setQdataFull
void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy)

This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with @data as argument when the @object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same @quark.

setValist
void setValist(string firstPropertyName, void* varArgs)

Sets properties on an object.

setv
void setv(string[] names, Value[] values)

Sets @n_properties properties for an @object. Properties to be set will be taken from @values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

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(GQuark quark)

This function gets back user data pointers stored via g_object_set_qdata() 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: |[<!-- language="C" --> void object_add_to_user_list (GObject *object, const gchar *new_string) { // the quark, naming the object data GQuark quark_string_list = g_quark_from_static_string ("my-string-list"); // retrieve the old string list GList *list = g_object_steal_qdata (object, quark_string_list);

thawNotify
void thawNotify()

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

unref
void unref()

Decreases the reference count of @object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

watchClosure
void watchClosure(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 g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.

weakRef
void weakRef(GWeakNotify notify, void* data)

Adds a weak reference callback to an object. Weak references are used for notification when an object is disposed. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).

weakUnref
void weakUnref(GWeakNotify notify, void* data)

Removes a weak reference callback to an object.

clearObject
void clearObject(ObjectG objectPtr)

Clears a reference to a #GObject.

Meta