Skip to main content

Type Alias: GtkListBoxProps

GtkListBoxProps = WidgetProps & object

Defined in: generated/jsx.ts:6155

Props for the GtkListBox widget.

Type Declaration

NameTypeDescriptionDefined in
acceptUnpairedRelease?booleanWhether to accept unpaired release events.generated/jsx.ts:6157
activateOnSingleClick?booleanDetermines whether children can be activated with a single click, or require a double-click.generated/jsx.ts:6162
children?ReactNode-generated/jsx.ts:6229
onActivateCursorRow()?(self) => void | nullEmitted when the cursor row is activated.generated/jsx.ts:6170
onMoveCursor()?(self, step, count, extend, modify) => void | nullEmitted when the user initiates a cursor movement. The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here. - , , , move by individual children - Home, End move to the ends of the box - PgUp, PgDn move vertically by pagesgenerated/jsx.ts:6184
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:6235
onRowActivated()?(self, row) => void | nullEmitted when a row has been activated by the user.generated/jsx.ts:6192
onRowSelected()?(self, row) => void | nullEmitted when a new row is selected, or (with a %NULL row) when the selection is cleared. When the box is using %GTK_SELECTION_MULTIPLE, this signal will not give you the full picture of selection changes, and you should use the ListBox.:selected-rows-changed signal instead.generated/jsx.ts:6201
onSelectAll()?(self) => void | nullEmitted to select all children of the box, if the selection mode permits it. This is a keybinding signal. The default binding for this signal is Ctrl-a.generated/jsx.ts:6210
onSelectedRowsChanged()?(self) => void | nullEmitted when the set of selected rows changes.generated/jsx.ts:6212
onToggleCursorRow()?(self) => void | nullEmitted when the cursor row is toggled. The default bindings for this signal is Ctrl+.generated/jsx.ts:6218
onUnselectAll()?(self) => void | nullEmitted to unselect all children of the box, if the selection mode permits it. This is a keybinding signal. The default binding for this signal is Ctrl-Shift-a.generated/jsx.ts:6228
ref?Ref<Gtk.ListBox>-generated/jsx.ts:6246
selectionMode?Gtk.SelectionModeThe selection mode used by the list box.generated/jsx.ts:6164
showSeparators?booleanWhether to show separators between rows.generated/jsx.ts:6166
tabBehavior?Gtk.ListTabBehaviorBehavior of the Tab keygenerated/jsx.ts:6168