Optionalproperties: Partial<Gtk.TextBuffer.ConstructorProps>Internal$signalsCompile-time signal type information.
This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.
Static$gtypeRead-Onlycan_Denotes that the buffer can reapply the last undone action.
Read-Onlycan_Denotes that the buffer can undo the last applied action.
Read-OnlycanDenotes that the buffer can reapply the last undone action.
Read-OnlycanDenotes that the buffer can undo the last applied action.
Read-Onlycursor_The position of the insert mark.
This is an offset from the beginning of the buffer. It is useful for getting notified when the cursor moves.
Read-OnlycursorThe position of the insert mark.
This is an offset from the beginning of the buffer. It is useful for getting notified when the cursor moves.
Denotes if support for undoing and redoing changes to the buffer is allowed.
Denotes if support for undoing and redoing changes to the buffer is allowed.
Read-Onlyhas_Whether the buffer has some text currently selected.
Read-OnlyhasWhether the buffer has some text currently selected.
Construct Onlytag_The GtkTextTagTable for the buffer.
Construct OnlytagThe GtkTextTagTable for the buffer.
The text content of the buffer.
Without child widgets and images, see Gtk.TextBuffer.get_text for more information.
Adds a Gtk.TextBufferCommitNotify to be called when a change is to be made to the Gtk.TextBuffer.
Functions are explicitly forbidden from making changes to the Gtk.TextBuffer from this callback. It is intended for tracking changes to the buffer only.
It may be advantageous to use Gtk.TextBufferCommitNotify over
connecting to the Gtk.TextBuffer::insert-text or
Gtk.TextBuffer::delete-range signals to avoid ordering issues with
other signal handlers which may further modify the Gtk.TextBuffer.
which notifications should be dispatched to callback
a Gtk.TextBufferCommitNotify to call for commit notifications
a handler id which may be used to remove the commit notify callback using Gtk.TextBuffer.remove_commit_notify.
Adds the mark at position where.
The mark must not be added to another buffer, and if its name
is not null then there must not be another mark in the buffer
with the same name.
Emits the Gtk.TextBuffer::mark-set signal as notification
of the mark's initial placement.
Adds clipboard to the list of clipboards in which the selection
contents of buffer are available.
In most cases, clipboard will be the Gdk.Clipboard returned by
Gtk.Widget.get_primary_clipboard for a view of buffer.
Emits the “apply-tag” signal on buffer.
Calls Gtk.TextTagTable.lookup on the buffer’s tag table to get a Gtk.TextTag, then calls Gtk.TextBuffer.apply_tag.
name of a named Gtk.TextTag
one bound of range to be tagged
other bound of range to be tagged
Performs the appropriate action as if the user hit the delete
key with the cursor at the position specified by iter.
In the normal case a single character will be deleted, but when combining accents are involved, more than one character can be deleted, and when precomposed character and accent combinations are involved, less than one character will be deleted.
Because the buffer is modified, all outstanding iterators become
invalid after calling this function; however, the iter will be
re-initialized to point to the location where text was deleted.
true if the buffer was modified
Denotes the beginning of an action that may not be undone.
This will cause any previous operations in the undo/redo queue to be cleared.
This should be paired with a call to Gtk.TextBuffer.end_irreversible_action after the irreversible action has completed.
You may nest calls to gtk_text_buffer_begin_irreversible_action()
and gtk_text_buffer_end_irreversible_action() pairs.
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.
The operations between gtk_text_buffer_begin_user_action() and
gtk_text_buffer_end_user_action() can then be grouped when creating
an undo stack. Gtk.TextBuffer maintains a count of calls to
gtk_text_buffer_begin_user_action() that have not been closed with
a call to gtk_text_buffer_end_user_action(), and emits the
“begin-user-action” and “end-user-action” signals only for the
outermost pair of calls. This allows you to build user actions
from other user actions.
The “interactive” buffer mutation functions, such as Gtk.TextBuffer.insert_interactive, automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those functions.
SignalconnectSignalconnect_Copies the currently-selected text to a clipboard.
the Gdk.Clipboard object to copy to
Creates and inserts a child anchor.
This is a convenience function which simply creates a child anchor with Gtk.TextChildAnchor.new and inserts it into the buffer with Gtk.TextBuffer.insert_child_anchor.
The new anchor is owned by the buffer; no reference count is returned to the caller of this function.
the created child anchor
Creates a mark at position where.
If mark_name is null, the mark is anonymous; otherwise, the mark
can be retrieved by name using Gtk.TextBuffer.get_mark.
If a mark has left gravity, and text is inserted at the mark’s
current location, the mark will be moved to the left of the
newly-inserted text. If the mark has right gravity
(left_gravity = false), the mark will end up on the right of
newly-inserted text. The standard left-to-right cursor is a mark
with right gravity (when you type, the cursor stays on the right
side of the text you’re typing).
The caller of this function does not own a reference to the returned Gtk.TextMark, so you can ignore the return value if you like. Marks are owned by the buffer and go away when the buffer does.
Emits the Gtk.TextBuffer::mark-set signal as notification
of the mark's initial placement.
the new Gtk.TextMark object
Copies the currently-selected text to a clipboard, then deletes said text if it’s editable.
the Gdk.Clipboard object to cut to
default editability of the buffer
Deletes text between start and end.
The order of start and end is not actually relevant;
gtk_text_buffer_delete() will reorder them.
This function actually emits the “delete-range” signal, and
the default handler of that signal deletes the text. Because the
buffer is modified, all outstanding iterators become invalid after
calling this function; however, the start and end will be
re-initialized to point to the location where text was deleted.
Deletes all editable text in the given range.
Calls Gtk.TextBuffer.delete for each editable
sub-range of [start,end). start and end are revalidated
to point to the location of the last deleted range, or left
untouched if no text was deleted.
whether some text was actually deleted
Deletes mark, so that it’s no longer located anywhere in the
buffer.
Removes the reference the buffer holds to the mark, so if
you haven’t called g_object_ref() on the mark, it will be freed.
Even if the mark isn’t freed, most operations on mark become
invalid, until it gets added to a buffer again with
Gtk.TextBuffer.add_mark. Use Gtk.TextMark.get_deleted
to find out if a mark has been removed from its buffer.
The Gtk.TextBuffer::mark-deleted signal will be emitted as
notification after the mark is deleted.
a Gtk.TextMark in buffer
Deletes the mark named name; the mark must exist.
See Gtk.TextBuffer.delete_mark for details.
name of a mark in buffer
Deletes the range between the “insert” and “selection_bound” marks, that is, the currently-selected text.
If interactive is true, the editability of the selection will be
considered (users can’t delete uneditable text).
whether the deletion is caused by user interaction
whether the buffer is editable by default
whether there was a non-empty selection to delete
SignalemitDenotes the end of an action that may not be undone.
This will cause any previous operations in the undo/redo queue to be cleared.
This should be called after completing modifications to the text buffer after Gtk.TextBuffer.begin_irreversible_action was called.
You may nest calls to gtk_text_buffer_begin_irreversible_action()
and gtk_text_buffer_end_irreversible_action() pairs.
Ends a user-visible operation.
Should be paired with a call to Gtk.TextBuffer.begin_user_action. See that function for a full explanation.
Gets whether there is a redoable action in the history.
true if there is a redoable action
Gets whether there is an undoable action in the history.
true if there is an undoable action
Gets the number of characters in the buffer.
Note that characters and bytes are not the same, you can’t e.g. expect the contents of the buffer in string form to be this many bytes long.
The character count is cached, so this function is very fast.
number of characters in the buffer
Gets whether the buffer is saving modifications to the buffer to allow for undo and redo actions.
See Gtk.TextBuffer.begin_irreversible_action and Gtk.TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.
true if undoing and redoing changes to the buffer is allowed.
Initializes iter with the “end iterator,” one past the last valid
character in the text buffer.
If dereferenced with Gtk.TextIter.get_char, the end iterator has a character value of 0. The entire buffer lies in the range from the first position in the buffer (call Gtk.TextBuffer.get_start_iter to get character position 0) to the end iterator.
Indicates whether the buffer has some text currently selected.
true if the there is text selected
Returns the mark that represents the cursor (insertion point).
Equivalent to calling Gtk.TextBuffer.get_mark to get the mark named “insert”, but very slightly more efficient, and involves less typing.
insertion point mark
Obtains the location of anchor within buffer.
a child anchor that appears in buffer
Obtains an iterator pointing to byte_index within the given line.
byte_index must be the start of a UTF-8 character. Note bytes, not
characters; UTF-8 may encode one character as multiple bytes.
If line_number is greater than or equal to the number of lines in the buffer,
the end iterator is returned. And if byte_index is off the
end of the line, the iterator at the end of the line is returned.
line number counting from 0
byte index from start of line
whether the exact position has been found
Obtains an iterator pointing to char_offset within the given line.
Note characters, not bytes; UTF-8 may encode one character as multiple bytes.
If line_number is greater than or equal to the number of lines in the buffer,
the end iterator is returned. And if char_offset is off the
end of the line, the iterator at the end of the line is returned.
line number counting from 0
char offset from start of line
whether the exact position has been found
Initializes iter with the current position of mark.
a Gtk.TextMark in buffer
Initializes iter to a position char_offset chars from the start
of the entire buffer.
If char_offset is -1 or greater than the number
of characters in the buffer, iter is initialized to the end iterator,
the iterator one past the last valid character in the buffer.
char offset from start of buffer, counting from 0, or -1
Obtains the number of lines in the buffer.
This value is cached, so the function is very fast.
number of lines in the buffer
Gets the maximum number of undo levels to perform.
If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.
The max number of undo levels allowed (0 indicates unlimited).
Indicates whether the buffer has been modified since the last call
to Gtk.TextBuffer.set_modified set the modification flag to
false.
Used for example to enable a “save” function in a text editor.
true if the buffer has been modified
Returns the mark that represents the selection bound.
Equivalent to calling Gtk.TextBuffer.get_mark to get the mark named “selection_bound”, but very slightly more efficient, and involves less typing.
The currently-selected text in buffer is the region between the
“selection_bound” and “insert” marks. If “selection_bound” and
“insert” are in the same place, then there is no current selection.
Gtk.TextBuffer.get_selection_bounds is another convenient
function for handling the selection, if you just want to know whether
there’s a selection and what its bounds are.
selection bound mark
Returns true if some text is selected; places the bounds
of the selection in start and end.
If the selection has length 0, then start and end are filled
in with the same value. start and end will be in ascending order.
If start and end are null, then they are not filled in, but the
return value still indicates whether text is selected.
whether the selection has nonzero length
Get a content provider for this buffer.
It can be used to make the content of buffer available
in a Gdk.Clipboard, see Gdk.Clipboard.set_content.
a new Gdk.ContentProvider.
Returns the text in the range [start,end).
Excludes undisplayed text (text marked with tags that set the
invisibility attribute) if include_hidden_chars is false.
The returned string includes a 0xFFFC character whenever the
buffer contains embedded images, so byte and character indexes
into the returned string do correspond to byte and character
indexes into the buffer. Contrast with Gtk.TextBuffer.get_text.
Note that 0xFFFC can occur in normal text as well, so it is not a
reliable indicator that a paintable or widget is in the buffer.
an allocated UTF-8 string
Initialized iter with the first position in the text buffer.
This is the same as using Gtk.TextBuffer.get_iter_at_offset to get the iter at character offset 0.
Get the Gtk.TextTagTable associated with this buffer.
the buffer’s tag table
Returns the text in the range [start,end).
Excludes undisplayed text (text marked with tags that set the
invisibility attribute) if include_hidden_chars is false.
Does not include characters representing embedded images, so
byte and character indexes into the returned string do not
correspond to byte and character indexes into the buffer.
Contrast with Gtk.TextBuffer.get_slice.
an allocated UTF-8 string
Inserts len bytes of text at position iter.
If len is -1, text must be nul-terminated and will be inserted in its
entirety. Emits the “insert-text” signal; insertion actually occurs
in the default handler for the signal. iter is invalidated when
insertion occurs (because the buffer contents change), but the
default signal handler revalidates it to point to the end of the
inserted text.
Inserts text in buffer.
Simply calls Gtk.TextBuffer.insert, using the current cursor position as the insertion point.
text in UTF-8 format
length of text, in bytes
Inserts a child widget anchor into the text buffer at iter.
The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for child anchors, but the “text” variants do not. E.g. see Gtk.TextBuffer.get_slice and Gtk.TextBuffer.get_text.
Consider Gtk.TextBuffer.create_child_anchor as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.
location to insert the anchor
Inserts text in buffer.
Like Gtk.TextBuffer.insert, but the insertion will not occur
if iter is at a non-editable location in the buffer. Usually you
want to prevent insertions at ineditable locations if the insertion
results from a user action (is interactive).
default_editable indicates the editability of text that doesn't
have a tag affecting editability applied to it. Typically the
result of Gtk.TextView.get_editable is appropriate here.
whether text was actually inserted
Inserts text in buffer.
Calls Gtk.TextBuffer.insert_interactive at the cursor position.
default_editable indicates the editability of text that doesn't
have a tag affecting editability applied to it. Typically the
result of Gtk.TextView.get_editable is appropriate here.
text in UTF-8 format
length of text in bytes, or -1
default editability of buffer
whether text was actually inserted
Inserts the text in markup at position iter.
markup will be inserted in its entirety and must be nul-terminated
and valid UTF-8. Emits the Gtk.TextBuffer::insert-text signal,
possibly multiple times; insertion actually occurs in the default handler
for the signal. iter will point to the end of the inserted text on return.
Inserts an image into the text buffer at iter.
The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for paintable, but the “text” variants do not. e.g. see Gtk.TextBuffer.get_slice and Gtk.TextBuffer.get_text.
Copies text, tags, and paintables between start and end
and inserts the copy at iter.
The order of start and end doesn’t matter.
Used instead of simply getting/inserting text because it preserves
images and tags. If start and end are in a different buffer from
buffer, the two buffers must share the same tag table.
Implemented via emissions of the ::insert-text and ::apply-tag signals, so expect those.
Copies text, tags, and paintables between start and end
and inserts the copy at iter.
Same as Gtk.TextBuffer.insert_range, but does nothing
if the insertion point isn’t editable. The default_editable
parameter indicates whether the text is editable at iter if
no tags enclosing iter affect editability. Typically the result
of Gtk.TextView.get_editable is appropriate here.
whether an insertion was possible at iter
Moves the mark named name (which must exist) to location where.
See Gtk.TextBuffer.move_mark for details.
Pastes the contents of a clipboard.
If override_location is null, the pasted text will be inserted
at the cursor position, or the buffer selection will be replaced
if the selection is non-empty.
Note: pasting is asynchronous, that is, we’ll ask for the paste data and return, and at some point later after the main loop runs, the paste data will be inserted.
the Gdk.Clipboard to paste from
location to insert pasted text
whether the buffer is editable by default
This function moves the “insert” and “selection_bound” marks simultaneously.
If you move them to the same place in two steps with Gtk.TextBuffer.move_mark, you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.
Redoes the next redoable action on the buffer, if there is one.
Removes all tags in the range between start and end.
Be careful with this function; it could remove tags added in code unrelated to the code you’re currently writing. That is, using this function is probably a bad idea if you have two or more unrelated code sections that add tags.
Removes the Gtk.TextBufferCommitNotify handler previously registered with Gtk.TextBuffer.add_commit_notify.
This may result in the user_data_destroy being called that was passed when registering
the commit notify functions.
the notify handler identifier returned from Gtk.TextBuffer.add_commit_notify.
Removes a Gdk.Clipboard added with Gtk.TextBuffer.add_selection_clipboard
a Gdk.Clipboard added to buffer by Gtk.TextBuffer.add_selection_clipboard
Emits the “remove-tag” signal.
The default handler for the signal removes all occurrences
of tag from the given range. start and end don’t have
to be in order.
Emits the “remove-tag” signal.
Calls Gtk.TextTagTable.lookup on the buffer’s tag table to get a Gtk.TextTag, then calls Gtk.TextBuffer.remove_tag.
name of a Gtk.TextTag
one bound of range to be untagged
other bound of range to be untagged
This function moves the “insert” and “selection_bound” marks simultaneously.
If you move them in two steps with Gtk.TextBuffer.move_mark, you will temporarily select a region in between their old and new locations, which can be pretty inefficient since the temporarily-selected region will force stuff to be recalculated. This function moves them as a unit, which can be optimized.
Sets whether or not to enable undoable actions in the text buffer.
Undoable actions in this context are changes to the text content of the buffer. Changes to tags and marks are not tracked.
If enabled, the user will be able to undo the last number of actions up to Gtk.TextBuffer.get_max_undo_levels.
See Gtk.TextBuffer.begin_irreversible_action and Gtk.TextBuffer.end_irreversible_action to create changes to the buffer that cannot be undone.
true to enable undo
Sets the maximum number of undo levels to perform.
If 0, unlimited undo actions may be performed. Note that this may have a memory usage impact as it requires storing an additional copy of the inserted or removed text within the text buffer.
the maximum number of undo actions to perform
Used to keep track of whether the buffer has been modified since the last time it was saved.
Whenever the buffer is saved to disk, call
gtk_text_buffer_set_modified (buffer, FALSE).
When the buffer is modified, it will automatically
toggle on the modified bit again. When the modified
bit flips, the buffer emits the
Gtk.TextBuffer::modified-changed signal.
modification flag setting
Deletes current contents of buffer, and inserts text instead. This is
automatically marked as an irreversible action in the undo stack. If you
wish to mark this action as part of a larger undo operation, call
TextBuffer.delete and TextBuffer.insert directly instead.
If len is -1, text must be nul-terminated.
text must be valid UTF-8.
UTF-8 text to insert
length of text in bytes
Undoes the last undoable action on the buffer, if there is one.
Virtualvfunc_Virtualvfunc_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.
The operations between gtk_text_buffer_begin_user_action() and
gtk_text_buffer_end_user_action() can then be grouped when creating
an undo stack. Gtk.TextBuffer maintains a count of calls to
gtk_text_buffer_begin_user_action() that have not been closed with
a call to gtk_text_buffer_end_user_action(), and emits the
“begin-user-action” and “end-user-action” signals only for the
outermost pair of calls. This allows you to build user actions
from other user actions.
The “interactive” buffer mutation functions, such as Gtk.TextBuffer.insert_interactive, automatically call begin/end user action around the buffer operations they perform, so there's no need to add extra calls if you user action consists solely of a single call to one of those functions.
Virtualvfunc_The class handler for the Gtk.TextBuffer::changed signal.
Virtualvfunc_Virtualvfunc_Ends a user-visible operation.
Should be paired with a call to Gtk.TextBuffer.begin_user_action. See that function for a full explanation.
Virtualvfunc_Inserts a child widget anchor into the text buffer at iter.
The anchor will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for child anchors, but the “text” variants do not. E.g. see Gtk.TextBuffer.get_slice and Gtk.TextBuffer.get_text.
Consider Gtk.TextBuffer.create_child_anchor as a more convenient alternative to this function. The buffer will add a reference to the anchor, so you can unref it after insertion.
location to insert the anchor
Virtualvfunc_Inserts an image into the text buffer at iter.
The image will be counted as one character in character counts, and when obtaining the buffer contents as a string, will be represented by the Unicode “object replacement character” 0xFFFC. Note that the “slice” variants for obtaining portions of the buffer as a string include this character for paintable, but the “text” variants do not. e.g. see Gtk.TextBuffer.get_slice and Gtk.TextBuffer.get_text.
Virtualvfunc_Virtualvfunc_Virtualvfunc_Virtualvfunc_The class handler for the Gtk.TextBuffer::modified-changed signal.
Virtualvfunc_Virtualvfunc_Redoes the next redoable action on the buffer, if there is one.
Virtualvfunc_Emits the “remove-tag” signal.
The default handler for the signal removes all occurrences
of tag from the given range. start and end don’t have
to be in order.
Virtualvfunc_Undoes the last undoable action on the buffer, if there is one.
StaticnewOptionaltable: Gtk.TextTagTableCreates 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:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget GObject.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
GObject.Binding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A GObject.Object can have multiple bindings.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Complete version of g_object_bind_property().
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.
If flags contains GObject.BindingFlags.BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well. The transform_from function is only used in case
of bidirectional bindings, otherwise it will be ignored
The binding will automatically be removed when either the source or the
target instances are finalized. This will release the reference that is
being held on the GObject.Binding instance; if you want to hold on to the
GObject.Binding instance, you will need to hold a reference to it.
To remove the binding, call g_binding_unbind().
A GObject.Object can have multiple bindings.
The same user_data parameter will be used for both transform_to
and transform_from transformation functions; the notify function will
be called once, when the binding is removed. If you need different data
for each transformation function, please use
g_object_bind_property_with_closures() instead.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
Optionaltransform_to: BindingTransformFuncthe transformation function from the source to the target, or null to use the default
Optionaltransform_from: BindingTransformFuncthe transformation function from the target to the source, or null to use the default
Optionalnotify: DestroyNotifya function to call when disposing the binding, to free resources used by the transformation functions, or null if not required
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
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.
This function is the language bindings friendly version of
g_object_bind_property_full(), using GClosures instead of
function pointers.
the property on source to bind
the target GObject.Object
the property on target to bind
flags to pass to GObject.Binding
a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default
a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default
the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.
Blocks a handler of an instance so it will not be called during any signal emissions
Handler ID of the handler to be blocked
Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.
Handler ID of the handler to be disconnected
This function is intended for GObject.Object 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().
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.Object::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
the data if found, or null if no such data exists.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.
Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.
The name of the property to get
Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type
This function gets back user data pointers stored via
g_object_set_qdata().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
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.
the names of each property to get
the values of each property to get
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than
g_object_notify().
One way to avoid using g_object_notify() from within the
class that registered the properties, and using g_object_notify_by_pspec()
instead, is to store the GParamSpec used with
g_object_class_install_property() inside a static array, e.g.:
typedef enum
{
PROP_FOO = 1,
PROP_LAST
} MyObjectProperty;
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
0, 100,
50,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the GObject.ParamSpec of a property installed on the class of object.
Increases the reference count of object.
Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type
of object will be propagated to the return type (using the GCC typeof()
extension), so any casting the caller needs to do on the return type must be
explicit.
the same object
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
object
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.
Object containing the properties to set
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a GLib.Quark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the GLib.Quark storage growing unbounded.
name of the key
Optionaldata: anydata to associate with that key
Sets a property on an object.
The name of the property to set
The value to set the property to
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
the data if found, or null if no such data exists.
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:
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);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of
g_object_steal_qdata() would have left the destroy function set,
and thus the partial string list would have been freed upon
g_object_set_qdata_full().
A GLib.Quark, naming the user data pointer
The user data pointer set, or null
Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.
Name of the signal to stop emission of
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.
Duplicate notifications for each property are squashed so that at most one GObject.Object::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Unblocks a handler so it will be called again during any signal emissions
Handler ID of the handler to be unblocked
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the GObject.Object may be reused in future (for example, if it is
an instance variable of another object), it is recommended to clear the
pointer to null rather than retain a dangling pointer to a potentially
invalid GObject.Object instance. Use g_clear_object() for this.
Virtualvfunc_the constructed function is called by g_object_new() as the
final step of the object creation process. At the point of the call, all
construction properties have been set on the object. The purpose of this
call is to allow for object initialisation steps that can only be performed
after construction properties have been set. constructed implementors
should chain up to the constructed call of their parent class to allow it
to complete its initialisation.
Virtualvfunc_Virtualvfunc_the dispose function is supposed to drop all references to other
objects, but keep the instance otherwise intact, so that client method
invocations still work. It may be run multiple times (due to reference
loops). Before returning, dispose should chain up to the dispose method
of the parent class.
Virtualvfunc_instance finalization function, should finish the finalization of
the instance begun in dispose and chain up to the finalize method of the
parent class.
Virtualvfunc_Virtualvfunc_Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class
that registered the property, you should use g_object_notify_by_pspec()
instead.
Note that emission of the notify signal may be blocked with
g_object_freeze_notify(). In this case, the signal emissions are queued
and will be emitted (in reverse order) when g_object_thaw_notify() is
called.
Virtualvfunc_the generic setter for all properties of this type. Should be
overridden for every type with properties. If implementations of
set_property don't emit property change notification explicitly, this will
be done implicitly by the type system. However, if the notify signal is
emitted explicitly, the type system will not emit it a second time.
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.
GObject.Closure to watch
Static_Staticcompat_Optionaldata: anyStaticfind_Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinterface_Find the GObject.ParamSpec 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().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Staticinterface_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 GObject.ParamSpec, 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.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
GObject.TypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the GObject.ParamSpec for the new property
Staticinterface_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().
any interface vtable for the interface, or the default vtable for the interface
Staticlist_StaticnewvStaticoverride_the new property ID
the name of a property registered in a parent class or in an interface of this class.
Stores text and attributes for display in a Gtk.TextView.
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.
GtkTextBuffer can support undoing changes to the buffer content, see Gtk.TextBuffer.set_enable_undo.