Text

Object Hierarchy:

Description:

Content:

Properties:

• public bool activates_default { get; set; }
  Whether to activate the default widget when <kbd>Enter</kbd> is pressed.
• public AttrList attributes { get; set; }
  A list of Pango attributes to apply to the text.
• public EntryBuffer buffer { get; set construct; }
  The `GtkEntryBuffer` object which stores the text.
• public bool enable_emoji_completion { get; set; }
  Whether to suggest Emoji replacements.
• public MenuModel extra_menu { get; set; }
  A menu model whose contents will be appended to the context menu.
• public string im_module { owned get; set; }
  Which input method module should be used.
• public InputHints input_hints { get; set; }
  Additional hints that allow input methods to fine-tune their behaviour.
• public InputPurpose input_purpose { get; set; }
  The purpose of this text field.
• public uint invisible_char { get; set; }
  The character to used when masking contents (in “password mode”).
• public bool invisible_char_set { get; set; }
  Whether the invisible char has been set.
• public int max_length { get; set; }
  Maximum number of characters that are allowed.
• public bool overwrite_mode { get; set; }
  If text is overwritten when typing.
• public string placeholder_text { get; set; }
  The text that will be displayed in the `GtkText` when it is empty and unfocused.
• public bool propagate_text_width { get; set; }
  Whether the widget should grow and shrink with the content.
• public int scroll_offset { get; }
  Number of pixels scrolled of the screen to the left.
• public TabArray tabs { get; set; }
  Custom tabs for this text widget.
• public bool truncate_multiline { get; set; }
  When true, pasted multi-line text is truncated to the first line.
• public bool visibility { get; set; }
  If false, the text is masked with the “invisible char”.

Creation methods:

• public Text ()
  Creates a new `GtkText`.
• public Text.with_buffer (EntryBuffer buffer)
  Creates a new `GtkText` with the specified buffer.

Methods:

• public void compute_cursor_extents (size_t position, out Rect strong, out Rect @weak)
  Determines the positions of the strong and weak cursors for a given character position.
• public bool get_activates_default ()
  Returns whether pressing <kbd>Enter</kbd> will activate the default widget for the window containing the widget.
• public unowned AttrList? get_attributes ()
  Gets the attribute list that was set on the text widget.
• public unowned EntryBuffer get_buffer ()
  Get the entry buffer object which holds the text for this widget.
• public bool get_enable_emoji_completion ()
  Returns whether Emoji completion is enabled.
• public unowned MenuModel? get_extra_menu ()
  Gets the extra menu model of the text widget.
• public InputHints get_input_hints ()
  Gets the input hints of the text widget.
• public InputPurpose get_input_purpose ()
  Gets the input purpose of the text widget.
• public unichar get_invisible_char ()
  Retrieves the character displayed when visibility is set to false.
• public int get_max_length ()
  Retrieves the maximum allowed length of the contents.
• public bool get_overwrite_mode ()
  Gets whether text is overwritten when typing.
• public unowned string? get_placeholder_text ()
  Retrieves the text that will be displayed when the text widget is empty and unfocused
• public bool get_propagate_text_width ()
  Returns whether the text widget will grow and shrink with the content.
• public unowned TabArray? get_tabs ()
  Gets the tab stops for the text widget.
• public uint16 get_text_length ()
  Retrieves the length of the contents.
• public bool get_truncate_multiline ()
  Returns whether pasted text will be truncated to the first line.
• public bool get_visibility ()
  Retrieves whether the text is visible.
• public bool grab_focus_without_selecting ()
  Causes the text widget to have the keyboard focus.
• public void set_activates_default (bool activates)
  Sets whether pressing <kbd>Enter</kbd> will activate the default widget.
• public void set_attributes (AttrList? attrs)
  Apply attributes to the contents of the text widget.
• public void set_buffer (EntryBuffer buffer)
  Set the entry buffer object which holds the text for this widget.
• public void set_enable_emoji_completion (bool enable_emoji_completion)
  Sets whether Emoji completion is enabled.
• public void set_extra_menu (MenuModel? model)
  Sets a menu model to add to the context menu of the text widget.
• public void set_input_hints (InputHints hints)
  Sets hints that allow input methods to fine-tune their behaviour.
• public void set_input_purpose (InputPurpose purpose)
  Sets the input purpose of the text widget.
• public void set_invisible_char (unichar ch)
  Sets the character to use when in “password mode”.
• public void set_max_length (int length)
  Sets the maximum allowed length of the contents.
• public void set_overwrite_mode (bool overwrite)
  Sets whether the text is overwritten when typing.
• public void set_placeholder_text (string? text)
  Sets the text to be displayed when the text widget is empty and unfocused.
• public void set_propagate_text_width (bool propagate_text_width)
  Sets whether the text widget should grow and shrink with the content.
• public void set_tabs (TabArray? tabs)
  Sets tab stops for the text widget.
• public void set_truncate_multiline (bool truncate_multiline)
  Sets whether pasted text should be truncated to the first line.
• public void set_visibility (bool visible)
  Sets whether the contents of the text widget are visible or not.
• public void unset_invisible_char ()
  Unsets the invisible char.

Signals:

• public signal void activate ()
  Emitted when the user hits the <kbd>Enter</kbd> key.
• public signal void backspace ()
  Emitted when the user asks for it.
• public signal void copy_clipboard ()
  Emitted to copy the selection to the clipboard.
• public signal void cut_clipboard ()
  Emitted to cut the selection to the clipboard.
• public signal void delete_from_cursor (DeleteType type, int count)
  Emitted when the user initiates a text deletion.
• public signal void insert_at_cursor (string str)
  Emitted when the user initiates the insertion of a fixed string at the cursor.
• public signal void insert_emoji ()
  Emitted to present the Emoji chooser.
• public signal void move_cursor (MovementStep step, int count, bool extend)
  Emitted when the user initiates a cursor movement.
• public signal void paste_clipboard ()
  Emitted to paste the contents of the clipboard.
• public signal void preedit_changed (string preedit)
  Emitted when the preedit text changes.
• public signal void toggle_overwrite ()
  Emitted to toggle the overwrite mode.

Inherited Members: