Class

AdwEntryRow

Description [src]

class Adw.EntryRow : Adw.PreferencesRow {
  parent_instance: AdwPreferencesRow
}

A GtkListBoxRow with an embedded text entry.

entry-row

AdwEntryRow has a title that doubles as placeholder text. It shows an icon indicating that it’s editable and can receive additional widgets before or after the editable part.

If AdwEntryRow:show-apply-button is set to TRUE, AdwEntryRow can show an apply button when editing its contents. This can be useful if changing its contents can result in an expensive operation, such as network activity.

AdwEntryRow provides only minimal API and should be used with the GtkEditable API.

See also AdwPasswordEntryRow.

AdwEntryRow as GtkBuildable

The AdwEntryRow implementation of the GtkBuildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a element.

It also supports adding a child as a prefix widget by specifying “prefix” as the “type” attribute of a element.

CSS nodes

AdwEntryRow has a single CSS node with name row and the .entry style class.

Available since:1.2

Descendants

Constructors

adw_entry_row_new

Creates a new AdwEntryRow.

Available since: 1.2

Instance methods

adw_entry_row_add_prefix

Adds a prefix widget to self.

Available since: 1.2

adw_entry_row_add_suffix

Adds a suffix widget to self.

Available since: 1.2

adw_entry_row_get_activates_default

Gets whether activating the embedded entry can activate the default widget.

adw_entry_row_get_attributes

Gets Pango attributes applied to the text of the embedded entry.

Available since: 1.2

adw_entry_row_get_enable_emoji_completion

Gets whether to suggest emoji replacements on self.

Available since: 1.2

adw_entry_row_get_input_hints

Gets the additional input hints of self.

Available since: 1.2

adw_entry_row_get_input_purpose

Gets the input purpose of self.

Available since: 1.2

adw_entry_row_get_show_apply_button

Gets whether self can show the apply button.

Available since: 1.2

adw_entry_row_remove

Removes a child from self.

Available since: 1.2

adw_entry_row_set_activates_default

Sets whether activating the embedded entry can activate the default widget.

Available since: 1.2

adw_entry_row_set_attributes

Sets Pango attributes to apply to the text of the embedded entry.

Available since: 1.2

adw_entry_row_set_enable_emoji_completion

Sets whether to suggest emoji replacements on self.

Available since: 1.2

adw_entry_row_set_input_hints

Set additional input hints for self.

Available since: 1.2

adw_entry_row_set_input_purpose

Sets the input purpose of self.

Available since: 1.2

adw_entry_row_set_show_apply_button

Sets whether self can show the apply button.

Available since: 1.2

Methods inherited from AdwPreferencesRow (8)
adw_preferences_row_get_title

Gets the title of the preference represented by self.

Available since: 1.0

adw_preferences_row_get_title_selectable

Gets whether the user can copy the title from the label.

Available since: 1.1

adw_preferences_row_get_use_markup

Gets whether to use Pango markup for the title label.

Available since: 1.2

adw_preferences_row_get_use_underline

Gets whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

adw_preferences_row_set_title

Sets the title of the preference represented by self.

Available since: 1.0

adw_preferences_row_set_title_selectable

Sets whether the user can copy the title from the label.

Available since: 1.1

adw_preferences_row_set_use_markup

Sets whether to use Pango markup for the title label.

Available since: 1.2

adw_preferences_row_set_use_underline

Sets whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

Methods inherited from GtkListBoxRow (11)
gtk_list_box_row_changed

Marks row as changed, causing any state that depends on this to be updated.

gtk_list_box_row_get_activatable

Gets whether the row is activatable.

gtk_list_box_row_get_child

Gets the child widget of row.

gtk_list_box_row_get_header

Returns the current header of the row.

gtk_list_box_row_get_index

Gets the current index of the row in its GtkListBox container.

gtk_list_box_row_get_selectable

Gets whether the row can be selected.

gtk_list_box_row_is_selected

Returns whether the child is currently selected in its GtkListBox container.

gtk_list_box_row_set_activatable

Set whether the row is activatable.

gtk_list_box_row_set_child

Sets the child widget of self.

gtk_list_box_row_set_header

Sets the current header of the row.

gtk_list_box_row_set_selectable

Set whether the row can be selected.

Methods inherited from GtkWidget (160)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkActionable (6)
gtk_actionable_get_action_name

Gets the action name for actionable.

gtk_actionable_get_action_target_value

Gets the current target value of actionable.

gtk_actionable_set_action_name

Specifies the name of the action with which this widget should be associated.

gtk_actionable_set_action_target

Sets the target of an actionable widget.

gtk_actionable_set_action_target_value

Sets the target value of an actionable widget.

gtk_actionable_set_detailed_action_name

Sets the action-name and associated string target value of an actionable widget.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkEditable (23)
gtk_editable_delete_selection

Deletes the currently selected text of the editable.

gtk_editable_delete_text

Deletes a sequence of characters.

gtk_editable_finish_delegate

Undoes the setup done by gtk_editable_init_delegate().

gtk_editable_get_alignment

Gets the alignment of the editable.

gtk_editable_get_chars

Retrieves a sequence of characters.

gtk_editable_get_delegate

Gets the GtkEditable that editable is delegating its implementation to.

gtk_editable_get_editable

Retrieves whether editable is editable.

gtk_editable_get_enable_undo

Gets if undo/redo actions are enabled for editable.

gtk_editable_get_max_width_chars

Retrieves the desired maximum width of editable, in characters.

gtk_editable_get_position

Retrieves the current position of the cursor relative to the start of the content of the editable.

gtk_editable_get_selection_bounds

Retrieves the selection bound of the editable.

gtk_editable_get_text

Retrieves the contents of editable.

gtk_editable_get_width_chars

Gets the number of characters of space reserved for the contents of the editable.

gtk_editable_init_delegate

Sets up a delegate for GtkEditable.

gtk_editable_insert_text

Inserts length bytes of text into the contents of the widget, at position position.

gtk_editable_select_region

Selects a region of text.

gtk_editable_set_alignment

Sets the alignment for the contents of the editable.

gtk_editable_set_editable

Determines if the user can edit the text in the editable widget.

gtk_editable_set_enable_undo

If enabled, changes to editable will be saved for undo/redo actions.

gtk_editable_set_max_width_chars

Sets the desired maximum width in characters of editable.

gtk_editable_set_position

Sets the cursor position in the editable to the given value.

gtk_editable_set_text

Sets the text in the editable to the given value.

gtk_editable_set_width_chars

Changes the size request of the editable to be about the right size for n_chars characters.

Properties

Adw.EntryRow:activates-default

Whether activating the embedded entry can activate the default widget.

Available since: 1.2

Adw.EntryRow:attributes

A list of Pango attributes to apply to the text of the embedded entry.

Available since: 1.2

Adw.EntryRow:enable-emoji-completion

Whether to suggest emoji replacements on the entry row.

Available since: 1.2

Adw.EntryRow:input-hints

Additional input hints for the entry row.

Available since: 1.2

Adw.EntryRow:input-purpose

The input purpose of the entry row.

Available since: 1.2

Adw.EntryRow:show-apply-button

Whether to show the apply button.

Available since: 1.2

Properties inherited from AdwPreferencesRow (4)
Adw.PreferencesRow:title

The title of the preference represented by this row.

Available since: 1.0

Adw.PreferencesRow:title-selectable

Whether the user can copy the title from the label.

Available since: 1.1

Adw.PreferencesRow:use-markup

Whether to use Pango markup for the title label.

Available since: 1.2

Adw.PreferencesRow:use-underline

Whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

Properties inherited from GtkListBoxRow (3)
Gtk.ListBoxRow:activatable

Determines whether the ::row-activated signal will be emitted for this row.

Gtk.ListBoxRow:child

The child widget.

Gtk.ListBoxRow:selectable

Determines whether this row can be selected.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk-4.0.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkActionable (2)
Gtk-4.0.Actionable:action-name
No description available.
Gtk-4.0.Actionable:action-target
No description available.
Properties inherited from GtkEditable (8)
Gtk-4.0.Editable:cursor-position

The current position of the insertion cursor in chars.

Gtk-4.0.Editable:editable

Whether the entry contents can be edited.

Gtk-4.0.Editable:enable-undo

If undo/redo should be enabled for the editable.

Gtk-4.0.Editable:max-width-chars

The desired maximum width of the entry, in characters.

Gtk-4.0.Editable:selection-bound

The position of the opposite end of the selection from the cursor in chars.

Gtk-4.0.Editable:text

The contents of the entry.

Gtk-4.0.Editable:width-chars

Number of characters to leave space for in the entry.

Gtk-4.0.Editable:xalign

The horizontal alignment, from 0 (left) to 1 (right).

Signals

Adw.EntryRow::apply

Emitted when the apply button is pressed.

Available since: 1.2

Adw.EntryRow::entry-activated

Emitted when the embedded entry is activated.

Available since: 1.2

Signals inherited from GtkListBoxRow (1)
Gtk.ListBoxRow::activate

This is a keybinding signal, which will cause this row to be activated.

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Signals inherited from GtkEditable (3)
Gtk-4.0.Editable::changed

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

Gtk-4.0.Editable::delete-text

Emitted when text is deleted from the widget by the user.

Gtk-4.0.Editable::insert-text

Emitted when text is inserted into the widget by the user.

Class structure

struct AdwEntryRowClass {
  AdwPreferencesRowClass parent_class;
  
}
No description available.
Class members
parent_class: AdwPreferencesRowClass

The parent class.