QListWidget
Create and control a item-based list.
This class is a JS wrapper around Qt's QListWidget class
Example
const { QListWidget, QListWidgetItem } = require("@nodegui/nodegui");
const listWidget = new QListWidget();
for (let i = 0; i < 30; i++) {
let listWidgetItem = new QListWidgetItem();
listWidgetItem.setText('listWidgetItem ' + i);
if (i===3) {
listWidgetItem.setCheckState(2);
} else {
listWidgetItem.setCheckState(0);
}
listWidget.addItem(listWidgetItem);
}
Hierarchy
↳ QListView‹QListWidgetSignals›
↳ QListWidget
Index
Constructors
Properties
Methods
- _id
- acceptDrops
- accessibleDescription
- accessibleName
- activateWindow
- addAction
- addEventListener
- addItem
- addItems
- adjustSize
- alternatingRowColors
- autoFillBackground
- autoScrollMargin
- baseSize
- batchSize
- childAt
- children
- childrenRect
- clear
- clearFocus
- clearMask
- clearPropertyFlags
- clearSelection
- close
- closePersistentEditor
- colorCount
- contentsRect
- contextMenuPolicy
- count
- currentIndex
- currentItem
- currentRow
- defaultDropAction
- delete
- deleteLater
- depth
- devicePixelRatio
- devicePixelRatioF
- dragDropMode
- dragDropOverwriteMode
- dragEnabled
- dumpObjectInfo
- dumpObjectTree
- edit
- editItem
- editTriggers
- ensurePolished
- eventProcessed
- findItems
- flow
- focusProxy
- focusWidget
- font
- frameGeometry
- frameRect
- frameShadow
- frameShape
- frameSize
- frameStyle
- frameWidth
- geometry
- getFlexNode
- grab
- grabKeyboard
- grabMouse
- gridSize
- hasAutoScroll
- hasFocus
- hasHeightForWidth
- hasMouseTracking
- hasTabletTracking
- height
- heightForWidth
- heightMM
- hide
- horizontalScrollBar
- horizontalScrollMode
- iconSize
- indexAt
- indexWidget
- inherits
- inputMethodHints
- insertItem
- insertItems
- isActiveWindow
- isAncestorOf
- isEnabled
- isEnabledTo
- isFullScreen
- isHidden
- isMaximized
- isMinimized
- isModal
- isPersistentEditorOpen
- isRowHidden
- isSelectionRectVisible
- isSortingEnabled
- isVisible
- isVisibleTo
- isWindow
- isWindowModified
- isWrapping
- item
- itemAlignment
- itemAt
- itemWidget
- keyboardSearch
- killTimer
- layout
- layoutMode
- lineWidth
- logicalDpiX
- logicalDpiY
- lower
- mapFrom
- mapFromGlobal
- mapFromParent
- mapTo
- mapToGlobal
- mapToParent
- maximumHeight
- maximumSize
- maximumViewportSize
- maximumWidth
- midLineWidth
- minimumHeight
- minimumSize
- minimumSizeHint
- minimumWidth
- modelColumn
- move
- movement
- nativeParentWidget
- nextInFocusChain
- normalGeometry
- objectName
- openPersistentEditor
- paintingActive
- parent
- parentWidget
- physicalDpiX
- physicalDpiY
- pos
- previousInFocusChain
- property
- raise
- rect
- releaseKeyboard
- releaseMouse
- releaseShortcut
- removeAction
- removeEventListener
- removeItemWidget
- repaint
- repolish
- reset
- resetHorizontalScrollMode
- resetVerticalScrollMode
- resize
- resizeMode
- rootIndex
- row
- scrollTo
- scrollToBottom
- scrollToItem
- scrollToTop
- selectAll
- selectedItems
- selectionBehavior
- selectionMode
- selectionModel
- setAcceptDrops
- setAccessibleDescription
- setAccessibleName
- setAlternatingRowColors
- setAttribute
- setAutoFillBackground
- setAutoScroll
- setAutoScrollMargin
- setBaseSize
- setBatchSize
- setContentsMargins
- setContextMenuPolicy
- setCurrentIndex
- setCurrentItem
- setCurrentRow
- setCursor
- setDefaultDropAction
- setDisabled
- setDragDropMode
- setDragDropOverwriteMode
- setDragEnabled
- setDropIndicatorShown
- setEditTriggers
- setEnabled
- setEventProcessed
- setFixedHeight
- setFixedSize
- setFixedWidth
- setFlexNodeSizeControlled
- setFlow
- setFocus
- setFocusPolicy
- setFocusProxy
- setFont
- setFrameRect
- setFrameShadow
- setFrameShape
- setFrameStyle
- setGeometry
- setGraphicsEffect
- setGridSize
- setHidden
- setHorizontalScrollBar
- setHorizontalScrollBarPolicy
- setHorizontalScrollMode
- setIconSize
- setIndexWidget
- setInlineStyle
- setInputMethodHints
- setItemAlignment
- setItemDelegate
- setItemDelegateForColumn
- setItemDelegateForRow
- setItemWidget
- setLayout
- setLayoutMode
- setLineWidth
- setMaximumHeight
- setMaximumSize
- setMaximumWidth
- setMidLineWidth
- setMinimumHeight
- setMinimumSize
- setMinimumWidth
- setModel
- setModelColumn
- setMouseTracking
- setMovement
- setObjectName
- setParent
- setProperty
- setResizeMode
- setRootIndex
- setRowHidden
- setSelectionBehavior
- setSelectionMode
- setSelectionRectVisible
- setShortcutAutoRepeat
- setShortcutEnabled
- setSizeIncrement
- setSizePolicy
- setSortingEnabled
- setSpacing
- setStatusTip
- setStyleSheet
- setTabKeyNavigation
- setTabletTracking
- setTextElideMode
- setToolTip
- setToolTipDuration
- setUniformItemSizes
- setUpdatesEnabled
- setVerticalScrollBar
- setVerticalScrollBarPolicy
- setVerticalScrollMode
- setViewMode
- setViewport
- setVisible
- setWhatsThis
- setWindowFilePath
- setWindowFlag
- setWindowIcon
- setWindowModified
- setWindowOpacity
- setWindowRole
- setWindowState
- setWindowTitle
- setWordWrap
- setWrapping
- show
- showDropIndicator
- showFullScreen
- showMaximized
- showMinimized
- showNormal
- size
- sizeHint
- sizeHintForIndex
- sizeIncrement
- sortItems
- spacing
- stackUnder
- startTimer
- statusTip
- style
- styleSheet
- tabKeyNavigation
- takeItem
- testAttribute
- textElideMode
- toolTip
- toolTipDuration
- underMouse
- uniformItemSizes
- unsetCursor
- unsetLayoutDirection
- unsetLocale
- update
- updateGeometry
- updateMicroFocus
- updatesEnabled
- verticalScrollBar
- verticalScrollMode
- viewMode
- viewport
- visualItemRect
- visualRect
- whatsThis
- width
- widthMM
- winId
- window
- windowFilePath
- windowHandle
- windowIcon
- windowOpacity
- windowRole
- windowState
- windowTitle
- wordWrap
- x
- y
Constructors
constructor
+ new QListWidget(arg?
: QWidget‹QWidgetSignals› | NativeElement): QListWidget
Overrides QListView.constructor
Parameters:
Name | Type |
---|---|
arg? | QWidget‹QWidgetSignals› | NativeElement |
Returns: QListWidget
Properties
_rawInlineStyle
• _rawInlineStyle: string
Inherited from QMenu._rawInlineStyle
items
• items: Set‹Component›
native
• native: NativeElement | null
Inherited from Component.native
type
• type: string
Methods
_id
▸ _id(): number
Get an ID identifying the underlying C++ object.
This can be useful when debugging memory problems with help from
setLogCreateQObject()
and setLogDestroyQObject()
. The number is
hash of the memory address of the C++ object.
Returns: number
a unique number which is valid for the lifetime of the C++ object.
acceptDrops
▸ acceptDrops(): boolean
Inherited from QMenu.acceptDrops
Returns: boolean
accessibleDescription
▸ accessibleDescription(): string
Inherited from QMenu.accessibleDescription
Returns: string
accessibleName
▸ accessibleName(): string
Inherited from QMenu.accessibleName
Returns: string
activateWindow
▸ activateWindow(): void
Inherited from QMenu.activateWindow
Returns: void
addAction
▸ addAction(action
: QAction | string): QAction
Inherited from QMenu.addAction
Parameters:
Name | Type |
---|---|
action | QAction | string |
Returns: QAction
addEventListener
▸ addEventListener‹SignalType›(signalType
: SignalType, callback
: QListWidgetSignals[SignalType], options?
: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Type parameters:
▪ SignalType: keyof QListWidgetSignals
Parameters:
Name | Type | Description |
---|---|---|
signalType | SignalType | SignalType is a signal from the widgets signals interface. |
callback | QListWidgetSignals[SignalType] | Corresponding callback for the signal as mentioned in the widget's signal interface |
options? | EventListenerOptions | Extra optional options controlling how this event listener is added. |
Returns: void
void
For example in the case of QPushButton:
const button = new QPushButton();
button.addEventListener('clicked',(checked)=>console.log("clicked"));
// here clicked is a value from QPushButtonSignals interface
▸ addEventListener(eventType
: WidgetEventTypes, callback
: function, options?
: EventListenerOptions): void
Inherited from EventWidget.addEventListener
Parameters:
▪ eventType: WidgetEventTypes
▪ callback: function
▸ (event?
: NativeRawPointer‹"QEvent"›): void
Parameters:
Name | Type |
---|---|
event? | NativeRawPointer‹"QEvent"› |
▪Optional
options: EventListenerOptions
Extra optional options controlling how this event listener is added.
For example in the case of QPushButton:
const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));
Returns: void
addItem
▸ addItem(item
: QListWidgetItem): void
Parameters:
Name | Type |
---|---|
item | QListWidgetItem |
Returns: void
addItems
▸ addItems(labels
: string[]): void
Parameters:
Name | Type |
---|---|
labels | string[] |
Returns: void
adjustSize
▸ adjustSize(): void
Inherited from QMenu.adjustSize
Returns: void
alternatingRowColors
▸ alternatingRowColors(): boolean
Inherited from QAbstractItemView.alternatingRowColors
Returns: boolean
autoFillBackground
▸ autoFillBackground(): boolean
Inherited from QMenu.autoFillBackground
Returns: boolean
autoScrollMargin
▸ autoScrollMargin(): number
Inherited from QAbstractItemView.autoScrollMargin
Returns: number
baseSize
▸ baseSize(): QSize
Returns: QSize
batchSize
▸ batchSize(): number
Inherited from QListView.batchSize
Returns: number
childAt
▸ childAt(x
: number, y
: number): QWidget
Parameters:
Name | Type |
---|---|
x | number |
y | number |
Returns: QWidget
children
▸ children(): QObject[]
Inherited from QObject.children
Returns: QObject[]
childrenRect
▸ childrenRect(): QRect
Inherited from QMenu.childrenRect
Returns: QRect
clear
▸ clear(): void
Returns: void
clearFocus
▸ clearFocus(): void
Inherited from QMenu.clearFocus
Returns: void
clearMask
▸ clearMask(): void
Inherited from QMenu.clearMask
Returns: void
clearPropertyFlags
▸ clearPropertyFlags(): void
Inherited from QListView.clearPropertyFlags
Returns: void
clearSelection
▸ clearSelection(): void
Inherited from QAbstractItemView.clearSelection
Returns: void
close
▸ close(): boolean
Returns: boolean
closePersistentEditor
▸ closePersistentEditor(itemOrIndex
: QListWidgetItem | QModelIndex): void
Overrides QAbstractItemView.closePersistentEditor
Parameters:
Name | Type |
---|---|
itemOrIndex | QListWidgetItem | QModelIndex |
Returns: void
colorCount
▸ colorCount(): number
Inherited from QMenu.colorCount
Returns: number
contentsRect
▸ contentsRect(): QRect
Inherited from QMenu.contentsRect
Returns: QRect
contextMenuPolicy
▸ contextMenuPolicy(): ContextMenuPolicy
Inherited from QMenu.contextMenuPolicy
Returns: ContextMenuPolicy
count
▸ count(): number
Returns: number
currentIndex
▸ currentIndex(): QModelIndex
Inherited from QAbstractItemView.currentIndex
Returns: QModelIndex
currentItem
▸ currentItem(): QListWidgetItem
Returns: QListWidgetItem
currentRow
▸ currentRow(): number
Returns: number
defaultDropAction
▸ defaultDropAction(): DropAction
Inherited from QAbstractItemView.defaultDropAction
Returns: DropAction
delete
▸ delete(): void
Returns: void
deleteLater
▸ deleteLater(): void
Inherited from QObject.deleteLater
Returns: void
depth
▸ depth(): number
Returns: number
devicePixelRatio
▸ devicePixelRatio(): number
Inherited from QMenu.devicePixelRatio
Returns: number
devicePixelRatioF
▸ devicePixelRatioF(): number
Inherited from QMenu.devicePixelRatioF
Returns: number
dragDropMode
▸ dragDropMode(): DragDropMode
Inherited from QAbstractItemView.dragDropMode
Returns: DragDropMode
dragDropOverwriteMode
▸ dragDropOverwriteMode(): boolean
Inherited from QAbstractItemView.dragDropOverwriteMode
Returns: boolean
dragEnabled
▸ dragEnabled(): boolean
Inherited from QAbstractItemView.dragEnabled
Returns: boolean
dumpObjectInfo
▸ dumpObjectInfo(): void
Inherited from QObject.dumpObjectInfo
Returns: void
dumpObjectTree
▸ dumpObjectTree(): void
Inherited from QObject.dumpObjectTree
Returns: void
edit
▸ edit(index
: QModelIndex): void
Inherited from QAbstractItemView.edit
Parameters:
Name | Type |
---|---|
index | QModelIndex |
Returns: void
editItem
▸ editItem(item
: Component): void
Parameters:
Name | Type |
---|---|
item | Component |
Returns: void
editTriggers
▸ editTriggers(): number
Inherited from QAbstractItemView.editTriggers
Returns: number
ensurePolished
▸ ensurePolished(): void
Inherited from QMenu.ensurePolished
Returns: void
eventProcessed
▸ eventProcessed(): boolean
Inherited from EventWidget.eventProcessed
Get the state of the event processed flag
See setEventProcessed()
.
Returns: boolean
boolean True if the current event is flagged as processed.
findItems
▸ findItems(text
: string, flags
: MatchFlag): QListWidgetItem[]
Parameters:
Name | Type |
---|---|
text | string |
flags | MatchFlag |
Returns: QListWidgetItem[]
flow
▸ flow(): Flow
Returns: Flow
focusProxy
▸ focusProxy(): QWidget
Inherited from QMenu.focusProxy
Returns: QWidget
focusWidget
▸ focusWidget(): QWidget
Inherited from QMenu.focusWidget
Returns: QWidget
font
▸ font(): QFont
Returns: QFont
frameGeometry
▸ frameGeometry(): QRect
Inherited from QMenu.frameGeometry
Returns: QRect
frameRect
▸ frameRect(): QRect
Inherited from QFrame.frameRect
Returns: QRect
frameShadow
▸ frameShadow(): Shadow
Inherited from QFrame.frameShadow
Returns: Shadow
frameShape
▸ frameShape(): Shape
Inherited from QFrame.frameShape
Returns: Shape
frameSize
▸ frameSize(): QSize
Inherited from QMenu.frameSize
Returns: QSize
frameStyle
▸ frameStyle(): number
Inherited from QFrame.frameStyle
Returns: number
frameWidth
▸ frameWidth(): number
Inherited from QFrame.frameWidth
Returns: number
geometry
▸ geometry(): QRect
Returns: QRect
getFlexNode
▸ getFlexNode(): FlexNode
Inherited from YogaWidget.getFlexNode
Returns: FlexNode
grab
Parameters:
Name | Type |
---|---|
rect? | QRect |
Returns: QPixmap
grabKeyboard
▸ grabKeyboard(): void
Inherited from QMenu.grabKeyboard
Returns: void
grabMouse
▸ grabMouse(): void
Inherited from QMenu.grabMouse
Returns: void
gridSize
▸ gridSize(): QSize
Inherited from QListView.gridSize
Returns: QSize
hasAutoScroll
▸ hasAutoScroll(): boolean
Inherited from QAbstractItemView.hasAutoScroll
Returns: boolean
hasFocus
▸ hasFocus(): boolean
Returns: boolean
hasHeightForWidth
▸ hasHeightForWidth(): boolean
Inherited from QMenu.hasHeightForWidth
Returns: boolean
hasMouseTracking
▸ hasMouseTracking(): boolean
Inherited from QMenu.hasMouseTracking
Returns: boolean
hasTabletTracking
▸ hasTabletTracking(): boolean
Inherited from QMenu.hasTabletTracking
Returns: boolean
height
▸ height(): number
Returns: number
heightForWidth
▸ heightForWidth(w
: number): number
Inherited from QMenu.heightForWidth
Parameters:
Name | Type |
---|---|
w | number |
Returns: number
heightMM
▸ heightMM(): number
Returns: number
hide
▸ hide(): void
Returns: void
horizontalScrollBar
▸ horizontalScrollBar(): QScrollBar
Inherited from QAbstractScrollArea.horizontalScrollBar
Returns: QScrollBar
horizontalScrollMode
▸ horizontalScrollMode(): ScrollMode
Inherited from QAbstractItemView.horizontalScrollMode
Returns: ScrollMode
iconSize
▸ iconSize(): QSize
Inherited from QAbstractItemView.iconSize
Returns: QSize
indexAt
▸ indexAt(point
: QPoint): QModelIndex
Inherited from QAbstractItemView.indexAt
Parameters:
Name | Type |
---|---|
point | QPoint |
Returns: QModelIndex
indexWidget
▸ indexWidget(index
: QModelIndex): QWidget
Inherited from QAbstractItemView.indexWidget
Parameters:
Name | Type |
---|---|
index | QModelIndex |
Returns: QWidget
inherits
▸ inherits(className
: string): boolean
Inherited from QObject.inherits
Parameters:
Name | Type |
---|---|
className | string |
Returns: boolean
inputMethodHints
▸ inputMethodHints(): number
Inherited from QMenu.inputMethodHints
Returns: number
insertItem
▸ insertItem(row
: number, item
: QListWidgetItem): void
Parameters:
Name | Type |
---|---|
row | number |
item | QListWidgetItem |
Returns: void
insertItems
▸ insertItems(row
: number, labels
: string[]): void
Parameters:
Name | Type |
---|---|
row | number |
labels | string[] |
Returns: void
isActiveWindow
▸ isActiveWindow(): boolean
Inherited from QMenu.isActiveWindow
Returns: boolean
isAncestorOf
▸ isAncestorOf(child
: QWidget): boolean
Inherited from QMenu.isAncestorOf
Parameters:
Name | Type |
---|---|
child | QWidget |
Returns: boolean
isEnabled
▸ isEnabled(): boolean
Inherited from QMenu.isEnabled
Returns: boolean
isEnabledTo
▸ isEnabledTo(ancestor
: QWidget): boolean
Inherited from QMenu.isEnabledTo
Parameters:
Name | Type |
---|---|
ancestor | QWidget |
Returns: boolean
isFullScreen
▸ isFullScreen(): boolean
Inherited from QMenu.isFullScreen
Returns: boolean
isHidden
▸ isHidden(): boolean
Returns: boolean
isMaximized
▸ isMaximized(): boolean
Inherited from QMenu.isMaximized
Returns: boolean
isMinimized
▸ isMinimized(): boolean
Inherited from QMenu.isMinimized
Returns: boolean
isModal
▸ isModal(): boolean
Returns: boolean
isPersistentEditorOpen
▸ isPersistentEditorOpen(itemOrIndex
: QListWidgetItem | QModelIndex): boolean
Overrides QAbstractItemView.isPersistentEditorOpen
Parameters:
Name | Type |
---|---|
itemOrIndex | QListWidgetItem | QModelIndex |
Returns: boolean
isRowHidden
▸ isRowHidden(row
: number): boolean
Inherited from QListView.isRowHidden
Parameters:
Name | Type |
---|---|
row | number |
Returns: boolean
isSelectionRectVisible
▸ isSelectionRectVisible(): boolean
Inherited from QListView.isSelectionRectVisible
Returns: boolean
isSortingEnabled
▸ isSortingEnabled(): boolean
Returns: boolean
isVisible
▸ isVisible(): boolean
Inherited from QMenu.isVisible
Returns: boolean
isVisibleTo
▸ isVisibleTo(ancestor
: QWidget): boolean
Inherited from QMenu.isVisibleTo
Parameters:
Name | Type |
---|---|
ancestor | QWidget |
Returns: boolean
isWindow
▸ isWindow(): boolean
Returns: boolean
isWindowModified
▸ isWindowModified(): boolean
Inherited from QMenu.isWindowModified
Returns: boolean
isWrapping
▸ isWrapping(): boolean
Inherited from QListView.isWrapping
Returns: boolean
item
▸ item(row
: number): QListWidgetItem
Parameters:
Name | Type |
---|---|
row | number |
Returns: QListWidgetItem
itemAlignment
▸ itemAlignment(): AlignmentFlag
Inherited from QListView.itemAlignment
Returns: AlignmentFlag
itemAt
▸ itemAt(x
: number, y
: number): QListWidgetItem
Parameters:
Name | Type |
---|---|
x | number |
y | number |
Returns: QListWidgetItem
itemWidget
▸ itemWidget(item
: QListWidgetItem): QWidget
Parameters:
Name | Type |
---|---|
item | QListWidgetItem |
Returns: QWidget