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

QAbstractItemViewQListWidgetSignals

QListWidget

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QListWidget(): QListWidget

Overrides EventWidget.constructor

Returns: QListWidget

+ new QListWidget(parent: NodeWidget‹any›): QListWidget

Overrides EventWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QListWidget

Properties

_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from NodeWidget._rawInlineStyle


items

items: Set‹NativeElement | Component


Optional layout

layout? : NodeLayoutQListWidgetSignals

Inherited from NodeWidget.layout


native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: Set‹Component

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent


type

type: string = "widget"

Inherited from NodeWidget.type


Optional viewportWidget

viewportWidget? : NodeWidget‹any›

Inherited from QAbstractScrollArea.viewportWidget

Methods

activateWindow

activateWindow(): void

Inherited from NodeWidget.activateWindow

Returns: void


addEventListener

addEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QListWidgetSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackSignals[SignalType]Corresponding callback for the signal as mentioned in the widget's signal interface

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): void

Inherited from EventWidget.addEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


addItem

addItem(item: QListWidgetItem): void

Parameters:

NameType
itemQListWidgetItem

Returns: void


addItems

addItems(labels: string[]): void

Parameters:

NameType
labelsstring[]

Returns: void


adjustSize

adjustSize(): void

Inherited from NodeWidget.adjustSize

Returns: void


alternatingRowColors

alternatingRowColors(): boolean

Inherited from QAbstractItemView.alternatingRowColors

Returns: boolean


autoScrollMargin

autoScrollMargin(): number

Inherited from QAbstractItemView.autoScrollMargin

Returns: number


batchSize

batchSize(): number

Returns: number


clear

clear(): void

Returns: void


clearPropertyFlags

clearPropertyFlags(): void

Returns: void


close

close(): boolean

Inherited from NodeWidget.close

Returns: boolean


closePersistentEditor

closePersistentEditor(item: QListWidgetItem): void

Parameters:

NameType
itemQListWidgetItem

Returns: void


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


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


editItem

editItem(item: Component): void

Parameters:

NameType
itemComponent

Returns: void


editTriggers

editTriggers(): number

Inherited from QAbstractItemView.editTriggers

Returns: number


flow

flow(): Flow

Returns: Flow


font

font(): QFont

Inherited from NodeWidget.font

Returns: QFont


geometry

geometry(): QRect

Inherited from NodeWidget.geometry

Returns: QRect


getFlexNode

getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode


gridSize

gridSize(): QSize

Returns: QSize


hasAutoScroll

hasAutoScroll(): boolean

Inherited from QAbstractItemView.hasAutoScroll

Returns: boolean


hasMouseTracking

hasMouseTracking(): boolean

Inherited from NodeWidget.hasMouseTracking

Returns: boolean


hide

hide(): void

Inherited from NodeWidget.hide

Returns: void


horizontalScrollMode

horizontalScrollMode(): ScrollMode

Inherited from QAbstractItemView.horizontalScrollMode

Returns: ScrollMode


iconSize

iconSize(): QSize

Inherited from QAbstractItemView.iconSize

Returns: QSize


indexWidget

indexWidget(index: QModelIndex): QWidget

Inherited from QAbstractItemView.indexWidget

Parameters:

NameType
indexQModelIndex

Returns: QWidget


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


insertItem

insertItem(row: number, item: QListWidgetItem): void

Parameters:

NameType
rownumber
itemQListWidgetItem

Returns: void


insertItems

insertItems(row: number, labels: string[]): void

Parameters:

NameType
rownumber
labelsstring[]

Returns: void


isEnabled

isEnabled(): boolean

Inherited from NodeWidget.isEnabled

Returns: boolean


isPersistentEditorOpen

isPersistentEditorOpen(item: QListWidgetItem): boolean

Parameters:

NameType
itemQListWidgetItem

Returns: boolean


isRowHidden

isRowHidden(row: number): boolean

Parameters:

NameType
rownumber

Returns: boolean


isSelectionRectVisible

isSelectionRectVisible(): boolean

Returns: boolean


isSortingEnabled

isSortingEnabled(): boolean

Returns: boolean


isVisible

isVisible(): boolean

Inherited from NodeWidget.isVisible

Returns: boolean


isWrapping

isWrapping(): boolean

Returns: boolean


item

item(row: number): QListWidgetItem

Parameters:

NameType
rownumber

Returns: QListWidgetItem


itemAlignment

itemAlignment(): AlignmentFlag

Returns: AlignmentFlag


itemAt

itemAt(x: number, y: number): QListWidgetItem

Parameters:

NameType
xnumber
ynumber

Returns: QListWidgetItem


itemWidget

itemWidget(item: QListWidgetItem): QWidget

Parameters:

NameType
itemQListWidgetItem

Returns: QWidget


layoutMode

layoutMode(): LayoutMode

Returns: LayoutMode


lower

lower(): void

Inherited from NodeWidget.lower

Returns: void


modelColumn

modelColumn(): number

Returns: number


move

move(x: number, y: number): void

Inherited from NodeWidget.move

Parameters:

NameType
xnumber
ynumber

Returns: void


movement

movement(): Movement

Returns: Movement


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


openPersistentEditor

openPersistentEditor(item: QListWidgetItem): void

Parameters:

NameType
itemQListWidgetItem

Returns: void


pos

pos(): object

Inherited from NodeWidget.pos

Returns: object


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


raise

raise(): void

Inherited from NodeWidget.raise

Returns: void


removeEventListener

removeEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QListWidgetSignals

Parameters:

NameType
signalTypeSignalType
callbackSignals[SignalType]

Returns: void

removeEventListener(eventType: WidgetEventTypes, callback: function): void

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

NameType
event?NativeRawPointer‹"QEvent"›

Returns: void


removeItemWidget

removeItemWidget(item: QListWidgetItem): void

Parameters:

NameType
itemQListWidgetItem

Returns: void


repaint

repaint(): void

Inherited from NodeWidget.repaint

Returns: void


resetHorizontalScrollMode

resetHorizontalScrollMode(): void

Inherited from QAbstractItemView.resetHorizontalScrollMode

Returns: void


resetVerticalScrollMode

resetVerticalScrollMode(): void

Inherited from QAbstractItemView.resetVerticalScrollMode

Returns: void


resize

resize(width: number, height: number): void

Inherited from NodeWidget.resize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


resizeMode

resizeMode(): ResizeMode

Returns: ResizeMode


row

row(item: QListWidgetItem): number

Parameters:

NameType
itemQListWidgetItem

Returns: number


scrollToBottom

scrollToBottom(): void

Inherited from QAbstractItemView.scrollToBottom

Returns: void


scrollToItem

scrollToItem(item: QListWidgetItem, hint: ScrollHint): void

Parameters:

NameType
itemQListWidgetItem
hintScrollHint

Returns: void


scrollToTop

scrollToTop(): void

Inherited from QAbstractItemView.scrollToTop

Returns: void


selectionBehavior

selectionBehavior(): SelectionBehavior

Inherited from QAbstractItemView.selectionBehavior

Returns: SelectionBehavior


selectionMode

selectionMode(): SelectionMode

Inherited from QAbstractItemView.selectionMode

Returns: SelectionMode


setAlternatingRowColors

setAlternatingRowColors(enable: boolean): void

Inherited from QAbstractItemView.setAlternatingRowColors

Parameters:

NameType
enableboolean

Returns: void


setAttribute

setAttribute(attribute: WidgetAttribute, switchOn: boolean): void

Inherited from NodeWidget.setAttribute

Parameters:

NameType
attributeWidgetAttribute
switchOnboolean

Returns: void


setAutoScroll

setAutoScroll(enable: boolean): void

Inherited from QAbstractItemView.setAutoScroll

Parameters:

NameType
enableboolean

Returns: void


setAutoScrollMargin

setAutoScrollMargin(margin: number): void

Inherited from QAbstractItemView.setAutoScrollMargin

Parameters:

NameType
marginnumber

Returns: void


setBatchSize

setBatchSize(batchSize: number): void

Parameters:

NameType
batchSizenumber

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from NodeWidget.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCurrentIndex

setCurrentIndex(index: QModelIndex): void

Inherited from QAbstractItemView.setCurrentIndex

Parameters:

NameType
indexQModelIndex

Returns: void


setCurrentItem

setCurrentItem(item: QListWidgetItem): void

Parameters:

NameType
itemQListWidgetItem

Returns: void


setCurrentRow

setCurrentRow(row: number): void

Parameters:

NameType
rownumber

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from NodeWidget.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setDefaultDropAction

setDefaultDropAction(dropAction: DropAction): void

Inherited from QAbstractItemView.setDefaultDropAction

Parameters:

NameType
dropActionDropAction

Returns: void


setDragDropMode

setDragDropMode(behavior: DragDropMode): void

Inherited from QAbstractItemView.setDragDropMode

Parameters:

NameType
behaviorDragDropMode

Returns: void


setDragDropOverwriteMode

setDragDropOverwriteMode(overwrite: boolean): void

Inherited from QAbstractItemView.setDragDropOverwriteMode

Parameters:

NameType
overwriteboolean

Returns: void


setDragEnabled

setDragEnabled(enable: boolean): void

Inherited from QAbstractItemView.setDragEnabled

Parameters:

NameType
enableboolean

Returns: void


setDropIndicatorShown

setDropIndicatorShown(enable: boolean): void

Inherited from QAbstractItemView.setDropIndicatorShown

Parameters:

NameType
enableboolean

Returns: void


setEditTriggers

setEditTriggers(triggers: number): void

Inherited from QAbstractItemView.setEditTriggers

Parameters:

NameType
triggersnumber

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from NodeWidget.setEnabled

Parameters:

NameType
enabledboolean

Returns: void


setFixedSize

setFixedSize(width: number, height: number): void

Inherited from NodeWidget.setFixedSize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


setFlexNodeSizeControlled

setFlexNodeSizeControlled(isSizeControlled: boolean): void

Inherited from YogaWidget.setFlexNodeSizeControlled

sets whether the widget's size is controlled by someone else (for example a window's size is controlled by its frame when dragged).

Parameters:

NameTypeDescription
isSizeControlledboolean

Returns: void


setFlow

setFlow(flow: Flow): void

Parameters:

NameType
flowFlow

Returns: void


setFont

setFont(font: QFont): void

Inherited from NodeWidget.setFont

Parameters:

NameType
fontQFont

Returns: void


setGeometry

setGeometry(x: number, y: number, w: number, h: number): void

Inherited from NodeWidget.setGeometry

Parameters:

NameType
xnumber
ynumber
wnumber
hnumber

Returns: void


setGridSize

setGridSize(size: QSize): void

Parameters:

NameType
sizeQSize

Returns: void


setHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

NameType
policyScrollBarPolicy

Returns: void


setHorizontalScrollMode

setHorizontalScrollMode(mode: boolean): void

Inherited from QAbstractItemView.setHorizontalScrollMode

Parameters:

NameType
modeboolean

Returns: void


setIconSize

setIconSize(iconSize: QSize): void

Inherited from QAbstractItemView.setIconSize

Parameters:

NameType
iconSizeQSize

Returns: void


setIndexWidget

setIndexWidget(index: QModelIndex, widget: QWidget): void

Inherited from QAbstractItemView.setIndexWidget

Parameters:

NameType
indexQModelIndex
widgetQWidget

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from NodeWidget.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setItemAlignment

setItemAlignment(alignment: AlignmentFlag): void

Parameters:

NameType
alignmentAlignmentFlag

Returns: void


setItemWidget

setItemWidget(item: QListWidgetItem, widget: QWidget): void

Parameters:

NameType
itemQListWidgetItem
widgetQWidget

Returns: void


setLayout

setLayout(parentLayout: NodeLayoutQListWidgetSignals›): void

Inherited from NodeWidget.setLayout

Parameters:

NameType
parentLayoutNodeLayoutQListWidgetSignals

Returns: void


setLayoutMode

setLayoutMode(mode: LayoutMode): void

Parameters:

NameType
modeLayoutMode

Returns: void


setMaximumSize

setMaximumSize(maxw: number, maxh: number): void

Inherited from NodeWidget.setMaximumSize

Parameters:

NameType
maxwnumber
maxhnumber

Returns: void


setMinimumSize

setMinimumSize(minw: number, minh: number): void

Inherited from NodeWidget.setMinimumSize

Parameters:

NameType
minwnumber
minhnumber

Returns: void


setModelColumn

setModelColumn(column: number): void

Parameters:

NameType
columnnumber

Returns: void


setMouseTracking

setMouseTracking(isMouseTracked: boolean): void

Inherited from NodeWidget.setMouseTracking

Parameters:

NameType
isMouseTrackedboolean

Returns: void


setMovement

setMovement(movement: Movement): void

Parameters:

NameType
movementMovement

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from NodeWidget.setObjectName

Overrides NodeObject.setObjectName

Parameters:

NameType
objectNamestring

Returns: void


setProperty

setProperty(name: string, value: QVariantType): boolean

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setResizeMode

setResizeMode(mode: ResizeMode): void

Parameters:

NameType
modeResizeMode

Returns: void


setRowHidden

setRowHidden(row: number, hide: boolean): void

Parameters:

NameType
rownumber
hideboolean

Returns: void


setSelectionBehavior

setSelectionBehavior(behavior: SelectionBehavior): void

Inherited from QAbstractItemView.setSelectionBehavior

Parameters:

NameType
behaviorSelectionBehavior

Returns: void


setSelectionMode

setSelectionMode(mode: SelectionMode): void

Inherited from QAbstractItemView.setSelectionMode

Parameters:

NameType
modeSelectionMode

Returns: void


setSelectionRectVisible

setSelectionRectVisible(show: boolean): void

Parameters:

NameType
showboolean

Returns: void


setSortingEnabled

setSortingEnabled(enable: boolean): void

Parameters:

NameType
enableboolean

Returns: void


setSpacing

setSpacing(space: number): void

Parameters:

NameType
spacenumber

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from NodeWidget.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setTabKeyNavigation

setTabKeyNavigation(enable: boolean): void

Inherited from QAbstractItemView.setTabKeyNavigation

Parameters:

NameType
enableboolean

Returns: void


setTextElideMode

setTextElideMode(mode: TextElideMode): void

Inherited from QAbstractItemView.setTextElideMode

Parameters:

NameType
modeTextElideMode

Returns: void


setUniformItemSizes

setUniformItemSizes(enable: boolean): void

Parameters:

NameType
enableboolean

Returns: void


setVerticalScrollBarPolicy

setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

NameType
policyScrollBarPolicy

Returns: void


setVerticalScrollMode

setVerticalScrollMode(mode: ScrollMode): void

Inherited from QAbstractItemView.setVerticalScrollMode

Parameters:

NameType
modeScrollMode

Returns: void


setViewMode

setViewMode(mode: ViewMode): void

Parameters:

NameType
modeViewMode

Returns: void


setViewport

setViewport(widget: NodeWidget‹any›): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

NameType
widgetNodeWidget‹any›

Returns: void


setWindowFlag

setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from NodeWidget.setWindowFlag

Parameters:

NameType
windowTypeWindowType
switchOnboolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from NodeWidget.setWindowIcon

Parameters:

NameType
iconQIcon

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from NodeWidget.setWindowOpacity

Parameters:

NameType
opacitynumber

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from NodeWidget.setWindowState

Parameters:

NameType
stateWindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from NodeWidget.setWindowTitle

Parameters:

NameType
titlestring

Returns: void


setWordWrap

setWordWrap(on: boolean): void

Parameters:

NameType
onboolean

Returns: void


setWrapping

setWrapping(enable: boolean): void

Parameters:

NameType
enableboolean

Returns: void


show

show(): void

Inherited from NodeWidget.show

Returns: void


showDropIndicator

showDropIndicator(): boolean

Inherited from QAbstractItemView.showDropIndicator

Returns: boolean


showFullScreen

showFullScreen(): void

Inherited from NodeWidget.showFullScreen

Returns: void


showMaximized

showMaximized(): void

Inherited from NodeWidget.showMaximized

Returns: void


showMinimized

showMinimized(): void

Inherited from NodeWidget.showMinimized

Returns: void


showNormal

showNormal(): void

Inherited from NodeWidget.showNormal

Returns: void


size

size(): QSize

Inherited from NodeWidget.size

Returns: QSize


sortItems

sortItems(order: SortOrder): void

Parameters:

NameType
orderSortOrder

Returns: void


spacing

spacing(): number

Returns: number


styleSheet

styleSheet(): string

Inherited from NodeWidget.styleSheet

Returns: string


tabKeyNavigation

tabKeyNavigation(): boolean

Inherited from QAbstractItemView.tabKeyNavigation

Returns: boolean


takeItem

takeItem(row: number): void

Parameters:

NameType
rownumber

Returns: void


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from NodeWidget.testAttribute

Parameters:

NameType
attributeWidgetAttribute

Returns: boolean


textElideMode

textElideMode(): TextElideMode

Inherited from QAbstractItemView.textElideMode

Returns: TextElideMode


uniformItemSizes

uniformItemSizes(): boolean

Returns: boolean


update

update(): void

Inherited from NodeWidget.update

Returns: void


updateGeometry

updateGeometry(): void

Inherited from NodeWidget.updateGeometry

Returns: void


verticalScrollMode

verticalScrollMode(): ScrollMode

Inherited from QAbstractItemView.verticalScrollMode

Returns: ScrollMode


viewMode

viewMode(): ViewMode

Returns: ViewMode


viewport

viewport(): QWidget

Inherited from QAbstractScrollArea.viewport

Returns: QWidget


visualItemRect

visualItemRect(item: QListWidgetItem): QRect

Parameters:

NameType
itemQListWidgetItem

Returns: QRect


windowOpacity

windowOpacity(): number

Inherited from NodeWidget.windowOpacity

Returns: number


windowState

windowState(): number

Inherited from NodeWidget.windowState

Returns: number


windowTitle

windowTitle(): string

Inherited from NodeWidget.windowTitle

Returns: string


wordWrap

wordWrap(): boolean

Returns: boolean