[1368:7] extends: object
Generated low-level callback wrapper for GIR callback delete-from-cursor.
TextDeletefromcursorCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, type, count, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1298:7] extends: object
Generated low-level callback wrapper for GIR callback cut-clipboard.
TextCutclipboardCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[83:7] extends: object
A single-line text entry. GtkText is the common implementation of
single-line text editing that is shared between [class@Gtk.Entry],
[class@Gtk.PasswordEntry], [class@Gtk.SpinButton], and other widgets. In all
of these, a GtkText instance is used as the delegate for the
[iface@Gtk.Editable] implementation. A large number of key bindings s
supported by default. If the entered text is longer than the allocation of
the widget, the widget will scroll so that the cursor position is visible.
When using an entry for passwords and other sensitive information, it can be
put into “password mode” using [method@Gtk.Text.set_visibility]. In this
mode, entered text is displayed using an “invisible” character. By default,
GTK picks the best invisible character that is available in the current font,
but it can be changed with [method@Gtk.Text.set_invisible_char]. If you want
to add icons or progress display in an entry, look at [class@Gtk.Entry].
There are other alternatives for more specialized use cases, such as
[class@Gtk.SearchEntry]. If you need multi-line editable text, use
[class@Gtk.TextView]. # Shortcuts and Gestures GtkText supports the
following keyboard shortcuts: - Shift+F10 or
Menu opens the context menu. - Ctrl+A or
Ctrl+/ selects all the text. -
Ctrl+Shift+A or
Ctrl+\ unselects all. -
Ctrl+Z undoes the last modification. -
Ctrl+Y or Ctrl+Shift+Z
redoes the last undone modification. -
Ctrl+Shift+T toggles the text direction. -
Clear clears the content. Additionally, the following signals have
default keybindings: - [signal@Gtk.Text::activate] -
[signal@Gtk.Text::backspace] - [signal@Gtk.Text::copy-clipboard] -
[signal@Gtk.Text::cut-clipboard] - [signal@Gtk.Text::delete-from-cursor] -
[signal@Gtk.Text::insert-emoji] - [signal@Gtk.Text::move-cursor] -
[signal@Gtk.Text::paste-clipboard] - [signal@Gtk.Text::toggle-overwrite] #
Actions GtkText defines a set of built-in actions: - clipboard.copy
copies the contents to the clipboard. - clipboard.cut copies the contents
to the clipboard and deletes it from the widget. - clipboard.paste inserts
the contents of the clipboard into the widget. - menu.popup opens the
context menu. - misc.insert-emoji opens the Emoji chooser. -
misc.toggle-visibility toggles the GtkText:visibility property. -
misc.toggle-direction toggles the text direction. - selection.delete
deletes the current selection. - selection.select-all selects all of the
widgets content. - text.redo redoes the last change to the contents. -
text.undo undoes the last change to the contents. - text.clear removes
all content. # CSS nodes text[.read-only] ├── placeholder ├── undershoot.left ├── undershoot.right ├── [selection] ├── [block-cursor] ├── [cursor-handle[.top/.bottom][.insertion-cursor]] ├── [preedit[.whole][.selection][.prediction][.prefix/.suffix][.spelling-error][.compose-error]] ╰── [window.popup] GtkText has a main node with the name text.
Depending on the properties of the widget, the .read-only style class may
appear. When the entry has a selection, it adds a subnode with the name
selection. When the entry is in overwrite mode, it adds a subnode with the
name block-cursor that determines how the block cursor is drawn. The CSS
node for a context menu is added as a subnode with the name popup. The
undershoot nodes are used to draw the underflow indication when content is
scrolled out of view. These nodes get the .left or .right style class
added depending on where the indication is drawn. When touch is used and
touch selection handles are shown, they are using CSS nodes with name
cursor-handle. They get the .top or .bottom style class depending on
where they are shown in relation to the selection. If there is just a single
handle for the text cursor, it gets the style class .insertion-cursor. If
using an input method with a pre-edit buffer, this string will be styled with
the preedit CSS node, the different style classes express the possible
roles of a piece of text in the pre-edit buffer: - .whole denotes the parts
of the pre-edit buffer without a special role - .selection, .prefix and
.suffix style classes will be used to highlight the specific portions of
the pre-edit buffer being edited and its surroundings - .prediction will be
used for parts of the pre-edit buffer not typed by the user (e.g.
autocompletion) - .spelling-error and .compose-error will be respectively
used to indicate errors in spelling or character composition (e.g.
non-existent transliterations). # Accessibility GtkText uses the
[enum@Gtk.AccessibleRole.none] role, which causes it to be skipped for
accessibility. This is because GtkText is expected to be used as a delegate
for a GtkEditable implementation that will be represented to accessibility.
Text (buffer = null)
Creates a new
GtkText.
buffer is the buffer to use.toNativeHandle (Source)
Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from
fn.call(...), another generated wrapper exposinghandle(), or null. Returns null when the argument carries no pointer.
Source is the raw handle, raw buffer, wrapper, or null.A raw pointer carrier or null when no pointer is present.getLib ()
Returns the opened native library for this generated wrapper.
The opened native library.handle ()
Returns the wrapped NativeHandle.
The wrapped NativeHandle.isNull ()
Returns true when the wrapped handle is null.
A bool.describe ()
Returns a small string for debugging generated wrappers.
A string.asWidget ()
Wraps this handle as
Widget.
A Widget object.asAccessible ()
Wraps this handle as
Accessible.
A Accessible object.asAccessibleText ()
Wraps this handle as
AccessibleText.
A AccessibleText object.asBuildable ()
Wraps this handle as
Buildable.
A Buildable object.asConstraintTarget ()
Wraps this handle as
ConstraintTarget.
A ConstraintTarget object.asEditable ()
Wraps this handle as
Editable.
A Editable object.connectSignal (string Name, CallbackObj)
Connects one generated callback wrapper to a named signal.
Name is the signal name.CallbackObj is the generated callback wrapper to connect.The connected handler id.disconnectSignalHandler (int HandlerId)
Disconnects one retained signal handler id.
HandlerId is the signal handler id to disconnect.None.setOnActivate (callback Fn, UserData = null)
Emitted when the user hits the Enter key. The default bindings for this signal are all forms of the Enter key.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnBackspace (callback Fn, UserData = null)
Emitted when the user asks for it. This is a keybinding signal. The default bindings for this signal are Backspace and Shift+Backspace.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnCopyclipboard (callback Fn, UserData = null)
Emitted to copy the selection to the clipboard. This is a keybinding signal. The default bindings for this signal are Ctrl+c and Ctrl+Insert.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnCutclipboard (callback Fn, UserData = null)
Emitted to cut the selection to the clipboard. This is a keybinding signal. The default bindings for this signal are Ctrl+x and Shift+Delete.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnDeletefromcursor (callback Fn, UserData = null)
Emitted when the user initiates a text deletion. This is a keybinding signal. If the @type is [enum@Gtk.DeleteType.chars], GTK deletes the selection if there is one, otherwise it deletes the requested number of characters. The default bindings for this signal are Delete for deleting a character and Ctrl+Delete for deleting a word.
Fn is the Aussom callback.Fn is called with (Text Self, string Type, int Count).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnInsertatcursor (callback Fn, UserData = null)
Emitted when the user initiates the insertion of a fixed string at the cursor. This is a keybinding signal. This signal has no default bindings.
Fn is the Aussom callback.Fn is called with (Text Self, string ArgString).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnInsertemoji (callback Fn, UserData = null)
Emitted to present the Emoji chooser. This is a keybinding signal. The default bindings for this signal are Ctrl+. and Ctrl+;
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnMovecursor (callback Fn, UserData = null)
Emitted when the user initiates a cursor movement. If the cursor is not visible in @self, this signal causes the viewport to be moved instead. This is a keybinding signal. Applications should not connect to it, but may emit it with [func@GObject.signal_emit_by_name] if they need to control the cursor programmatically. The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without it does not. There are too many key combinations to list them all here. - ←, →, ↑, ↓ move by individual characters/lines - Ctrl+←, etc. move by words/paragraphs - Home and End move to the ends of the buffer
Fn is the Aussom callback.Fn is called with (Text Self, string Step, int Count, bool Extend).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnPasteclipboard (callback Fn, UserData = null)
Emitted to paste the contents of the clipboard. This is a keybinding signal. The default bindings for this signal are Ctrl+v and Shift+Insert.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnPreeditchanged (callback Fn, UserData = null)
Emitted when the preedit text changes. If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.
Fn is the Aussom callback.Fn is called with (Text Self, string Preedit).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.setOnToggleoverwrite (callback Fn, UserData = null)
Emitted to toggle the overwrite mode. This is a keybinding signal. The default bindings for this signal is Insert.
Fn is the Aussom callback.Fn is called with (Text Self).UserData is retained and passed through to the generated callback wrapper when provided.The connected handler id.getProperty (string Name)
Reads one generated property by name.
setProperty (string Name, Value)
Writes one generated property by name.
setActivatesdefault (bool Value)
Whether to activate the default widget when Enter is pressed.
Value is the new property value.None.setAttributes (object Value)
A list of Pango attributes to apply to the text. This is mainly useful to change the size or weight of the text. The
PangoAttribute's
and @end_index must refer to the GtkEntryBuffer text, i.e. without the preedit string.Value is the new property value.None.setBuffer (object Value)
The
GtkEntryBufferobject which stores the text.
Value is the new property value.None.setEnableemojicompletion (bool Value)
Whether to suggest Emoji replacements.
Value is the new property value.None.setExtramenu (object Value)
A menu model whose contents will be appended to the context menu.
Value is the new property value.None.setImmodule (string Value)
Which input method module should be used. See [class@Gtk.IMMulticontext]. Setting this to a non-
NULLvalue overrides the system-wide input method. See the [property@Gtk.Settings:gtk-im-module] setting.
Value is the new property value.None.setInputhints (string Value)
Additional hints that allow input methods to fine-tune their behaviour.
Value is the new property value.None.setInputpurpose (string Value)
The purpose of this text field. This information can be used by on-screen keyboards and other input methods to adjust their behaviour. Note that setting the purpose to [enum@Gtk.InputPurpose.password] or [enum@Gtk.InputPurpose.pin] is independent from setting [property@Gtk.Text:visibility].
Value is the new property value.None.setInvisiblechar (int Value)
The character to used when masking contents (in “password mode”).
Value is the new property value.None.setInvisiblecharset (bool Value)
Whether the invisible char has been set.
Value is the new property value.None.setMaxlength (int Value)
Maximum number of characters that are allowed. Zero indicates no limit.
Value is the new property value.None.setOverwritemode (bool Value)
If text is overwritten when typing.
Value is the new property value.None.setPlaceholdertext (string Value)
The text that will be displayed in the
GtkTextwhen it is empty and unfocused.
Value is the new property value.None.setPropagatetextwidth (bool Value)
Whether the widget should grow and shrink with the content.
Value is the new property value.None.setTabs (object Value)
Custom tabs for this text widget.
Value is the new property value.None.setTruncatemultiline (bool Value)
When true, pasted multi-line text is truncated to the first line.
Value is the new property value.None.setVisibility (bool Value)
If false, the text is masked with the “invisible char”.
Value is the new property value.None.get_activates_default ()
Returns whether pressing Enter will activate the default widget for the window containing the widget. See [method@Gtk.Text.set_activates_default].
get_attributes ()
Gets the attribute list that was set on the text widget. See [method@Gtk.Text.set_attributes].
get_buffer ()
Get the entry buffer object which holds the text for this widget.
get_enable_emoji_completion ()
Returns whether Emoji completion is enabled.
get_extra_menu ()
Gets the extra menu model of the text widget. See [method@Gtk.Text.set_extra_menu].
get_input_hints ()
Gets the input hints of the text widget.
get_input_purpose ()
Gets the input purpose of the text widget.
get_max_length ()
Retrieves the maximum allowed length of the contents. See [method@Gtk.Text.set_max_length]. This is equivalent to getting @self's
GtkEntryBufferand calling [method@Gtk.EntryBuffer.get_max_length] on it.
get_overwrite_mode ()
Gets whether text is overwritten when typing. See [method@Gtk.Text.set_overwrite_mode].
get_placeholder_text ()
Retrieves the text that will be displayed when the text widget is empty and unfocused See [method@Gtk.Text.set_placeholder_text].
get_propagate_text_width ()
Returns whether the text widget will grow and shrink with the content.
get_tabs ()
Gets the tab stops for the text widget. See [method@Gtk.Text.set_tabs].
get_truncate_multiline ()
Returns whether pasted text will be truncated to the first line.
get_visibility ()
Retrieves whether the text is visible.
grab_focus_without_selecting ()
Causes the text widget to have the keyboard focus. It behaves like [method@Gtk.Widget.grab_focus], except that it does not select the contents of @self. You only want to call this on some special entries which the user usually doesn't want to replace all text in, such as search-as-you-type entries.
set_activates_default (bool activates)
Sets whether pressing Enter will activate the default widget. This usually means that the dialog containing @self will be closed, since the default widget is usually one of the dialog buttons.
activates is true to activate window’s default widget on Enter keypress.None.set_attributes (object attrs)
Apply attributes to the contents of the text widget.
attrs is a list of style attributes.None.set_buffer (object buffer)
Set the entry buffer object which holds the text for this widget.
buffer is an entry buffer object.None.set_enable_emoji_completion (bool enable_emoji_completion)
Sets whether Emoji completion is enabled. If it is, typing ':', followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword.
enable_emoji_completion is true to enable Emoji completion.None.set_extra_menu (object model)
Sets a menu model to add to the context menu of the text widget.
model is a menu model.None.set_input_hints (string hints)
Sets hints that allow input methods to fine-tune their behaviour.
hints is input hints.None.set_input_purpose (string purpose)
Sets the input purpose of the text widget. The input purpose can be used by on-screen keyboards and other input methods to adjust their behaviour.
purpose is the input purpose.None.set_max_length (int length)
Sets the maximum allowed length of the contents. If the current contents are longer than the given length, they will be truncated to fit. This is equivalent to getting @self's
GtkEntryBufferand calling [method@Gtk.EntryBuffer.set_max_length] on it.
length is the maximum length of the text, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range 0-65536.None.set_overwrite_mode (bool overwrite)
Sets whether the text is overwritten when typing.
overwrite is new value.None.set_placeholder_text (string text)
Sets the text to be displayed when the text widget is empty and unfocused. This can be used to give a visual hint of the expected contents of the text widget.
text is a string to be displayed when @self is empty and unfocused.None.set_propagate_text_width (bool propagate_text_width)
Sets whether the text widget should grow and shrink with the content.
propagate_text_width is true to propagate the text width.None.set_tabs (object tabs)
Sets tab stops for the text widget.
tabs is tab stops.None.set_truncate_multiline (bool truncate_multiline)
Sets whether pasted text should be truncated to the first line.
truncate_multiline is true to truncate multi-line text.None.set_visibility (bool visible)
Sets whether the contents of the text widget are visible or not. When visibility is set to false, characters are displayed as the invisible char, and it will also appear that way when the text in the widget is copied to the clipboard. By default, GTK picks the best invisible character available in the current font, but it can be changed with [method@Gtk.Text.set_invisible_char]. Note that you probably want to set [property@Gtk.Text:input-purpose] to [enum@Gtk.InputPurpose.password] or [enum@Gtk.InputPurpose.pin] to inform input methods about the purpose of this widget, in addition to setting visibility to false.
visible is true if the contents of the text widget are displayed as plain text.None.unset_invisible_char ()
Unsets the invisible char. After calling this, the default invisible char is used again.
None.[1721:7] extends: object
Generated low-level callback wrapper for GIR callback preedit-changed.
TextPreeditchangedCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, preedit, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1439:7] extends: object
Generated low-level callback wrapper for GIR callback insert-at-cursor.
TextInsertatcursorCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, arg0String, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1651:7] extends: object
Generated low-level callback wrapper for GIR callback paste-clipboard.
TextPasteclipboardCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1158:7] extends: object
Generated low-level callback wrapper for GIR callback backspace.
TextBackspaceCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1088:7] extends: object
Generated low-level callback wrapper for GIR callback activate.
TextActivateCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1509:7] extends: object
Generated low-level callback wrapper for GIR callback insert-emoji.
TextInsertemojiCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1861:14] static extends: object
Generated metadata helpers for Text class surfaces.
properties ()
Returns property metadata for
Text.
A list.signals ()
Returns signal metadata for
Text.
A list.[1228:7] extends: object
Generated low-level callback wrapper for GIR callback copy-clipboard.
TextCopyclipboardCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1579:7] extends: object
Generated low-level callback wrapper for GIR callback move-cursor.
TextMovecursorCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, step, count, extend, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
[1791:7] extends: object
Generated low-level callback wrapper for GIR callback toggle-overwrite.
TextToggleoverwriteCallback (callback Fn, UserData = null)
Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking
Fn.
Fn is the Aussom callback implementation.UserData is retained and passed through to Fn on each invocation when provided.trampoline (nativeSelf, nativeUserData)
Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.
callback ()
Returns the wrapped NativeCallback.
handle ()
Returns the callback as a NativeHandle.
close ()
Closes the underlying NativeCallback.
isClosed ()
Returns true when the callback has been closed.
