Skip to main content

Type Alias: AdwEntryRowProps

AdwEntryRowProps = Omit<AdwPreferencesRowProps, "onNotify"> & object

Defined in: generated/jsx.ts:3841

Props for the AdwEntryRow widget.

Type Declaration

NameTypeDescriptionDefined in
activatesDefault?booleanWhether activating the embedded entry can activate the default widget.generated/jsx.ts:3843
attributes?Pango.AttrList | nullA list of Pango attributes to apply to the text of the embedded entry. The PangoAttribute's start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.generated/jsx.ts:3850
children?ReactNode-generated/jsx.ts:3941
editable?booleanWhether the entry contents can be edited.generated/jsx.ts:3886
enableEmojiCompletion?booleanWhether to suggest emoji replacements on the entry row. Emoji replacement is done with :-delimited names, like :heart:.generated/jsx.ts:3856
enableUndo?booleanIf undo/redo should be enabled for the editable.generated/jsx.ts:3888
inputHints?Gtk.InputHintsAdditional input hints for the entry row. Input hints allow input methods to fine-tune their behavior. See also: AdwEntryRow.input-purposegenerated/jsx.ts:3864
inputPurpose?Gtk.InputPurposeThe input purpose of the entry row. The input purpose can be used by input methods to adjust their behavior.generated/jsx.ts:3870
maxLength?numberMaximum number of characters for the entry.generated/jsx.ts:3872
maxWidthChars?numberThe desired maximum width of the entry, in characters.generated/jsx.ts:3890
onApply()?(self) => void | nullEmitted when the apply button is pressed. See AdwEntryRow.show-apply-button.generated/jsx.ts:3906
onChanged()?(self) => void | nullEmitted at the end of a single user-visible operation on the contents. E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).generated/jsx.ts:3919
onDeleteText()?(self, startPos, endPos) => void | nullEmitted when text is deleted from the widget by the user. The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely. The start_pos and end_pos parameters are interpreted as for Editable.delete_text.generated/jsx.ts:3931
onEntryActivated()?(self) => void | nullEmitted when the embedded entry is activated.generated/jsx.ts:3908
onInsertText()?(self, text, length, position) => void | nullEmitted when text is inserted into the widget by the user. The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.generated/jsx.ts:3940
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:3947
ref?Ref<Adw.EntryRow>-generated/jsx.ts:3966
showApplyButton?booleanWhether to show the apply button. When set to TRUE, typing text in the entry will reveal an apply button. Clicking it or pressing the Enter key will hide the button and emit the AdwEntryRow.:apply signal. This is useful if changing the entry contents can trigger an expensive operation, e.g. network activity, to avoid triggering it after typing every character.generated/jsx.ts:3884
text?stringThe contents of the entry.generated/jsx.ts:3892
widthChars?numberNumber of characters to leave space for in the entry.generated/jsx.ts:3894
xalign?numberThe horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.generated/jsx.ts:3900