Type Alias: GtkSearchEntryProps
GtkSearchEntryProps =
WidgetProps&object
Defined in: generated/jsx.ts:6515
Props for the GtkSearchEntry widget.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
activatesDefault? | boolean | Whether to activate the default widget when Enter is pressed. | generated/jsx.ts:6517 |
editable? | boolean | Whether the entry contents can be edited. | generated/jsx.ts:6539 |
enableUndo? | boolean | If undo/redo should be enabled for the editable. | generated/jsx.ts:6541 |
inputHints? | Gtk.InputHints | The hints about input for the GtkSearchEntry used to alter the behaviour of input methods. | generated/jsx.ts:6522 |
inputPurpose? | Gtk.InputPurpose | The purpose for the GtkSearchEntry input used to alter the behaviour of input methods. | generated/jsx.ts:6527 |
maxWidthChars? | number | The desired maximum width of the entry, in characters. | generated/jsx.ts:6543 |
onActivate? | (self) => void | null | Emitted when the entry is activated. The keybindings for this signal are all forms of the Enter key. | generated/jsx.ts:6559 |
onChanged? | (self) => void | null | Emitted 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:6614 |
onDeleteText? | (startPos, endPos, self) => void | null | Emitted 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:6626 |
onInsertText? | (text, length, position, self) => void | null | Emitted 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:6635 |
onNextMatch? | (self) => void | null | Emitted when the user initiates a move to the next match for the current search string. This is a keybinding signal. Applications should connect to it, to implement moving between matches. The default bindings for this signal is Ctrl+g. | generated/jsx.ts:6571 |
onPreviousMatch? | (self) => void | null | Emitted when the user initiates a move to the previous match for the current search string. This is a keybinding signal. Applications should connect to it, to implement moving between matches. The default bindings for this signal is Ctrl+Shift+g. | generated/jsx.ts:6584 |
onSearchChanged? | (self) => void | null | Emitted with a delay. The length of the delay can be changed with the SearchEntry.search-delay property. | generated/jsx.ts:6590 |
onSearchStarted? | (self) => void | null | Emitted when the user initiated a search on the entry. | generated/jsx.ts:6592 |
onStopSearch? | (self) => void | null | Emitted when the user stops a search via keyboard input. This is a keybinding signal. Applications should connect to it, to implement hiding the search entry in this case. The default bindings for this signal is Escape. | generated/jsx.ts:6603 |
placeholderText? | string | null | The text that will be displayed in the GtkSearchEntry when it is empty and unfocused. | generated/jsx.ts:6532 |
ref? | Ref<Gtk.SearchEntry> | - | generated/jsx.ts:6636 |
searchDelay? | number | The delay in milliseconds from last keypress to the search changed signal. | generated/jsx.ts:6537 |
text? | string | The contents of the entry. | generated/jsx.ts:6545 |
widthChars? | number | Number of characters to leave space for in the entry. | generated/jsx.ts:6547 |
xalign? | number | The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. | generated/jsx.ts:6553 |