Interface: GtkListViewProps
Defined in: packages/react/src/generated/jsx.ts:5059
Props for the GtkListView widget.
Extends
Properties
accessibleActiveDescendant?
optionalaccessibleActiveDescendant:Widget
Defined in: packages/react/src/jsx.ts:1175
Inherited from
GtkListBaseProps.accessibleActiveDescendant
accessibleAutocomplete?
optionalaccessibleAutocomplete:AccessibleAutocomplete
Defined in: packages/react/src/jsx.ts:1144
Inherited from
GtkListBaseProps.accessibleAutocomplete
accessibleBusy?
optionalaccessibleBusy:boolean
Defined in: packages/react/src/jsx.ts:1165
Inherited from
GtkListBaseProps.accessibleBusy
accessibleChecked?
optionalaccessibleChecked:AccessibleTristate
Defined in: packages/react/src/jsx.ts:1166
Inherited from
GtkListBaseProps.accessibleChecked
accessibleColCount?
optionalaccessibleColCount:number
Defined in: packages/react/src/jsx.ts:1176
Inherited from
GtkListBaseProps.accessibleColCount
accessibleColIndex?
optionalaccessibleColIndex:number
Defined in: packages/react/src/jsx.ts:1177
Inherited from
GtkListBaseProps.accessibleColIndex
accessibleColIndexText?
optionalaccessibleColIndexText:string
Defined in: packages/react/src/jsx.ts:1178
Inherited from
GtkListBaseProps.accessibleColIndexText
accessibleColSpan?
optionalaccessibleColSpan:number
Defined in: packages/react/src/jsx.ts:1179
Inherited from
GtkListBaseProps.accessibleColSpan
accessibleControls?
optionalaccessibleControls:Widget[]
Defined in: packages/react/src/jsx.ts:1180
Inherited from
GtkListBaseProps.accessibleControls
accessibleDescribedBy?
optionalaccessibleDescribedBy:Widget[]
Defined in: packages/react/src/jsx.ts:1181
Inherited from
GtkListBaseProps.accessibleDescribedBy
accessibleDescription?
optionalaccessibleDescription:string
Defined in: packages/react/src/jsx.ts:1145
Inherited from
GtkListBaseProps.accessibleDescription
accessibleDetails?
optionalaccessibleDetails:Widget[]
Defined in: packages/react/src/jsx.ts:1182
Inherited from
GtkListBaseProps.accessibleDetails
accessibleDisabled?
optionalaccessibleDisabled:boolean
Defined in: packages/react/src/jsx.ts:1167
Inherited from
GtkListBaseProps.accessibleDisabled
accessibleErrorMessage?
optionalaccessibleErrorMessage:Widget[]
Defined in: packages/react/src/jsx.ts:1183
Inherited from
GtkListBaseProps.accessibleErrorMessage
accessibleExpanded?
optionalaccessibleExpanded:boolean
Defined in: packages/react/src/jsx.ts:1168
Inherited from
GtkListBaseProps.accessibleExpanded
accessibleFlowTo?
optionalaccessibleFlowTo:Widget[]
Defined in: packages/react/src/jsx.ts:1184
Inherited from
GtkListBaseProps.accessibleFlowTo
accessibleHasPopup?
optionalaccessibleHasPopup:boolean
Defined in: packages/react/src/jsx.ts:1146
Inherited from
GtkListBaseProps.accessibleHasPopup
accessibleHelpText?
optionalaccessibleHelpText:string
Defined in: packages/react/src/jsx.ts:1163
Inherited from
GtkListBaseProps.accessibleHelpText
accessibleHidden?
optionalaccessibleHidden:boolean
Defined in: packages/react/src/jsx.ts:1169
Inherited from
GtkListBaseProps.accessibleHidden
accessibleInvalid?
optionalaccessibleInvalid:AccessibleInvalidState
Defined in: packages/react/src/jsx.ts:1170
Inherited from
GtkListBaseProps.accessibleInvalid
accessibleKeyShortcuts?
optionalaccessibleKeyShortcuts:string
Defined in: packages/react/src/jsx.ts:1147
Inherited from
GtkListBaseProps.accessibleKeyShortcuts
accessibleLabel?
optionalaccessibleLabel:string
Defined in: packages/react/src/jsx.ts:1148
Inherited from
GtkListBaseProps.accessibleLabel
accessibleLabelledBy?
optionalaccessibleLabelledBy:Widget[]
Defined in: packages/react/src/jsx.ts:1185
Inherited from
GtkListBaseProps.accessibleLabelledBy
accessibleLevel?
optionalaccessibleLevel:number
Defined in: packages/react/src/jsx.ts:1149
Inherited from
GtkListBaseProps.accessibleLevel
accessibleModal?
optionalaccessibleModal:boolean
Defined in: packages/react/src/jsx.ts:1150
Inherited from
GtkListBaseProps.accessibleModal
accessibleMultiLine?
optionalaccessibleMultiLine:boolean
Defined in: packages/react/src/jsx.ts:1151
Inherited from
GtkListBaseProps.accessibleMultiLine
accessibleMultiSelectable?
optionalaccessibleMultiSelectable:boolean
Defined in: packages/react/src/jsx.ts:1152
Inherited from
GtkListBaseProps.accessibleMultiSelectable
accessibleOrientation?
optionalaccessibleOrientation:Orientation
Defined in: packages/react/src/jsx.ts:1153
Inherited from
GtkListBaseProps.accessibleOrientation
accessibleOwns?
optionalaccessibleOwns:Widget[]
Defined in: packages/react/src/jsx.ts:1186
Inherited from
GtkListBaseProps.accessibleOwns
accessiblePlaceholder?
optionalaccessiblePlaceholder:string
Defined in: packages/react/src/jsx.ts:1154
Inherited from
GtkListBaseProps.accessiblePlaceholder
accessiblePosInSet?
optionalaccessiblePosInSet:number
Defined in: packages/react/src/jsx.ts:1187
Inherited from
GtkListBaseProps.accessiblePosInSet
accessiblePressed?
optionalaccessiblePressed:AccessibleTristate
Defined in: packages/react/src/jsx.ts:1171
Inherited from
GtkListBaseProps.accessiblePressed
accessibleReadOnly?
optionalaccessibleReadOnly:boolean
Defined in: packages/react/src/jsx.ts:1155
Inherited from
GtkListBaseProps.accessibleReadOnly
accessibleRequired?
optionalaccessibleRequired:boolean
Defined in: packages/react/src/jsx.ts:1156
Inherited from
GtkListBaseProps.accessibleRequired
accessibleRole?
optionalaccessibleRole:AccessibleRole
Defined in: packages/react/src/generated/jsx.ts:187
The accessible role of the given GtkAccessible implementation.
The accessible role cannot be changed once set.
Inherited from
GtkListBaseProps.accessibleRole
accessibleRoleDescription?
optionalaccessibleRoleDescription:string
Defined in: packages/react/src/jsx.ts:1157
Inherited from
GtkListBaseProps.accessibleRoleDescription
accessibleRowCount?
optionalaccessibleRowCount:number
Defined in: packages/react/src/jsx.ts:1188
Inherited from
GtkListBaseProps.accessibleRowCount
accessibleRowIndex?
optionalaccessibleRowIndex:number
Defined in: packages/react/src/jsx.ts:1189
Inherited from
GtkListBaseProps.accessibleRowIndex
accessibleRowIndexText?
optionalaccessibleRowIndexText:string
Defined in: packages/react/src/jsx.ts:1190
Inherited from
GtkListBaseProps.accessibleRowIndexText
accessibleRowSpan?
optionalaccessibleRowSpan:number
Defined in: packages/react/src/jsx.ts:1191
Inherited from
GtkListBaseProps.accessibleRowSpan
accessibleSelected?
optionalaccessibleSelected:boolean
Defined in: packages/react/src/jsx.ts:1172
Inherited from
GtkListBaseProps.accessibleSelected
accessibleSetSize?
optionalaccessibleSetSize:number
Defined in: packages/react/src/jsx.ts:1192
Inherited from
GtkListBaseProps.accessibleSetSize
accessibleSort?
optionalaccessibleSort:AccessibleSort
Defined in: packages/react/src/jsx.ts:1158
Inherited from
GtkListBaseProps.accessibleSort
accessibleValueMax?
optionalaccessibleValueMax:number
Defined in: packages/react/src/jsx.ts:1159
Inherited from
GtkListBaseProps.accessibleValueMax
accessibleValueMin?
optionalaccessibleValueMin:number
Defined in: packages/react/src/jsx.ts:1160
Inherited from
GtkListBaseProps.accessibleValueMin
accessibleValueNow?
optionalaccessibleValueNow:number
Defined in: packages/react/src/jsx.ts:1161
Inherited from
GtkListBaseProps.accessibleValueNow
accessibleValueText?
optionalaccessibleValueText:string
Defined in: packages/react/src/jsx.ts:1162
Inherited from
GtkListBaseProps.accessibleValueText
accessibleVisited?
optionalaccessibleVisited:boolean
Defined in: packages/react/src/jsx.ts:1173
Inherited from
GtkListBaseProps.accessibleVisited
autoexpand?
optionalautoexpand:boolean
Defined in: packages/react/src/jsx.ts:691
Whether to automatically expand new tree rows (default: false)
canFocus?
optionalcanFocus:boolean
Defined in: packages/react/src/generated/jsx.ts:24
Whether the widget or any of its descendents can accept the input focus.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
canTarget?
optionalcanTarget:boolean
Defined in: packages/react/src/generated/jsx.ts:26
Whether the widget can receive pointer events.
Inherited from
children?
optionalchildren:ReactNode
Defined in: packages/react/src/generated/jsx.ts:314
Children elements (child widgets or event controllers).
Inherited from
cssClasses?
optionalcssClasses:string[]
Defined in: packages/react/src/generated/jsx.ts:28
A list of css classes applied to this widget.
Inherited from
cssName?
optionalcssName:string
Defined in: packages/react/src/generated/jsx.ts:35
The name of this widget in the CSS tree.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
cursor?
optionalcursor:Cursor|null
Defined in: packages/react/src/generated/jsx.ts:37
The cursor used by widget.
Inherited from
enableRubberband?
optionalenableRubberband:boolean
Defined in: packages/react/src/generated/jsx.ts:5061
Allow rubberband selection.
estimatedItemHeight?
optionalestimatedItemHeight:number
Defined in: packages/react/src/jsx.ts:674
Estimated item height in pixels for virtualization
estimatedItemWidth?
optionalestimatedItemWidth:number
Defined in: packages/react/src/jsx.ts:676
Estimated item width in pixels for virtualization
focusable?
optionalfocusable:boolean
Defined in: packages/react/src/generated/jsx.ts:45
Whether this widget itself will accept the input focus.
Inherited from
focusOnClick?
optionalfocusOnClick:boolean
Defined in: packages/react/src/generated/jsx.ts:43
Whether the widget should grab focus when it is clicked with the mouse.
This property is only relevant for widgets that can take focus.
Inherited from
hadjustment?
optionalhadjustment:Adjustment
Defined in: packages/react/src/generated/jsx.ts:4944
Horizontal GtkAdjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Inherited from
halign?
optionalhalign:Align
Defined in: packages/react/src/generated/jsx.ts:47
How to distribute horizontal space if widget gets extra space.
Inherited from
hasTooltip?
optionalhasTooltip:boolean
Defined in: packages/react/src/generated/jsx.ts:56
Enables or disables the emission of the Widget.:query-tooltip
signal on widget.
A true value indicates that widget can have a tooltip, in this case
the widget will be queried using Widget.:query-tooltip to
determine whether it will provide a tooltip or not.
Inherited from
headerFactory?
optionalheaderFactory:ListItemFactory|null
Defined in: packages/react/src/generated/jsx.ts:5067
Factory for creating header widgets.
The factory must be for configuring ListHeader objects.
heightRequest?
optionalheightRequest:number
Defined in: packages/react/src/generated/jsx.ts:62
Overrides for height request of the widget.
If this is -1, the natural request will be used.
Inherited from
GtkListBaseProps.heightRequest
hexpand?
optionalhexpand:boolean
Defined in: packages/react/src/generated/jsx.ts:64
Whether to expand horizontally.
Inherited from
hexpandSet?
optionalhexpandSet:boolean
Defined in: packages/react/src/generated/jsx.ts:66
Whether to use the hexpand property.
Inherited from
hscrollPolicy?
optionalhscrollPolicy:ScrollablePolicy
Defined in: packages/react/src/generated/jsx.ts:4946
Determines when horizontal scrolling should start.
Inherited from
GtkListBaseProps.hscrollPolicy
items?
optionalitems:ListItem<unknown,unknown>[]
Defined in: packages/react/src/jsx.ts:687
Data items to display in the list
layoutManager?
optionallayoutManager:LayoutManager|null
Defined in: packages/react/src/generated/jsx.ts:74
The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
GtkListBaseProps.layoutManager
limitEvents?
optionallimitEvents:boolean
Defined in: packages/react/src/generated/jsx.ts:83
Makes this widget act like a modal dialog, with respect to event delivery.
Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See EventController.set_propagation_limit.
Inherited from
marginBottom?
optionalmarginBottom:number
Defined in: packages/react/src/generated/jsx.ts:91
Margin on bottom side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginEnd?
optionalmarginEnd:number
Defined in: packages/react/src/generated/jsx.ts:102
Margin on end of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginStart?
optionalmarginStart:number
Defined in: packages/react/src/generated/jsx.ts:113
Margin on start of widget, horizontally.
This property supports left-to-right and right-to-left text directions.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
marginTop?
optionalmarginTop:number
Defined in: packages/react/src/generated/jsx.ts:121
Margin on top side of widget.
This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from Widget.set_size_request for example.
Inherited from
name?
optionalname:string
Defined in: packages/react/src/generated/jsx.ts:123
The name of the widget.
Inherited from
onActivate?
optionalonActivate: (position,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:5084
Emitted when a row has been activated by the user.
Activation usually happens via the list.activate-item action of
the GtkListView.
This allows for a convenient way to handle activation in a listview. See ListItem.set_activatable for details on how to use this signal.
onDestroy?
optionalonDestroy: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:196
Signals that all holders of a reference to the widget should release the reference that they hold.
May result in finalization of the widget if all references are released.
This signal is not suitable for saving widget state.
Inherited from
onDirectionChanged?
optionalonDirectionChanged: (previousDirection,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:198
Emitted when the text direction of a widget changes.
Inherited from
GtkListBaseProps.onDirectionChanged
onHide?
optionalonHide: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:200
Emitted when widget is hidden.
Inherited from
onKeynavFailed?
optionalonKeynavFailed: (direction,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:206
Emitted if keyboard navigation fails.
See Widget.keynav_failed for details.
Inherited from
GtkListBaseProps.onKeynavFailed
onMap?
optionalonMap: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:218
Emitted when widget is going to be mapped.
A widget is mapped when the widget is visible (which is controlled with Widget.visible) and all its parents up to the toplevel widget are also visible.
The ::map signal can be used to determine whether a widget will be drawn,
for instance it can resume an animation that was stopped during the
emission of Widget.:unmap.
Inherited from
onMnemonicActivate?
optionalonMnemonicActivate: (groupCycling,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:225
Emitted when a widget is activated via a mnemonic.
The default handler for this signal activates widget if group_cycling
is false, or just makes widget grab focus if group_cycling is true.
Inherited from
GtkListBaseProps.onMnemonicActivate
onMoveFocus?
optionalonMoveFocus: (direction,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:234
Emitted when the focus is moved.
The ::move-focus signal is a keybinding signal.
The default bindings for this signal are Tab to move forward,
and Shift+Tab to move backward.
Inherited from
onNotify?
optionalonNotify: (pspec,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:312
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.
Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.
This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:
|[ g_signal_connect (text_view->buffer, "notify::paste-target-list", G_CALLBACK (gtk_text_view_target_list_notify), text_view) ]|
It is important to note that you must use [canonical parameter names]GObjectParamSpec#parameter-names as detail strings for the notify signal.
Inherited from
onQueryTooltip?
optionalonQueryTooltip: (x,y,keyboardMode,tooltip,self) =>boolean|null
Defined in: packages/react/src/generated/jsx.ts:250
Emitted when the widget’s tooltip is about to be shown.
This happens when the Widget.has-tooltip property
is true and the hover timeout has expired with the cursor hovering
above widget; or emitted when widget got focus in keyboard mode.
Using the given coordinates, the signal handler should determine
whether a tooltip should be shown for widget. If this is the case
true should be returned, false otherwise. Note that if keyboard_mode
is true, the values of x and y are undefined and should not be used.
The signal handler is free to manipulate tooltip with the therefore
destined function calls.
Inherited from
GtkListBaseProps.onQueryTooltip
onRealize?
optionalonRealize: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:259
Emitted when widget is associated with a GdkSurface.
This means that Widget.realize has been called or the widget has been mapped (that is, it is going to be drawn).
Inherited from
onSelectionChanged?
optionalonSelectionChanged: (ids) =>void|null
Defined in: packages/react/src/jsx.ts:680
Callback fired when the selection changes
onShow?
optionalonShow: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:261
Emitted when widget is shown.
Inherited from
onStateFlagsChanged?
optionalonStateFlagsChanged: (flags,self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:267
Emitted when the widget state changes.
See Widget.get_state_flags.
Inherited from
GtkListBaseProps.onStateFlagsChanged
onUnmap?
optionalonUnmap: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:277
Emitted when widget is going to be unmapped.
A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.
As ::unmap indicates that a widget will not be shown any longer,
it can be used to, for example, stop an animation on the widget.
Inherited from
onUnrealize?
optionalonUnrealize: (self) =>void|null
Defined in: packages/react/src/generated/jsx.ts:284
Emitted when the GdkSurface associated with widget is destroyed.
This means that Widget.unrealize has been called or the widget has been unmapped (that is, it is going to be hidden).
Inherited from
opacity?
optionalopacity:number
Defined in: packages/react/src/generated/jsx.ts:125
The requested opacity of the widget.
Inherited from
orientation?
optionalorientation:Orientation
Defined in: packages/react/src/generated/jsx.ts:4938
The orientation of the list. See GtkOrientable:orientation for details.
Inherited from
overflow?
optionaloverflow:Overflow
Defined in: packages/react/src/generated/jsx.ts:132
How content outside the widget's content area is treated.
This property is meant to be set by widget implementations, typically in their instance init function.
Inherited from
receivesDefault?
optionalreceivesDefault:boolean
Defined in: packages/react/src/generated/jsx.ts:134
Whether the widget will receive the default action when it is focused.
Inherited from
GtkListBaseProps.receivesDefault
ref?
optionalref:Ref<ListView>
Defined in: packages/react/src/generated/jsx.ts:5085
Overrides
renderHeader?
optionalrenderHeader: (item) =>ReactNode|null
Defined in: packages/react/src/jsx.ts:693
Function to render section headers when items contain section entries
renderItem()
renderItem: (
item,row?) =>ReactNode
Defined in: packages/react/src/jsx.ts:689
Function to render each list item. The row parameter provides tree state for hierarchical lists.
Parameters
| Parameter | Type |
|---|---|
item | unknown |
row? | TreeListRow | null |
Returns
ReactNode
selected?
optionalselected:string[] |null
Defined in: packages/react/src/jsx.ts:678
Array of selected item IDs
selectionMode?
optionalselectionMode:SelectionMode|null
Defined in: packages/react/src/jsx.ts:682
Selection behavior (single, multiple, none, etc.)
sensitive?
optionalsensitive:boolean
Defined in: packages/react/src/generated/jsx.ts:136
Whether the widget responds to input.
Inherited from
showSeparators?
optionalshowSeparators:boolean
Defined in: packages/react/src/generated/jsx.ts:5069
Show separators between rows.
singleClickActivate?
optionalsingleClickActivate:boolean
Defined in: packages/react/src/generated/jsx.ts:5071
Activate rows on single click and select them on hover.
tabBehavior?
optionaltabBehavior:ListTabBehavior
Defined in: packages/react/src/generated/jsx.ts:5073
Behavior of the Tab key
tooltipMarkup?
optionaltooltipMarkup:string|null
Defined in: packages/react/src/generated/jsx.ts:152
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Also see Tooltip.set_markup.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Widget.has-tooltip will automatically be set to true
and there will be taken care of Widget.:query-tooltip in
the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
GtkListBaseProps.tooltipMarkup
tooltipText?
optionaltooltipText:string|null
Defined in: packages/react/src/generated/jsx.ts:167
Sets the text of tooltip to be the given string.
Also see Tooltip.set_text.
This is a convenience property which will take care of getting the
tooltip shown if the given string is not NULL:
Widget.has-tooltip will automatically be set to true
and there will be taken care of Widget.:query-tooltip in
the default signal handler.
Note that if both Widget.tooltip-text and Widget.tooltip-markup are set, the last one wins.
Inherited from
vadjustment?
optionalvadjustment:Adjustment
Defined in: packages/react/src/generated/jsx.ts:4952
Vertical GtkAdjustment of the scrollable widget.
This adjustment is shared between the scrollable widget and its parent.
Inherited from
valign?
optionalvalign:Align
Defined in: packages/react/src/generated/jsx.ts:169
How to distribute vertical space if widget gets extra space.
Inherited from
vexpand?
optionalvexpand:boolean
Defined in: packages/react/src/generated/jsx.ts:171
Whether to expand vertically.
Inherited from
vexpandSet?
optionalvexpandSet:boolean
Defined in: packages/react/src/generated/jsx.ts:173
Whether to use the vexpand property.
Inherited from
visible?
optionalvisible:boolean
Defined in: packages/react/src/generated/jsx.ts:175
Whether the widget is visible.
Inherited from
vscrollPolicy?
optionalvscrollPolicy:ScrollablePolicy
Defined in: packages/react/src/generated/jsx.ts:4954
Determines when vertical scrolling should start.
Inherited from
GtkListBaseProps.vscrollPolicy
widthRequest?
optionalwidthRequest:number
Defined in: packages/react/src/generated/jsx.ts:181
Overrides for width request of the widget.
If this is -1, the natural request will be used.