Optionalproperties: Partial<Gtk.TextView.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$gtypeWhether Tab will result in a tab character being entered.
Whether Tab will result in a tab character being entered.
The bottom margin for text in the text view.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
Don't confuse this property with Gtk.Widget.margin_bottom.
The bottom margin for text in the text view.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
Don't confuse this property with Gtk.Widget.margin_bottom.
The buffer which is displayed.
If the insertion cursor is shown.
If the insertion cursor is shown.
Whether the text can be modified by the user.
Which IM (input method) module should be used for this text_view.
See Gtk.IMMulticontext.
Setting this to a non-null value overrides the system-wide IM module
setting. See the GtkSettings Gtk.Settings.gtk_im_module property.
Which IM (input method) module should be used for this text_view.
See Gtk.IMMulticontext.
Setting this to a non-null value overrides the system-wide IM module
setting. See the GtkSettings Gtk.Settings.gtk_im_module property.
Amount to indent the paragraph, in pixels.
A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.
Additional hints (beyond Gtk.TextView.input_purpose) that allow input methods to fine-tune their behaviour.
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Additional hints (beyond Gtk.TextView.input_purpose) that allow input methods to fine-tune their behaviour.
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Left, right, or center justification.
The default left margin for text in the text view.
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
The default left margin for text in the text view.
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
Whether text should be displayed in a monospace font.
If true, set the .monospace style class on the
text view to indicate that a monospace font is desired.
Whether entered text overwrites existing contents.
Pixels of blank space above paragraphs.
Pixels of blank space below paragraphs.
Pixels of blank space between wrapped lines in a paragraph.
Pixels of blank space above paragraphs.
Pixels of blank space below paragraphs.
Pixels of blank space between wrapped lines in a paragraph.
The default right margin for text in the text view.
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
The default right margin for text in the text view.
Tags in the buffer may override the default.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
The top margin for text in the text view.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
Don't confuse this property with Gtk.Widget.margin_top.
The top margin for text in the text view.
Note that this property is confusingly named. In CSS terms, the value set here is padding, and it is applied in addition to the padding from the theme.
Don't confuse this property with Gtk.Widget.margin_top.
The accessible role of the given Gtk.Accessible implementation.
The accessible role cannot be changed once set.
The accessible role of the given Gtk.Accessible implementation.
The accessible role cannot be changed once set.
The accessible role of the given Gtk.Accessible implementation.
The accessible role cannot be changed once set.
The accessible role of the given Gtk.Accessible implementation.
The accessible role cannot be changed once set.
Horizontal Gtk.Adjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Horizontal Gtk.Adjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Determines when horizontal scrolling should start.
Determines when horizontal scrolling should start.
Vertical Gtk.Adjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Vertical Gtk.Adjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Determines when vertical scrolling should start.
Determines when vertical scrolling should start.
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Whether the widget can receive pointer events.
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Whether the widget can receive pointer events.
A list of css classes applied to this widget.
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
A list of css classes applied to this widget.
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Whether this widget itself will accept the input focus.
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Whether the widget is the default widget.
Whether the widget has the input focus.
Enables or disables the emission of the Gtk.Widget::query-tooltip
signal on widget.
A true value indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget::query-tooltip to
determine whether it will provide a tooltip or not.
Whether the widget is the default widget.
Whether the widget has the input focus.
Enables or disables the emission of the Gtk.Widget::query-tooltip
signal on widget.
A true value indicates that widget can have a tooltip, in this case
the widget will be queried using Gtk.Widget::query-tooltip to
determine whether it will provide a tooltip or not.
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Whether to expand horizontally.
Whether to use the hexpand property.
Whether to use the hexpand property.
The Gtk.LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
The Gtk.LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk.EventController.set_propagation_limit.
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk.EventController.set_propagation_limit.
Margin on bottom side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on end of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on start of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on top side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on bottom side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on end of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on start of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
Margin on top side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Gtk.Widget.set_size_request for example.
The name of the widget.
The requested opacity of the widget.
Whether the widget will receive the default action when it is focused.
Whether the widget will receive the default action when it is focused.
The scale factor of the widget.
The scale factor of the widget.
Whether the widget responds to input.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Gtk.Tooltip.set_markup.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Gtk.Widget.has_tooltip will automatically be set to true
and there will be taken care of Gtk.Widget::query-tooltip in
the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see Gtk.Tooltip.set_text.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Gtk.Widget.has_tooltip will automatically be set to true
and there will be taken care of Gtk.Widget::query-tooltip in
the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Gtk.Tooltip.set_markup.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Gtk.Widget.has_tooltip will automatically be set to true
and there will be taken care of Gtk.Widget::query-tooltip in
the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Sets the text of tooltip to be the given string.
Also see Gtk.Tooltip.set_text.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Gtk.Widget.has_tooltip will automatically be set to true
and there will be taken care of Gtk.Widget::query-tooltip in
the default signal handler.
Note that if both Gtk.Widget.tooltip_text and Gtk.Widget.tooltip_markup are set, the last one wins.
Whether to expand vertically.
Whether to use the vexpand property.
Whether to use the vexpand property.
Whether the widget is visible.
Overrides for width request of the widget.
If this is -1, the natural request will be used.
Overrides for width request of the widget.
If this is -1, the natural request will be used.
Adds a child widget in the text buffer, at the given anchor.
a Gtk.TextChildAnchor in the Gtk.TextBuffer for text_view
Adds child at a fixed coordinate in the Gtk.TextView's text window.
The xpos and ypos must be in buffer coordinates (see
Gtk.TextView.get_iter_location to convert to
buffer coordinates).
child will scroll with the text view.
If instead you want a widget that will not move with the Gtk.TextView contents see Gtk.Overlay.
Requests the user's screen reader to announce the given message.
This kind of notification is useful for messages that either have only a visual representation or that are not exposed visually at all, e.g. a notification about a successful operation.
Also, by using this API, you can ensure that the message does not interrupts the user's current screen reader output.
the string to announce
the priority of the announcement
Moves the given iter backward by one display (wrapped) line.
A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the Gtk.TextBuffer.
true if iter was moved and is not on the end iterator
Moves the given iter backward to the next display line start.
A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the Gtk.TextBuffer.
true if iter was moved and is not on the end iterator
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:
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 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
Converts buffer coordinates to window coordinates.
buffer x coordinate
buffer y coordinate
SignalconnectSignalconnect_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
SignalemitThis 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().
Moves the given iter forward by one display (wrapped) line.
A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the Gtk.TextBuffer.
true if iter was moved and is not on the end iterator
Moves the given iter forward to the next display line end.
A display line is different from a paragraph. Paragraphs are separated by newlines or other paragraph separator characters. Display lines are created by line-wrapping a paragraph. If wrapping is turned off, display lines and paragraphs will be the same. Display lines are divided differently for each view, since they depend on the view’s width; paragraphs are the same in all views, since they depend on the contents of the Gtk.TextBuffer.
true if iter was moved and is not on the end iterator
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.
Returns whether pressing the Tab key inserts a tab characters.
true if pressing the Tab key inserts a tab character, false if pressing the Tab key moves the keyboard focus.
Retrieves the accessible parent for an accessible object.
This function returns NULL for top level widgets.
the accessible parent
Retrieves the accessible role of an accessible object.
the accessible role
Gets the bottom margin for text in the text_view.
bottom margin in pixels
Queries the coordinates and dimensions of this accessible
This functionality can be overridden by Gtk.Accessible implementations, e.g. to get the bounds from an ignored child widget.
true if the bounds are valid, and false otherwise
Returns the Gtk.TextBuffer being displayed by this text view.
The reference count on the buffer is not incremented; the caller of this function won’t own a new reference.
Gets the ID of the buildable object.
Gtk.Builder sets the name based on the ID attribute
of the <object> tag used to construct the buildable.
the ID of the buildable object
Determine the positions of the strong and weak cursors if the
insertion point is at iter.
The position of each cursor is stored as a zero-width rectangle. The strong cursor location is the location where characters of the directionality equal to the base direction of the paragraph are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the paragraph are inserted.
If iter is null, the actual cursor position is used.
Note that if iter happens to be the actual cursor position, and
there is currently an IM preedit sequence being entered, the
returned locations will be adjusted to account for the preedit
cursor’s offset within the preedit sequence.
The rectangle position is in buffer coordinates; use Gtk.TextView.buffer_to_window_coords to convert these coordinates to coordinates for one of the windows in the text view.
Find out whether the cursor should be displayed.
whether the insertion mark is visible
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.
Returns the default editability of the Gtk.TextView.
Tags in the buffer may override this setting for some ranges of text.
whether text is editable by default
Retrieves the first accessible child of an accessible object.
the first accessible child
Gets a Gtk.Widget that has previously been set as gutter.
win must be one of Gtk.TextWindowType.LEFT, Gtk.TextWindowType.RIGHT,
Gtk.TextWindowType.TOP, or Gtk.TextWindowType.BOTTOM.
Retrieves the Gtk.Adjustment used for horizontal scrolling.
horizontal Gtk.Adjustment.
Gets the horizontal Gtk.ScrollablePolicy.
The horizontal Gtk.ScrollablePolicy.
Gets the default indentation of paragraphs in text_view.
Tags in the view’s buffer may override the default. The indentation may be negative.
number of pixels of indentation
Retrieves the iterator at buffer coordinates x and y.
Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with Gtk.TextView.window_to_buffer_coords.
x position, in buffer coordinates
y position, in buffer coordinates
true if the position is over text
Retrieves the iterator pointing to the character at buffer
coordinates x and y.
Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with Gtk.TextView.window_to_buffer_coords.
Note that this is different from Gtk.TextView.get_iter_at_location, which returns cursor locations, i.e. positions between characters.
x position, in buffer coordinates
y position, in buffer coordinates
true if the position is over text
Gets a rectangle which roughly contains the character at iter.
The rectangle position is in buffer coordinates; use Gtk.TextView.buffer_to_window_coords to convert these coordinates to coordinates for one of the windows in the text view.
Gets the default justification of paragraphs in text_view.
Tags in the buffer may override the default.
default justification
Gets the default left margin size of paragraphs in the text_view.
Tags in the buffer may override the default.
left margin in pixels
Gets the Gtk.TextIter at the start of the line containing
the coordinate y.
y is in buffer coordinates, convert from window coordinates with
Gtk.TextView.window_to_buffer_coords. If non-null,
line_top will be filled with the coordinate of the top edge
of the line.
a y coordinate
Gets the y coordinate of the top of the line containing iter,
and the height of the line.
The coordinate is a buffer coordinate; convert to window coordinates with Gtk.TextView.buffer_to_window_coords.
Gets the Pango.Context that is used for rendering LTR directed text layouts.
The context may be replaced when CSS changes occur.
Gets whether the Gtk.TextView uses monospace styling.
true if monospace fonts are desired
Retrieves the next accessible sibling of an accessible object
the next accessible sibling
Returns whether the Gtk.TextView is in overwrite mode or not.
whether text_view is in overwrite mode or not.
Gets the default number of pixels to put above paragraphs.
Adding this function with Gtk.TextView.get_pixels_below_lines is equal to the line space between each paragraph.
default number of pixels above paragraphs
Gets the default number of pixels to put below paragraphs.
The line space is the sum of the value returned by this function and the value returned by Gtk.TextView.get_pixels_above_lines.
default number of blank pixels below paragraphs
Gets the default number of pixels to put between wrapped lines inside a paragraph.
default number of pixels of blank space between wrapped lines
Queries a platform state, such as focus.
This functionality can be overridden by Gtk.Accessible implementations, e.g. to get platform state from an ignored child widget, as is the case for Gtk.Text wrappers.
platform state to query
the value of state for the accessible
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 the default right margin for text in text_view.
Tags in the buffer may override the default.
right margin in pixels
Gets the Pango.Context that is used for rendering RTL directed text layouts.
The context may be replaced when CSS changes occur.
Gets the default tabs for text_view.
Tags in the buffer may override the defaults. The returned array
will be null if “standard” (8-space) tabs are used. Free the
return value with Pango.TabArray.free.
copy of default tab array, or null if standard tabs are used; must be freed with Pango.TabArray.free.
Gets the top margin for text in the text_view.
top margin in pixels
Retrieves the Gtk.Adjustment used for vertical scrolling.
vertical Gtk.Adjustment.
Gets the X,Y offset in buffer coordinates of the top-left corner of the textview's text contents.
This allows for more-precise positioning than what is provided by Gtk.TextView.get_visible_rect as you can discover what device pixel is being quantized for text positioning.
You might want this when making ulterior widgets align with quantized device pixels of the textview contents such as line numbers.
Fills visible_rect with the currently-visible
region of the buffer, in buffer coordinates.
Convert to window coordinates with Gtk.TextView.buffer_to_window_coords.
Gets the vertical Gtk.ScrollablePolicy.
The vertical Gtk.ScrollablePolicy.
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
Allow the Gtk.TextView input method to internally handle key press and release events.
If this function returns true, then no further processing should be
done for this key event. See Gtk.IMContext.filter_keypress.
Note that you are expected to call this function from your handler when overriding key event handling. This is needed in the case when you need to insert your own key handling between the input method and the default key event handling of the Gtk.TextView.
static gboolean
gtk_foo_bar_key_press_event (GtkWidget *widget,
GdkEvent *event)
{
guint keyval;
gdk_event_get_keyval ((GdkEvent*)event, &keyval);
if (keyval == GDK_KEY_Return || keyval == GDK_KEY_KP_Enter)
{
if (gtk_text_view_im_context_filter_keypress (GTK_TEXT_VIEW (widget), event))
return TRUE;
}
// Do some stuff
return GTK_WIDGET_CLASS (gtk_foo_bar_parent_class)->key_press_event (widget, event);
}
true if the input method handled the key event.
Checks whether object has a [floating][floating-ref] reference.
true if object has a floating reference
Updates the position of a child.
a widget already added with Gtk.TextView.add_overlay
new X position in buffer coordinates
new Y position in buffer coordinates
Move the iterator a given number of characters visually, treating it as the strong cursor position.
If count is positive, then the new strong cursor position will
be count positions to the right of the old cursor position.
If count is negative then the new strong cursor position will
be count positions to the left of the old cursor position.
In the presence of bi-directional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.
true if iter moved and is not on the end iterator
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.
Moves the cursor to the currently visible region of the buffer.
true if the cursor had to be moved.
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
Ensures that the cursor is shown.
This also resets the time that it will stay blinking (or visible, in case blinking is disabled).
This function should be called in response to user input (e.g. from derived classes that override the textview's event handlers).
Reset the input method context of the text view if needed.
This can be necessary in the case where modifying the buffer would confuse on-going input method behavior.
Resets the accessible property to its default value.
the accessible property
Resets the accessible relation to its default value.
the accessible relation
Resets the accessible state to its default value.
the accessible state
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Scrolls text_view so that iter is on the screen in the position
indicated by xalign and yalign.
An alignment of 0.0 indicates left or top, 1.0 indicates right or
bottom, 0.5 means center. If use_align is false, the text scrolls
the minimal distance to get the mark onscreen, possibly not scrolling
at all. The effective screen for purposes of this function is reduced
by a margin of size within_margin.
Note that this function uses the currently-computed height of the lines in the text buffer. Line heights are computed in an idle handler; so this function may not have the desired effect if it’s called before the height computations. To avoid oddness, consider using Gtk.TextView.scroll_to_mark which saves a point to be scrolled to after line validation.
margin as a [0.0,0.5) fraction of screen size
whether to use alignment arguments (if false, just get the mark onscreen)
horizontal alignment of mark within visible area
vertical alignment of mark within visible area
true if scrolling occurred
Scrolls text_view so that mark is on the screen in the position
indicated by xalign and yalign.
An alignment of 0.0 indicates left or top, 1.0 indicates right or
bottom, 0.5 means center. If use_align is false, the text scrolls
the minimal distance to get the mark onscreen, possibly not scrolling
at all. The effective screen for purposes of this function is reduced
by a margin of size within_margin.
margin as a [0.0,0.5) fraction of screen size
whether to use alignment arguments (if false, just get the mark onscreen)
horizontal alignment of mark within visible area
vertical alignment of mark within visible area
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
Sets the behavior of the text widget when the Tab key is pressed.
If accepts_tab is true, a tab character is inserted. If accepts_tab
is false the keyboard focus is moved to the next widget in the focus
chain.
Focus can always be moved using Ctrl+Tab.
true if pressing the Tab key should insert a tab character, false, if pressing the Tab key should move the keyboard focus.
Sets the parent and sibling of an accessible object.
This function is meant to be used by accessible implementations that are not part of the widget hierarchy, and but act as a logical bridge between widgets. For instance, if a widget creates an object that holds metadata for each child, and you want that object to implement the Gtk.Accessible interface, you will use this function to ensure that the parent of each child widget is the metadata object, and the parent of each metadata object is the container widget.
Optionalparent: Gtk.Accessiblethe parent accessible object
Optionalnext_sibling: Gtk.Accessiblethe sibling accessible object
Sets the bottom margin for text in text_view.
Note that this function is confusingly named. In CSS terms, the value set here is padding.
bottom margin in pixels
Sets buffer as the buffer being displayed by text_view.
The previous buffer displayed by the text view is unreferenced, and
a reference is added to buffer. If you owned a reference to buffer
before passing it to this function, you must remove that reference
yourself; Gtk.TextView will not “adopt” it.
Optionalbuffer: Gtk.TextBufferToggles whether the insertion point should be displayed.
A buffer with no editable text probably shouldn’t have a visible cursor, so you may want to turn the cursor off.
Note that this property may be overridden by the Gtk.Settings.gtk_keynav_use_caret setting.
whether to show the insertion cursor
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 the default editability of the Gtk.TextView.
You can override this default setting with tags in the buffer, using the “editable” attribute of tags.
whether it’s editable
Places widget into the gutter specified by win.
win must be one of Gtk.TextWindowType.LEFT, Gtk.TextWindowType.RIGHT,
Gtk.TextWindowType.TOP, or Gtk.TextWindowType.BOTTOM.
Optionalwidget: Gtk.WidgetSets the horizontal adjustment of the Gtk.Scrollable.
Optionalhadjustment: Gtk.AdjustmentSets the Gtk.ScrollablePolicy.
The policy determines whether horizontal scrolling should start below the minimum width or below the natural width.
the horizontal Gtk.ScrollablePolicy
Sets the default indentation for paragraphs in text_view.
Tags in the buffer may override the default.
indentation in pixels
Sets the input-hints of the Gtk.TextView.
The input-hints allow input methods to fine-tune
their behaviour.
the hints
Sets the input-purpose of the Gtk.TextView.
The input-purpose can be used by on-screen keyboards
and other input methods to adjust their behaviour.
the purpose
Sets the default justification of text in text_view.
Tags in the view’s buffer may override the default.
justification
Sets the default left margin for text in text_view.
Tags in the buffer may override the default.
Note that this function is confusingly named. In CSS terms, the value set here is padding.
left margin in pixels
Sets whether the Gtk.TextView should display text in monospace styling.
true to request monospace styling
Changes the Gtk.TextView overwrite mode.
true to turn on overwrite mode, false to turn it off
Sets the default number of blank pixels above paragraphs in text_view.
Tags in the buffer for text_view may override the defaults.
pixels above paragraphs
Sets the default number of pixels of blank space
to put below paragraphs in text_view.
May be overridden by tags applied to text_view’s buffer.
pixels below paragraphs
Sets the default number of pixels of blank space to leave between display/wrapped lines within a paragraph.
May be overridden by tags in text_view’s buffer.
default number of pixels between wrapped lines
Sets a property on an object.
The name of the property to set
The value to set the property to
Sets the default right margin for text in the text view.
Tags in the buffer may override the default.
Note that this function is confusingly named. In CSS terms, the value set here is padding.
right margin in pixels
Sets the default tab stops for paragraphs in text_view.
Tags in the buffer may override the default.
tabs as a Pango.TabArray
Sets the top margin for text in text_view.
Note that this function is confusingly named. In CSS terms, the value set here is padding.
top margin in pixels
Sets the vertical adjustment of the Gtk.Scrollable.
Optionalvadjustment: Gtk.AdjustmentSets the Gtk.ScrollablePolicy.
The policy determines whether vertical scrolling should start below the minimum height or below the natural height.
the vertical Gtk.ScrollablePolicy
Determines whether iter is at the start of a display line.
See Gtk.TextView.forward_display_line for an explanation of display lines vs. paragraphs.
true if iter begins a wrapped line
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.
Updates the position of the caret.
Implementations of the Gtk.AccessibleText interface should call this function every time the caret has moved, in order to notify assistive technologies.
Notifies assistive technologies of a change in contents.
Implementations of the Gtk.AccessibleText interface should call this function every time their contents change as the result of an operation, like an insertion or a removal.
Note: If the change is a deletion, this function must be called before removing the contents, if it is an insertion, it must be called after inserting the new contents.
the type of change in the contents
the starting offset of the change, in characters
the end offset of the change, in characters
Updates the next accessible sibling.
That might be useful when a new child of a custom accessible is created, and it needs to be linked to a previous child.
Optionalnew_sibling: Gtk.Accessiblethe new next accessible sibling to set
Informs ATs that the platform state has changed.
This function should be used by Gtk.Accessible implementations that have a platform state but are not widgets. Widgets handle platform states automatically.
the platform state to update
Updates an array of accessible properties.
This function should be called by Gtk.Widget types whenever an accessible property change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of accessible properties
an array of GValues, one for each property
Updates an array of accessible relations.
This function should be called by Gtk.Widget types whenever an accessible relation change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of accessible relations
an array of GValues, one for each relation
Updates the boundary of the selection.
Implementations of the Gtk.AccessibleText interface should call this function every time the selection has moved, in order to notify assistive technologies.
Updates an array of accessible states.
This function should be called by Gtk.Widget types whenever an accessible state change must be communicated to assistive technologies.
This function is meant to be used by language bindings.
an array of accessible states
an array of GValues, one for each state
Virtualvfunc_Virtualvfunc_The class handler for the Gtk.TextView::backspace
keybinding signal.
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_The class handler for the Gtk.TextView::copy-clipboard
keybinding signal.
Virtualvfunc_Virtualvfunc_Called at the end of each custom element handled by the buildable.
Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Optionaldata: anyuser data that will be passed in to parser functions
Virtualvfunc_Called for each unknown element under <child>.
a Gtk.Builder used to construct this object
child object or null for non-child tags
name of tag
Virtualvfunc_The class handler for the Gtk.TextView::cut-clipboard
keybinding signal
Virtualvfunc_The class handler for the Gtk.TextView::delete-from-cursor
keybinding signal.
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_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_Retrieves the accessible parent for an accessible object.
This function returns NULL for top level widgets.
Virtualvfunc_Virtualvfunc_Retrieves the text attributes inside the accessible object.
Each attribute is composed by:
It is left to the implementation to determine the serialization format of the value to a string.
GTK provides support for various text attribute names and values, but implementations of this interface are free to add their own attributes.
If this function returns true, n_ranges will be set to a value
greater than or equal to one, ranges will be set to a newly
allocated array of [struct#Gtk.AccessibleTextRange].
the offset, in characters
Virtualvfunc_Virtualvfunc_Queries the coordinates and dimensions of this accessible
This functionality can be overridden by Gtk.Accessible implementations, e.g. to get the bounds from an ignored child widget.
Virtualvfunc_Retrieves the position of the caret inside the accessible object.
Virtualvfunc_Virtualvfunc_Retrieve the current contents of the accessible object starting from the given offset, and using the given granularity.
The start and end values contain the boundaries of the text.
the offset, in characters
the granularity of the query
Virtualvfunc_Retrieves the default text attributes inside the accessible object.
Each attribute is composed by:
It is left to the implementation to determine the serialization format of the value to a string.
GTK provides support for various text attribute names and values, but implementations of this interface are free to add their own attributes.
Virtualvfunc_Virtualvfunc_Retrieves the first accessible child of an accessible object.
Virtualvfunc_The getter corresponding to set_id. Implement this
if you implement set_id.
Virtualvfunc_Virtualvfunc_Retrieves the next accessible sibling of an accessible object
Virtualvfunc_Virtualvfunc_Queries a platform state, such as focus.
This functionality can be overridden by Gtk.Accessible implementations, e.g. to get platform state from an ignored child widget, as is the case for Gtk.Text wrappers.
platform state to query
Virtualvfunc_Virtualvfunc_Retrieves the selection ranges in the accessible object.
If this function returns true, n_ranges will be set to a value
greater than or equal to one, and ranges will be set to a newly
allocated array of [struct#Gtk.AccessibleTextRange].
Virtualvfunc_The class handler for the Gtk.TextView::insert-at-cursor
keybinding signal.
Virtualvfunc_The class handler for the Gtk.TextView::insert-emoji signal.
Virtualvfunc_The class handler for the Gtk.TextView::move-cursor
keybinding signal.
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_Called when a builder finishes the parsing of a UI definition. It is normally not necessary to implement this, unless you need to perform special cleanup actions. Gtk.Window sets the Gtk.Widget.visible property here.
Virtualvfunc_The class handler for the Gtk.TextView::paste-clipboard
keybinding signal.
Virtualvfunc_The class handler for the Gtk.TextView::set-anchor
keybinding signal.
Virtualvfunc_Sets a property of a buildable object.
It is normally not necessary to implement this, g_object_set_property()
is used by default. Gtk.Window implements this to delay showing itself
(i.e. setting the Gtk.Widget.visible property) until the whole
interface is created.
Virtualvfunc_Stores the id attribute given in the Gtk.Builder UI definition. Gtk.Widget stores the name as object data. Implement this method if your object has some notion of “ID” and it makes sense to map the XML id attribute to it.
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.
Virtualvfunc_The snapshot_layer vfunc is called before and after the text view is drawing its own text. Applications can override this vfunc in a subclass to draw customized content underneath or above the text. In the Gtk.TextViewLayer.BELOW_TEXT and Gtk.TextViewLayer.ABOVE_TEXT layers the drawing is done in the buffer coordinate space.
Virtualvfunc_The class handler for the Gtk.TextView::toggle-overwrite
keybinding signal.
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
Converts coordinates on the window identified by win to buffer
coordinates.
window x coordinate
window y coordinate
StaticnewStaticnew_Enables or disables an action installed with Gtk.WidgetClass.install_action.
action name, such as "clipboard.paste"
whether the action is now enabled
Activates the widget.
The activation will emit the signal set using Gtk.WidgetClass.set_activate_signal during class initialization.
Activation is what happens when you press Enter on a widget.
If you wish to handle the activation keybinding yourself, it is recommended to use Gtk.WidgetClass.add_shortcut with an action created with Gtk.SignalAction.new.
If widget is not activatable, the function returns false.
true if the widget was activated
Activates an action for the widget.
The action is looked up in the action groups associated with
widget and its ancestors.
If the action is in an action group added with
Gtk.Widget.insert_action_group, the name is expected
to be prefixed with the prefix that was used when the group was
inserted.
The arguments must match the actions expected parameter type, as returned by Gio.Action.get_parameter_type.
true if the action was activated
Activates the default.activate action for the widget.
The action is looked up in the same was as for Gtk.Widget.activate_action.
Adds an event controller to the widget.
The event controllers of a widget handle the events that are propagated to the widget.
You will usually want to call this function right after creating any kind of Gtk.EventController.
an event controller that hasn't been added to a widget yet
Adds a style class to the widget.
After calling this function, the widget’s style will match
for css_class, according to CSS matching rules.
Use Gtk.Widget.remove_css_class to remove the style again.
style class to add to widget, without the leading period
Adds a widget to the list of mnemonic labels for this widget.
See Gtk.Widget.list_mnemonic_labels.
Note that the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well.
Queues an animation frame update and adds a callback to be called before each frame.
Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames.
The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a label), then you will have to call Gtk.Widget.queue_resize or Gtk.Widget.queue_draw yourself.
Gdk.FrameClock.get_frame_time should generally be used for timing continuous animations and Gdk.FrameTimings.get_predicted_presentation_time should be used if you are trying to display isolated frames at particular times.
This is a more convenient alternative to connecting directly to the
Gdk.FrameClock::update signal of the frame clock, since you
don't have to worry about when a frame clock is assigned to a widget.
To remove a tick callback, pass the ID that is returned by this function to Gtk.Widget.remove_tick_callback.
function to call for updating animations
an ID for this callback
Assigns size, position, (optionally) a baseline and transform to a child widget.
In this function, the allocation and baseline may be adjusted. The given allocation will be forced to be bigger than the widget's minimum size, as well as at least 0×0 in size.
This function is only used by widget implementations.
For a version that does not take a transform, see Gtk.Widget.size_allocate.
new width
new height
new baseline, or -1
Optionaltransform: Transformtransformation to be applied
Called by widgets as the user moves around the window using keyboard shortcuts.
The direction argument indicates what kind of motion is taking
place (up, down, left, right, tab forward, tab backward).
This function calls the Gtk.Widget.focus virtual function; widgets can override the virtual function in order to implement appropriate focus behavior.
The default focus() virtual function for a widget should return
true if moving in direction left the focus on a focusable location
inside that widget, and false if moving in direction moved the focus
outside the widget. When returning true, widgets normally call
Gtk.Widget.grab_focus to place the focus accordingly;
when returning false, they don’t modify the current focus location.
This function is used by custom widget implementations; if you're writing an app, you’d use Gtk.Widget.grab_focus to move the focus to a particular widget.
direction of focus movement
true if focus ended up inside widget
Computes the bounds for widget in the coordinate space of target.
The bounds of widget are (the bounding box of) the region that it is expected to draw in. See the coordinate system overview to learn more.
If the operation is successful, true is returned. If widget has no
bounds or the bounds cannot be expressed in target's coordinate space
(for example if both widgets are in different windows), false is
returned and bounds is set to the zero rectangle.
It is valid for widget and target to be the same widget.
true if the bounds could be computed
Computes whether a parent widget should give this widget extra space when possible.
Widgets with children should check this, rather than looking at Gtk.Widget.get_hexpand or Gtk.Widget.get_vexpand.
This function already checks whether the widget is visible, so visibility does not need to be checked separately. Non-visible widgets are not expanded.
The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do.
expand direction
whether widget tree rooted here should be expanded
Translates the given point in widget's coordinates to coordinates
in target’s coordinate system.
In order to perform this operation, both widgets must share a
a common ancestor. If that is not the case, out_point is set
to (0, 0) and false is returned.
true if src_widget and dest_widget have a common ancestor, false otherwise
Computes a matrix suitable to describe a transformation from
widget's coordinate system into target's coordinate system.
The transform can not be computed in certain cases, for example
when widget and target do not share a common ancestor. In that
case out_transform gets set to the identity matrix.
To learn more about widget coordinate systems, see the coordinate system overview.
true if the transform could be computed
Tests if a given point is contained in the widget.
The coordinates for (x, y) must be in widget coordinates, so
(0, 0) is assumed to be the top left of widget's content area.
X coordinate to test, relative to widget's origin
Y coordinate to test, relative to widget's origin
true if widget contains the point (x, y)
Creates a new Pango.Context that is configured for the widget.
The Pango.Context will have the appropriate font map, font options, font description, and base direction set.
See also Gtk.Widget.get_pango_context.
the new Pango.Context
Creates a new Pango.Layout that is configured for the widget.
The Pango.Layout will have the appropriate font map, font description, and base direction set.
If you keep a Pango.Layout created in this way around, you need to re-create it when the widgets Pango.Context is replaced. This can be tracked by listening to changes of the Gtk.Widget.root property on the widget.
Optionaltext: stringtext to set on the layout
the new Pango.Layout
Clears the template children for the widget.
This function is the opposite of Gtk.Widget.init_template,
and it is used to clear all the template children from a widget
instance. If you bound a template child to a field in the instance
structure, or in the instance private data structure, the field will
be set to NULL after this function returns.
You should call this function inside the GObject.Object.dispose implementation of any widget that called Gtk.Widget.init_template. Typically, you will want to call this function last, right before chaining up to the parent type's dispose implementation, e.g.
static void
some_widget_dispose (GObject *gobject)
{
SomeWidget *self = SOME_WIDGET (gobject);
// Clear the template data for SomeWidget
gtk_widget_dispose_template (GTK_WIDGET (self), SOME_TYPE_WIDGET);
G_OBJECT_CLASS (some_widget_parent_class)->dispose (gobject);
}
the type of the widget to finalize the template for
Checks to see if a drag movement has passed the GTK drag threshold.
X coordinate of start of drag
Y coordinate of start of drag
current X coordinate
current Y coordinate
true if the drag threshold has been passed
Notifies the user about an input-related error on the widget.
If the Gtk.Settings.gtk_error_bell setting is true, it calls Gdk.Surface.beep, otherwise it does nothing.
Note that the effect of Gdk.Surface.beep can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.
Returns the baseline that has currently been allocated to the widget.
This function is intended to be used when implementing handlers for the Gtk.Widget.snapshot function, and when allocating child widgets in Gtk.Widget.size_allocate.
the baseline of the widget, or -1 if none
Returns the height that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate system overview.
the height of the widget
Returns the width that has currently been allocated to the widget.
To learn more about widget sizes, see the coordinate system overview.
the width of the widget
Retrieves the widget’s allocation.
Note, when implementing a layout widget: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent typically calls Gtk.Widget.size_allocate with an allocation, and that allocation is then adjusted (to handle margin and alignment for example) before assignment to the widget. Gtk.Widget.get_allocation returns the adjusted allocation that was actually assigned to the widget. The adjusted allocation is guaranteed to be completely contained within the Gtk.Widget.size_allocate allocation, however.
So a layout widget is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the widget assigned.
Gets the first ancestor of the widget with type widget_type.
For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX)
gets the first Gtk.Box that’s an ancestor of widget. No
reference will be added to the returned widget; it should
not be unreferenced.
Note that unlike Gtk.Widget.is_ancestor, this function
considers widget to be an ancestor of itself.
ancestor type
the ancestor widget
Returns the baseline that has currently been allocated to the widget.
This function is intended to be used when implementing handlers for the Gtk.Widget.snapshot function, and when allocating child widgets in Gtk.Widget.size_allocate.
the baseline of the widget, or -1 if none
Determines whether the input focus can enter the widget or any of its children.
true if the input focus can enter widget
Queries whether the widget can be the target of pointer events.
true if widget can receive pointer events
Gets the value set with Gtk.Widget.set_child_visible.
If you feel a need to use this function, your code probably needs reorganization.
This function is only useful for widget implementations and should never be called by an application.
true if the widget is mapped with the parent
Returns the list of style classes applied to the widget.
a NULL-terminated list of css classes currently applied to widget
Returns the CSS name of the widget.
the CSS name
Gets the cursor set on the widget.
See Gtk.Widget.set_cursor for details.
the cursor that is set on widget
Gets the reading direction for the widget.
the reading direction for the widget
Get the display for the window that the widget belongs to.
This function can only be called after the widget has been added to a widget hierarchy with a Gtk.Root at the top.
In general, you should only create display-specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.
the display for this widget
Returns whether the widget should grab focus when it is clicked with the mouse.
true if the widget should grab focus when it is clicked with the mouse
Determines whether the widget can own the input focus.
true if widget can own the input focus
Returns the cairo_font_options_t of the widget.
the cairo_font_options_t of widget
Obtains the frame clock for a widget.
The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call Gdk.FrameClock.get_frame_time, in order to get a time to use for animating. For example you might record the start of the animation with an initial value from Gdk.FrameClock.get_frame_time, and then update the animation by calling Gdk.FrameClock.get_frame_time again during each repaint.
Gdk.FrameClock.request_phase will result in a new frame on the clock, but won’t necessarily repaint any widgets. To repaint a widget, you have to use Gtk.Widget.queue_draw which invalidates the widget (thus scheduling it to receive a draw on the next frame). Gtk.Widget.queue_draw will also end up requesting a frame on the appropriate frame clock.
A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock.
Unrealized widgets do not have a frame clock.
the frame clock
Gets the horizontal alignment of the widget.
For backwards compatibility reasons this method will never return one of the baseline alignments, but instead it will convert it to Gtk.Align.FILL or Gtk.Align.CENTER.
Baselines are not supported for horizontal alignment.
the horizontal alignment of widget
Returns the current value of the has-tooltip property.
current value of has-tooltip on widget
Returns the content height of the widget.
This function returns the height passed to its size-allocate implementation, which is the height you should be using in Gtk.Widget.snapshot.
For pointer events, see Gtk.Widget.contains.
To learn more about widget sizes, see the coordinate system overview.
The height of widget
Gets whether the widget would like any available extra horizontal space.
When a user resizes a window, widgets with expand set to true generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Widgets with children should use Gtk.Widget.compute_expand rather than this function, to see whether any of its children, has the expand flag set. If any child of a widget wants to expand, the parent may ask to expand also.
This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand.
whether hexpand flag is set
Gets whether the hexpand flag has been explicitly set.
If Gtk.Widget.hexpand property is set, then it
overrides any computed expand value based on child widgets.
If hexpand is not set, then the expand value depends on
whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here for completeness and consistency.
whether hexpand has been explicitly set
Gets the value of the Gtk.Widget.limit_events property.
Returns whether the widget is mapped.
true if the widget is mapped
Gets the bottom margin of the widget.
The bottom margin of widget
Gets the end margin of the widget.
The end margin of widget
Gets the start margin of the widget.
The start margin of widget
Gets the top margin of the widget.
The top margin of widget
Retrieves the name of a widget.
See Gtk.Widget.set_name for the significance of widget names.
name of the widget
Returns the nearest Gtk.Native ancestor of the widget.
This function will return NULL if the widget is not
contained inside a widget tree with a native ancestor.
Gtk.Native widgets will return themselves here.
the Gtk.Native ancestor of widget
Fetches the requested opacity for the widget.
the requested opacity for this widget
Gets a Pango.Context that is configured for the widget.
The Pango.Context will have the appropriate font map, font description, and base direction set.
Unlike the context returned by Gtk.Widget.create_pango_context, this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by listening to changes of the Gtk.Widget.root property on the widget.
the Pango.Context for the widget
Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.
This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used to deduce toplevel window and menu sizes as well as child widgets in free-form containers such as Gtk.Fixed.
Handle with care. Note that the natural height of a height-for-width widget will generally be a smaller size than the minimum height, since the required height for the natural width is generally smaller than the required height for the minimum width.
Use Gtk.Widget.measure if you want to support baseline alignment.
Determines whether the widget is realized.
true if widget is realized
Determines whether the widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
true if widget acts as the default widget when focused
Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.
The Gtk.SizeRequestMode preferred by widget.
Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.
On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).
See Gdk.Surface.get_scale_factor.
Note that modern systems may support fractional scaling, where the scale factor is not an integer. On such systems, this function will return the next higher integer value, but you probably want to use Gdk.Surface.get_scale to get the fractional scale value.
the scale factor for widget
Returns the widget’s sensitivity.
This function returns the value that has been set using Gtk.Widget.set_sensitive).
The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See Gtk.Widget.is_sensitive.
true if the widget is sensitive
Gets the settings object holding the settings used for the widget.
Note that this function can only be called when the Gtk.Widget
is attached to a toplevel, since the settings object is specific
to a particular display. If you want to monitor the widget for
changes in its settings, connect to the notify::display signal.
the relevant settings object
Returns the content width or height of the widget.
Which dimension is returned depends on orientation.
This is equivalent to calling Gtk.Widget.get_width for Gtk.Orientation.HORIZONTAL or Gtk.Widget.get_height for Gtk.Orientation.VERTICAL, but can be used when writing orientation-independent code, such as when implementing Gtk.Orientable widgets.
To learn more about widget sizes, see the coordinate system overview.
the orientation to query
the size of widget in orientation
Gets the size request that was explicitly set for the widget.
A value of -1 stored in width or height indicates that that
dimension has not been set explicitly and the natural requisition
of the widget will be used instead.
See Gtk.Widget.set_size_request.
To get the size a widget will actually request, call Gtk.Widget.measure instead of this function.
Returns the widget state as a flag set.
It is worth mentioning that the effective Gtk.StateFlags.INSENSITIVE
state will be returned, that is, also based on parent insensitivity,
even if widget itself is sensitive.
Also note that if you are looking for a way to obtain the Gtk.StateFlags to pass to a Gtk.StyleContext method, you should look at Gtk.StyleContext.get_state.
the state flags of widget
Returns the style context associated to the widget.
The returned object is guaranteed to be the same
for the lifetime of widget.
the widgets style context
Fetches an object build from the template XML for widget_type in
the widget.
This will only report children which were previously declared with Gtk.WidgetClass.bind_template_child_full or one of its variants.
This function is only meant to be called for code which is private
to the widget_type which declared the child and is meant for language
bindings which cannot easily make use of the GObject structure offsets.
The GObject.GType to get a template child for
ID of the child defined in the template XML
the object built in the template XML with the id name
Gets the contents of the tooltip for the widget.
If the tooltip has not been set using
Gtk.Widget.set_tooltip_markup, this
function returns NULL.
the tooltip text
Gets the contents of the tooltip for the widget.
If the widget's tooltip was set using
Gtk.Widget.set_tooltip_markup,
this function will return the escaped text.
the tooltip text
Gets whether the widget would like any available extra vertical space.
See Gtk.Widget.get_hexpand for more detail.
whether vexpand flag is set
Gets whether the vexpand flag has been explicitly set.
See Gtk.Widget.get_hexpand_set for more detail.
whether vexpand has been explicitly set
Determines whether the widget is visible.
If you want to take into account whether the widget’s parent is also marked as visible, use Gtk.Widget.is_visible instead.
This function does not check if the widget is obscured in any way.
true if the widget is visible
Returns the content width of the widget.
This function returns the width passed to its size-allocate implementation, which is the width you should be using in Gtk.Widget.snapshot.
For pointer events, see Gtk.Widget.contains.
To learn more about widget sizes, see the coordinate system overview.
The width of widget
Causes widget to have the keyboard focus for the window
that it belongs to.
If widget is not focusable, or its Gtk.Widget.grab_focus
implementation cannot transfer the focus to a descendant of widget
that is focusable, it will not take focus and false will be returned.
Calling Gtk.Widget.grab_focus on an already focused widget is allowed, should not have an effect, and return true.
true if focus is now inside widget
Returns whether a style class is currently applied to the widget.
style class, without the leading period
true if css_class is currently applied to widget
Determines if the widget should show a visible indication that it has the global input focus.
This is a convenience function that takes into account whether
focus indication should currently be shown in the toplevel window
of widget. See Gtk.Window.get_focus_visible for more
information about focus indication.
To find out if the widget has the global input focus, use Gtk.Widget.has_focus.
true if the widget should display a “focus rectangle”
Reverses the effects of [method.Gtk.Widget.show].
This is causing the widget to be hidden (invisible to the user).
Returns whether the widget is currently being destroyed.
This information can sometimes be used to avoid doing unnecessary work.
true if widget is being destroyed
Creates and initializes child widgets defined in templates.
This function must be called in the instance initializer for any class which assigned itself a template using Gtk.WidgetClass.set_template.
It is important to call this function in the instance initializer
of a widget subclass and not in GObject.constructed() or
GObject.constructor() for two reasons:
g_object_new() on a widget with composite templates,
it’s important to build the composite widgets before the construct
properties are set. Properties passed to g_object_new() should
take precedence over properties set in the private template XMLA good rule of thumb is to call this function as the first thing in an instance initialization function.
Inserts an action group into the widget's actions.
Children of widget that implement Gtk.Actionable can
then be associated with actions in group by setting their
“action-name” to prefix.action-name.
Note that inheritance is defined for individual actions. I.e.
even if you insert a group with prefix prefix, actions with
the same prefix will still be inherited from the parent, unless
the group contains an action with the same name.
If group is NULL, a previously inserted group for name is
removed from widget.
the prefix for actions in group
Optionalgroup: Gio.ActionGroupan action group
Sets the parent widget of the widget.
In contrast to Gtk.Widget.set_parent, this function
inserts widget at a specific position into the list of children
of the parent widget.
It will be placed after previous_sibling, or at the beginning if
previous_sibling is NULL.
After calling this function, gtk_widget_get_prev_sibling (widget)
will return previous_sibling.
If parent is already set as the parent widget of widget, this
function can also be used to reorder widget in the child widget
list of parent.
This function is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.
Sets the parent widget of the widget.
In contrast to Gtk.Widget.set_parent, this function
inserts widget at a specific position into the list of children
of the parent widget.
It will be placed before next_sibling, or at the end if
next_sibling is NULL.
After calling this function, gtk_widget_get_next_sibling (widget)
will return next_sibling.
If parent is already set as the parent widget of widget, this function
can also be used to reorder widget in the child widget list of parent.
This function is primarily meant for widget implementations; if you are just using a widget, you must use its own API for adding children.
Determines whether the widget is a descendent of ancestor.
another Gtk.Widget
true if ancestor contains widget as a child, grandchild, great grandchild, etc
Determines whether the widget can be drawn to.
A widget can be drawn if it is mapped and visible.
true if widget is drawable
Determines if the widget is the focus widget within its toplevel.
This does not mean that the Gtk.Widget.has_focus property is necessarily set; Gtk.Widget.has_focus will only be set if the toplevel widget additionally has the global input focus.
true if the widget is the focus widget
Returns the widget’s effective sensitivity.
This means it is sensitive itself and also its parent widget is sensitive.
true if the widget is effectively sensitive
Determines whether the widget and all its parents are marked as visible.
This function does not check if the widget is obscured in any way.
See also Gtk.Widget.get_visible and Gtk.Widget.set_visible.
true if the widget and all its parents are visible
Emits the Gtk.Widget::keynav-failed signal on the widget.
This function should be called whenever keyboard navigation within a single widget hits a boundary.
The return value of this function should be interpreted in a way similar to the return value of Gtk.Widget.child_focus. When true is returned, stay in the widget, the failed keyboard navigation is ok and/or there is nowhere we can/should move the focus to. When false is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling Gtk.Widget.child_focus on the widget’s toplevel.
The default Gtk.Widget::keynav-failed handler returns
false for Gtk.DirectionType.TAB-FORWARD and
Gtk.DirectionType.TAB-BACKWARD. For the other values
of Gtk.DirectionType it returns true.
Whenever the default handler returns true, it also calls Gtk.Widget.error_bell to notify the user of the failed keyboard navigation.
A use case for providing an own implementation of ::keynav-failed
(either by connecting to it or by overriding it) would be a row of
Gtk.Entry widgets where the user should be able to navigate
the entire row with the cursor keys, as e.g. known from user
interfaces that require entering license keys.
direction of focus movement
true if stopping keyboard navigation is fine, false if the emitting widget should try to handle the keyboard navigation attempt in its parent widget
Returns the widgets for which this widget is the target of a mnemonic.
Typically, these widgets will be labels. See, for example, Gtk.Label.set_mnemonic_widget.
The widgets in the list are not individually referenced.
If you want to iterate through the list and perform actions
involving callbacks that might destroy the widgets, you
must call g_list_foreach (result, (GFunc)g_object_ref, NULL)
first, and then unref all the widgets afterwards.
the list of mnemonic labels
Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations.
Measures widget in the orientation orientation and for the given for_size.
As an example, if orientation is Gtk.Orientation.HORIZONTAL and for_size
is 300, this functions will compute the minimum and natural width of widget
if it is allocated at a height of 300 pixels.
See GtkWidget’s geometry management section for a more details on implementing Gtk.Widget.measure.
the orientation to measure
Size for the opposite of orientation, i.e. if orientation is Gtk.Orientation.HORIZONTAL, this is the height the widget should be measured with. The Gtk.Orientation.VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.
Emits the Gtk.Widget::mnemonic-activate signal.
true if there are other widgets with the same mnemonic
true if the signal has been handled
Returns a list model to track the children of the widget.
Calling this function will enable extra internal bookkeeping to track children and emit signals on the returned listmodel. It may slow down operations a lot.
Applications should try hard to avoid calling this function because of the slowdowns.
a list model tracking widget's children
Returns a list model to track the event controllers of the widget.
Calling this function will enable extra internal bookkeeping to track controllers and emit signals on the returned listmodel. It may slow down operations a lot.
Applications should try hard to avoid calling this function because of the slowdowns.
a list model tracking widget's controllers
Finds the descendant of the widget closest to a point.
The point (x, y) must be given in widget coordinates, so (0, 0)
is assumed to be the top left of widget's content area.
Usually widgets will return NULL if the given coordinate is not
contained in widget checked via Gtk.Widget.contains.
Otherwise they will recursively try to find a child that does
not return NULL. Widgets are however free to customize their
picking algorithm.
This function is used on the toplevel to determine the widget below the mouse cursor for purposes of hover highlighting and delivering events.
the widget's descendant at (x, y)
Flags the widget for a rerun of the Gtk.Widget.size_allocate function.
Use this function instead of Gtk.Widget.queue_resize
when the widget's size request didn't change but it wants to
reposition its contents.
An example user of this function is Gtk.Widget.set_halign.
This function is only for use in widget implementations.
Schedules this widget to be redrawn.
The redraw will happen in the paint phase of the current or the next frame.
This means widget's Gtk.Widget.snapshot
implementation will be called.
Flags a widget to have its size renegotiated.
This should be called when a widget for some reason has a new size request. For example, when you change the text in a Gtk.Label, the label queues a resize to ensure there’s enough space for the new text.
Note that you cannot call gtk_widget_queue_resize() on a widget
from inside its implementation of the Gtk.Widget.size_allocate
virtual method. Calls to gtk_widget_queue_resize() from inside
Gtk.Widget.size_allocate will be silently ignored.
This function is only for use in widget implementations.
Creates the GDK resources associated with a widget.
Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.
Realizing a widget requires all the widget’s parent widgets to be
realized; calling this function realizes the widget’s parents
in addition to widget itself. If a widget is not yet inside a
toplevel window when you realize it, bad things will happen.
This function is primarily used in widget implementations, and
isn’t very useful otherwise. Many times when you think you might
need it, a better approach is to connect to a signal that will be
called after the widget is realized automatically, such as
Gtk.Widget::realize.
Removes an event controller from the widget.
The removed event controller will not receive any more events, and should not be used again.
Widgets will remove all event controllers automatically when they are destroyed, there is normally no need to call this function.
an event controller
Removes a style from the widget.
After this, the style of widget will stop matching for css_class.
style class to remove from widget, without the leading period
Removes a widget from the list of mnemonic labels for this widget.
See Gtk.Widget.list_mnemonic_labels.
The widget must have previously been added to the list with Gtk.Widget.add_mnemonic_label.
Removes a tick callback previously registered with Gtk.Widget.add_tick_callback.
an ID returned by Gtk.Widget.add_tick_callback
Sets whether the input focus can enter the widget or any of its children.
Applications should set can_focus to false to mark a
widget as for pointer/touch use only.
Note that having can_focus be true is only one of the
necessary conditions for being focusable. A widget must
also be sensitive and focusable and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
See Gtk.Widget.grab_focus for actually setting the input focus on a widget.
whether the input focus can enter the widget or any of its children
Sets whether the widget can be the target of pointer events.
whether this widget should be able to receive pointer events
Sets whether the widget should be mapped along with its parent.
The child visibility can be set for widget before it is added to a container with Gtk.Widget.set_parent, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of true when the widget is removed from a container.
Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.
This function is only useful for widget implementations and should never be called by an application.
whether widget should be mapped along with its parent
Replaces the current style classes of the widget with classes.
NULL-terminated list of style classes
Sets the cursor to be shown when the pointer hovers over the widget.
This is a utility function that creates a cursor via
Gdk.Cursor.new_from_name and then sets it on widget
with Gtk.Widget.set_cursor. See those functions for
details.
On top of that, this function allows name to be NULL, which
will do the same as calling Gtk.Widget.set_cursor
with a NULL cursor.
Optionalname: stringthe name of the cursor
Sets the reading direction on the widget.
This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done.
Generally, applications will let the default reading direction prevail, except for widgets where the children are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).
If the direction is set to Gtk.TextDirection.NONE, then the value set by Gtk.Widget.set_default_direction will be used.
the new direction
Set the focus child of the widget.
This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call Gtk.Widget.grab_focus on it.
Sets whether the widget should grab focus when it is clicked with the mouse.
Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.
whether the widget should grab focus when clicked with the mouse
Sets whether the widget can own the input focus.
Widget implementations should set focusable to true in
their init() function if they want to receive keyboard input.
Note that having focusable be true is only one of the
necessary conditions for being focusable. A widget must
also be sensitive and can-focus and not have an ancestor
that is marked as not can-focus in order to receive input
focus.
See Gtk.Widget.grab_focus for actually setting the input focus on a widget.
whether or not widget can own the input focus
Sets the font map to use for text rendering in the widget.
The font map is the object that is used to look up fonts. Setting a custom font map can be useful in special situations, e.g. when you need to add application-specific fonts to the set of available fonts.
When not set, the widget will inherit the font map from its parent.
Sets the cairo_font_options_t used for text rendering
in the widget.
When not set, the default font options for the Gdk.Display will be used.
Optionaloptions: default.FontOptionsa cairo_font_options_t struct to unset any previously set default font options
Sets the has-tooltip property on the widget.
whether or not widget has a tooltip
Sets whether the widget would like any available extra horizontal space.
When a user resizes a window, widgets with expand set to true generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.
Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.
By default, widgets automatically expand if any of their children
want to expand. (To see if a widget will automatically expand given
its current children and state, call Gtk.Widget.compute_expand.
A widget can decide how the expandability of children affects its
own expansion by overriding the compute_expand virtual method on
Gtk.Widget.).
Setting hexpand explicitly with this function will override the automatic expand behavior.
This function forces the widget to expand or not to expand, regardless of children. The override occurs because Gtk.Widget.set_hexpand sets the hexpand-set property (see Gtk.Widget.set_hexpand_set) which causes the widget’s hexpand value to be used, rather than looking at children and widget state.
whether to expand
Sets whether the hexpand flag will be used.
The Gtk.Widget.hexpand_set property will be set automatically when you call Gtk.Widget.set_hexpand to set hexpand, so the most likely reason to use this function would be to unset an explicit expand flag.
If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.
There are few reasons to use this function, but it’s here for completeness and consistency.
value for hexpand-set property
Sets the layout manager to use for measuring and allocating children of the widget.
Optionallayout_manager: Gtk.LayoutManagera layout manager
Sets whether the widget acts like a modal dialog, with respect to event delivery.
whether to limit events
Sets the bottom margin of the widget.
the bottom margin
Sets the end margin of the widget.
the end margin
Sets the start margin of the widget.
the start margin
Sets the top margin of the widget.
the top margin
Sets a widgets name.
Setting a name allows you to refer to the widget from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for Gtk.StyleContext.
Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice.
name for the widget
Requests the widget to be rendered partially transparent.
An opacity of 0 is fully transparent and an opacity of 1 is fully opaque.
Opacity works on both toplevel widgets and child widgets, although there are some limitations: For toplevel widgets, applying opacity depends on the capabilities of the windowing system. On X11, this has any effect only on X displays with a compositing manager, see Gdk.Display.is_composited. On Windows and Wayland it will always work, although setting a window’s opacity after the window has been shown may cause some flicker.
Note that the opacity is inherited through inclusion — if you set a toplevel to be partially translucent, all of its content will appear translucent, since it is ultimatively rendered on that toplevel. The opacity value itself is not inherited by child widgets (since that would make widgets deeper in the hierarchy progressively more translucent). As a consequence, Gtk.Popover instances and other Gtk.Native widgets with their own surface will use their own opacity value, and thus by default appear non-translucent, even if they are attached to a toplevel that is translucent.
desired opacity, between 0 and 1
Sets how the widget treats content that is drawn outside the it's content area.
See the definition of Gtk.Overflow for details.
This setting is provided for widget implementations and should not be used by application code.
The default value is Gtk.Overflow.VISIBLE.
Sets the parent widget of the widget.
This takes care of details such as updating the state and style of the child to reflect its new location and resizing the parent. The opposite function is Gtk.Widget.unparent.
This function is useful only when implementing subclasses of Gtk.Widget.
Sets whether the widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.
whether or not widget can be a default widget
Sets the sensitivity of the widget.
A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.
true to make the widget sensitive
Sets the minimum size of the widget.
That is, the widget’s size request will be at least width
by height. You can use this function to force a widget to
be larger than it normally would be.
In most cases, Gtk.Window.set_default_size is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request.
Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it is basically impossible to hardcode a size that will always work.
The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.
If the size request in a given direction is -1 (unset), then the “natural” size request of the widget will be used instead.
The size request set here does not include any margin from the properties Gtk.Widget.margin_start, Gtk.Widget.margin_end, Gtk.Widget.margin_top, and Gtk.Widget.margin_bottom, but it does include pretty much all other padding or border properties set by any subclass of Gtk.Widget.
width widget should request, or -1 to unset
height widget should request, or -1 to unset
Turns on flag values in the current widget state.
Typical widget states are insensitive, prelighted, etc.
This function accepts the values Gtk.StateFlags.DIR-LTR and Gtk.StateFlags.DIR-RTL but ignores them. If you want to set the widget's direction, use Gtk.Widget.set_direction.
This function is for use in widget implementations.
state flags to turn on
whether to clear state before turning on flags
Sets the contents of the tooltip for widget.
markup must contain Pango markup.
This function will take care of setting the
Gtk.Widget.has_tooltip as a side effect, and of the
default handler for the Gtk.Widget::query-tooltip signal.
See also Gtk.Tooltip.set_markup.
Optionalmarkup: stringthe contents of the tooltip for widget
Sets the contents of the tooltip for the widget.
If text contains any markup, it will be escaped.
This function will take care of setting
Gtk.Widget.has_tooltip as a side effect,
and of the default handler for the
Gtk.Widget::query-tooltip signal.
See also Gtk.Tooltip.set_text.
Optionaltext: stringthe contents of the tooltip for widget
Sets whether the widget would like any available extra vertical space.
See Gtk.Widget.set_hexpand for more detail.
whether to expand
Sets whether the vexpand flag will be used.
See Gtk.Widget.set_hexpand_set for more detail.
value for vexpand-set property
Sets the visibility state of widget.
Note that setting this to true doesn’t mean the widget is actually viewable, see Gtk.Widget.get_visible.
whether the widget should be shown or not
Returns whether the widget should contribute to the measuring and allocation of its parent.
This is false for invisible children, but also for children that have their own surface, such as Gtk.Popover instances.
true if child should be included in measuring and allocating
Flags a widget to be displayed.
Any widget that isn’t shown will not appear on the screen.
Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.
When a toplevel widget is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel widget is realized and mapped.
Allocates widget with a transformation that translates
the origin to the position in allocation.
This is a simple form of Gtk.Widget.allocate.
Snapshots a child of the widget.
When a widget receives a call to the snapshot function,
it must send synthetic Gtk.Widget.snapshot calls
to all children. This function provides a convenient way
of doing this. A widget, when it receives a call to its
Gtk.Widget.snapshot function, calls
gtk_widget_snapshot_child() once for each child, passing in
the snapshot the widget received.
This function takes care of translating the origin of snapshot,
and deciding whether the child needs to be snapshot.
It does nothing for children that implement Gtk.Native.
a child of widget
snapshot as passed to the widget. In particular, no calls to Gtk.Snapshot.translate or other transform calls should have been made
Translates coordinates relative to src_widget’s allocation
to coordinates relative to dest_widget’s allocations.
In order to perform this operation, both widget must share
a common ancestor. If that is not the case, dest_x and dest_y
are set to 0 and false is returned.
true if src_widget and dest_widget have a common ancestor, false otherwise
Triggers a tooltip query on the display of the widget.
Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations.
Removes widget from its parent.
This function is only for use in widget implementations, typically in dispose.
Causes a widget to be unrealized.
This frees all GDK resources associated with the widget.
This function is only useful in widget implementations.
Turns off flag values for the current widget state.
See Gtk.Widget.set_state_flags.
This function is for use in widget implementations.
state flags to turn off
Virtualvfunc_Computes whether a container should give this widget extra space when possible.
Virtualvfunc_Tests if a given point is contained in the widget.
The coordinates for (x, y) must be in widget coordinates, so
(0, 0) is assumed to be the top left of widget's content area.
X coordinate to test, relative to widget's origin
Y coordinate to test, relative to widget's origin
Virtualvfunc_Vfunc called when the CSS used by widget was changed. Widgets should then discard their caches that depend on CSS and queue resizes or redraws accordingly. The default implementation will take care of this for all the default CSS properties, so implementations must chain up.
Virtualvfunc_Signal emitted when the text direction of a widget changes.
Virtualvfunc_Virtualvfunc_Gets whether the widget prefers a height-for-width layout or a width-for-height layout.
Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.
Virtualvfunc_Causes widget to have the keyboard focus for the window
that it belongs to.
If widget is not focusable, or its Gtk.Widget.grab_focus
implementation cannot transfer the focus to a descendant of widget
that is focusable, it will not take focus and false will be returned.
Calling Gtk.Widget.grab_focus on an already focused widget is allowed, should not have an effect, and return true.
Virtualvfunc_Reverses the effects of [method.Gtk.Widget.show].
This is causing the widget to be hidden (invisible to the user).
Virtualvfunc_Emits the Gtk.Widget::keynav-failed signal on the widget.
This function should be called whenever keyboard navigation within a single widget hits a boundary.
The return value of this function should be interpreted in a way similar to the return value of Gtk.Widget.child_focus. When true is returned, stay in the widget, the failed keyboard navigation is ok and/or there is nowhere we can/should move the focus to. When false is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling Gtk.Widget.child_focus on the widget’s toplevel.
The default Gtk.Widget::keynav-failed handler returns
false for Gtk.DirectionType.TAB-FORWARD and
Gtk.DirectionType.TAB-BACKWARD. For the other values
of Gtk.DirectionType it returns true.
Whenever the default handler returns true, it also calls Gtk.Widget.error_bell to notify the user of the failed keyboard navigation.
A use case for providing an own implementation of ::keynav-failed
(either by connecting to it or by overriding it) would be a row of
Gtk.Entry widgets where the user should be able to navigate
the entire row with the cursor keys, as e.g. known from user
interfaces that require entering license keys.
direction of focus movement
Virtualvfunc_Causes a widget to be mapped if it isn’t already.
This function is only for use in widget implementations.
Virtualvfunc_Measures widget in the orientation orientation and for the given for_size.
As an example, if orientation is Gtk.Orientation.HORIZONTAL and for_size
is 300, this functions will compute the minimum and natural width of widget
if it is allocated at a height of 300 pixels.
See GtkWidget’s geometry management section for a more details on implementing Gtk.Widget.measure.
the orientation to measure
Size for the opposite of orientation, i.e. if orientation is Gtk.Orientation.HORIZONTAL, this is the height the widget should be measured with. The Gtk.Orientation.VERTICAL case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.
Virtualvfunc_Emits the Gtk.Widget::mnemonic-activate signal.
true if there are other widgets with the same mnemonic
Virtualvfunc_Signal emitted when a change of focus is requested
Virtualvfunc_Virtualvfunc_Creates the GDK resources associated with a widget.
Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.
Realizing a widget requires all the widget’s parent widgets to be
realized; calling this function realizes the widget’s parents
in addition to widget itself. If a widget is not yet inside a
toplevel window when you realize it, bad things will happen.
This function is primarily used in widget implementations, and
isn’t very useful otherwise. Many times when you think you might
need it, a better approach is to connect to a signal that will be
called after the widget is realized automatically, such as
Gtk.Widget::realize.
Virtualvfunc_Called when the widget gets added to a Gtk.Root widget. Must chain up
Virtualvfunc_Set the focus child of the widget.
This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call Gtk.Widget.grab_focus on it.
Virtualvfunc_Flags a widget to be displayed.
Any widget that isn’t shown will not appear on the screen.
Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.
When a toplevel widget is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel widget is realized and mapped.
Virtualvfunc_Called to set the allocation, if the widget does not have a layout manager.
Virtualvfunc_Virtualvfunc_Signal emitted when the widget state changes,
see gtk_widget_get_state_flags().
Virtualvfunc_Emitted when a system setting was changed. Must chain up.
Virtualvfunc_Causes a widget to be unmapped if it’s currently mapped.
This function is only for use in widget implementations.
Virtualvfunc_Causes a widget to be unrealized.
This frees all GDK resources associated with the widget.
This function is only useful in widget implementations.
Virtualvfunc_Called when the widget is about to be removed from its Gtk.Root widget. Must chain up
Static_Staticadd_Staticbind_Staticbind_ID of the child defined in the template XML
whether the child should be accessible as an “internal-child” when this class is used in GtkBuilder XML
The offset into the composite widget’s instance public or private structure where the automated child pointer should be set, or 0 to not assign the pointer
Staticcompat_Optionaldata: anyStaticfind_Staticget_Staticget_Staticget_Staticget_Obtains the default reading direction.
Staticget_Staticinstall_a prefixed action name, such as "clipboard.paste"
the parameter type
callback to use when the action is activated
Staticinstall_Staticinstall_the id for the new property
the GObject.ParamSpec for the new property
Staticinstall_name of the action
name of a property in instances of widget_class or any parent class
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.
Staticquery_position of the action to query
Staticset_the accessible role to use
Staticset_the id for the activate signal
Staticset_the name of the activate signal of widget_type
Staticset_name to use
Staticset_Sets the default reading direction for widgets.
the new default direction, either Gtk.TextDirection.LTR or Gtk.TextDirection.RTL
Staticset_the object type that implements the Gtk.LayoutManager for widget_class
Staticset_GLib.Bytes holding the Gtk.Builder XML
Staticset_resource path to load the template from
Staticset_Gtk.BuilderScope to use when loading the class template
Displays the contents of a Gtk.TextBuffer.
You may wish to begin by reading the conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.
Shortcuts and Gestures
Gtk.TextView supports the following keyboard shortcuts:
Additionally, the following signals have default keybindings:
Gtk.TextView::backspaceGtk.TextView::copy-clipboardGtk.TextView::cut-clipboardGtk.TextView::delete-from-cursorGtk.TextView::insert-emojiGtk.TextView::move-cursorGtk.TextView::paste-clipboardGtk.TextView::select-allGtk.TextView::toggle-cursor-visibleGtk.TextView::toggle-overwriteActions
Gtk.TextView defines a set of built-in actions:
clipboard.copycopies the contents to the clipboard.clipboard.cutcopies the contents to the clipboard and deletes it from the widget.clipboard.pasteinserts the contents of the clipboard into the widget.menu.popupopens the context menu.misc.insert-emojiopens the Emoji chooser.selection.deletedeletes the current selection.selection.select-allselects all of the widgets content.text.redoredoes the last change to the contents.text.undoundoes the last change to the contents.text.clearclears the content.CSS nodes
Gtk.TextView has a main css node with name textview and style class .view, and subnodes for each of the border windows, and the main text area, with names border and text, respectively. The border nodes each get one of the style classes .left, .right, .top or .bottom.
A node representing the selection will appear below the text node.
If a context menu is opened, the window node will appear as a subnode of the main node.
Accessibility
Gtk.TextView uses the Gtk.AccessibleRole.TEXT_BOX role.