nodeguy/website/docs/api/generated/classes/qtablewidget.md
Atul R 392aa3cd4c
Adds automatic docs for now (#308)
* adds basic typedoc

* backup

* Adds all docs to source code

* Adds autogenerated docs

* Fixes doc links

* Updates docs
2019-12-29 00:42:06 +05:30

29 KiB
Raw Blame History

id title sidebar_label
qtablewidget QTableWidget QTableWidget

Hierarchy

QAbstractScrollAreaQTableWidgetSignals

QTableWidget

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QTableWidget(rows: number, columns: number): QTableWidget

Overrides EventWidget.constructor

Parameters:

Name Type
rows number
columns number

Returns: QTableWidget

+ new QTableWidget(rows: number, columns: number, parent: NodeWidgetany): QTableWidget

Overrides EventWidget.constructor

Parameters:

Name Type
rows number
columns number
parent NodeWidgetany

Returns: QTableWidget

Properties

_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from NodeWidget._rawInlineStyle


items

items: SetNativeElement | Component


Optional layout

layout? : NodeLayoutQTableWidgetSignals

Inherited from NodeWidget.layout


native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: Setunknown = new Set()

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent


type

type: string = "widget"

Inherited from NodeWidget.type


Optional viewportWidget

viewportWidget? : NodeWidgetany

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 QTableWidgetSignals

Parameters:

Name Type Description
signalType SignalType SignalType is a signal from the widgets signals interface.
callback Signals[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?: NativeElement): void

Parameters:

Name Type
event? NativeElement

Returns: void


adjustSize

adjustSize(): void

Inherited from NodeWidget.adjustSize

Returns: void


clear

clear(): void

Returns: void


clearContents

clearContents(): void

Returns: void


close

close(): boolean

Inherited from NodeWidget.close

Returns: boolean


closePersistentEditor

closePersistentEditor(item: QTableWidgetItem): void

Parameters:

Name Type
item QTableWidgetItem

Returns: void


editItem

editItem(item: Component): void

Parameters:

Name Type
item Component

Returns: void


geometry

geometry(): QRect

Inherited from NodeWidget.geometry

Returns: QRect


getFlexNode

getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode


hasMouseTracking

hasMouseTracking(): boolean

Inherited from NodeWidget.hasMouseTracking

Returns: boolean


hide

hide(): void

Inherited from NodeWidget.hide

Returns: void


hideColumn

hideColumn(column: number): void

Parameters:

Name Type
column number

Returns: void


hideRow

hideRow(row: number): void

Parameters:

Name Type
row number

Returns: void


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name Type
className string

Returns: boolean


insertColumn

insertColumn(column: number): void

Parameters:

Name Type
column number

Returns: void


insertRow

insertRow(row: number): void

Parameters:

Name Type
row number

Returns: void


isEnabled

isEnabled(): boolean

Inherited from NodeWidget.isEnabled

Returns: boolean


isSortingEnabled

isSortingEnabled(): boolean

Returns: boolean


isVisible

isVisible(): boolean

Inherited from NodeWidget.isVisible

Returns: boolean


lower

lower(): void

Inherited from NodeWidget.lower

Returns: void


move

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

Inherited from NodeWidget.move

Parameters:

Name Type
x number
y number

Returns: void


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


pos

pos(): object

Inherited from NodeWidget.pos

Returns: object


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

Name Type
name string

Returns: QVariant


raise

raise(): void

Inherited from NodeWidget.raise

Returns: void


removeColumn

removeColumn(column: number): void

Parameters:

Name Type
column number

Returns: void


removeEventListener

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

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QTableWidgetSignals

Parameters:

Name Type
signalType SignalType
callback Signals[SignalType]

Returns: void

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

Inherited from EventWidget.removeEventListener

Parameters:

eventType: WidgetEventTypes

callback: function

▸ (event?: NativeElement): void

Parameters:

Name Type
event? NativeElement

Returns: void


removeRow

removeRow(row: number): void

Parameters:

Name Type
row number

Returns: void


repaint

repaint(): void

Inherited from NodeWidget.repaint

Returns: void


resize

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

Inherited from NodeWidget.resize

Parameters:

Name Type
width number
height number

Returns: void


resizeColumnToContents

resizeColumnToContents(column: number): void

Parameters:

Name Type
column number

Returns: void


resizeColumnsToContents

resizeColumnsToContents(): void

Returns: void


resizeRowToContents

resizeRowToContents(row: number): void

Parameters:

Name Type
row number

Returns: void


resizeRowsToContents

resizeRowsToContents(): void

Returns: void


scrollToItem

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

Parameters:

Name Type Default
item QTableWidgetItem -
hint ScrollHint ScrollHint.EnsureVisible

Returns: void


selectColumn

selectColumn(column: number): void

Parameters:

Name Type
column number

Returns: void


selectRow

selectRow(row: number): void

Parameters:

Name Type
row number

Returns: void


selectedRanges

selectedRanges(): Range[]

Returns: Range[]


setAttribute

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

Inherited from NodeWidget.setAttribute

Parameters:

Name Type
attribute WidgetAttribute
switchOn boolean

Returns: void


setCellWidget

setCellWidget(row: number, column: number, widget: NodeWidgetany): void

Parameters:

Name Type
row number
column number
widget NodeWidgetany

Returns: void


setColumnWidth

setColumnWidth(column: number, width: number): void

Parameters:

Name Type
column number
width number

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from NodeWidget.setContextMenuPolicy

Parameters:

Name Type
contextMenuPolicy ContextMenuPolicy

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from NodeWidget.setCursor

Parameters:

Name Type
cursor CursorShape | QCursor

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from NodeWidget.setEnabled

Parameters:

Name Type
enabled boolean

Returns: void


setFixedSize

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

Inherited from NodeWidget.setFixedSize

Parameters:

Name Type
width number
height number

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:

Name Type Description
isSizeControlled boolean

Returns: void


setGeometry

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

Inherited from NodeWidget.setGeometry

Parameters:

Name Type
x number
y number
w number
h number

Returns: void


setHorizontalHeaderItem

setHorizontalHeaderItem(column: number, item: QTableWidgetItem): void

Parameters:

Name Type
column number
item QTableWidgetItem

Returns: void


setHorizontalHeaderLabels

setHorizontalHeaderLabels(labels: string[]): void

Parameters:

Name Type
labels string[]

Returns: void


setHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

Name Type
policy ScrollBarPolicy

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from NodeWidget.setInlineStyle

Parameters:

Name Type
style string

Returns: void


setItem

setItem(row: number, column: number, item: QTableWidgetItem): void

Parameters:

Name Type
row number
column number
item QTableWidgetItem

Returns: void


setLayout

setLayout(parentLayout: NodeLayoutQTableWidgetSignals): void

Inherited from NodeWidget.setLayout

Parameters:

Name Type
parentLayout NodeLayoutQTableWidgetSignals

Returns: void


setMaximumSize

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

Inherited from NodeWidget.setMaximumSize

Parameters:

Name Type
maxw number
maxh number

Returns: void


setMinimumSize

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

Inherited from NodeWidget.setMinimumSize

Parameters:

Name Type
minw number
minh number

Returns: void


setMouseTracking

setMouseTracking(isMouseTracked: boolean): void

Inherited from NodeWidget.setMouseTracking

Parameters:

Name Type
isMouseTracked boolean

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

Name Type
parent? Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from NodeWidget.setObjectName

Overrides NodeObject.setObjectName

Parameters:

Name Type
objectName string

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

Name Type
name string
value QVariantType

Returns: boolean


setRowHeight

setRowHeight(row: number, height: number): void

Parameters:

Name Type
row number
height number

Returns: void


setShowGrid

setShowGrid(show: boolean): void

Parameters:

Name Type
show boolean

Returns: void


setSortingEnabled

setSortingEnabled(enable: boolean): void

Parameters:

Name Type
enable boolean

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from NodeWidget.setStyleSheet

Parameters:

Name Type
styleSheet string

Returns: void


setVerticalHeaderItem

setVerticalHeaderItem(row: number, item: QTableWidgetItem): void

Parameters:

Name Type
row number
item QTableWidgetItem

Returns: void


setVerticalHeaderLabels

setVerticalHeaderLabels(labels: string[]): void

Parameters:

Name Type
labels string[]

Returns: void


setVerticalScrollBarPolicy

setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

Name Type
policy ScrollBarPolicy

Returns: void


setViewport

setViewport(widget: NodeWidgetany): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

Name Type
widget NodeWidgetany

Returns: void


setWindowFlag

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

Inherited from NodeWidget.setWindowFlag

Parameters:

Name Type
windowType WindowType
switchOn boolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from NodeWidget.setWindowIcon

Parameters:

Name Type
icon QIcon

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from NodeWidget.setWindowOpacity

Parameters:

Name Type
opacity number

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from NodeWidget.setWindowState

Parameters:

Name Type
state WindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from NodeWidget.setWindowTitle

Parameters:

Name Type
title string

Returns: void


show

show(): void

Inherited from NodeWidget.show

Returns: void


showColumn

showColumn(column: number): void

Parameters:

Name Type
column number

Returns: void


showFullScreen

showFullScreen(): void

Inherited from NodeWidget.showFullScreen

Returns: void


showGrid

showGrid(): boolean

Returns: boolean


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


showRow

showRow(row: number): void

Parameters:

Name Type
row number

Returns: void


size

size(): QSize

Inherited from NodeWidget.size

Returns: QSize


sortByColumn

sortByColumn(column: number, order: SortOrder): void

Parameters:

Name Type
column number
order SortOrder

Returns: void


styleSheet

styleSheet(): string

Inherited from NodeWidget.styleSheet

Returns: string


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from NodeWidget.testAttribute

Parameters:

Name Type
attribute WidgetAttribute

Returns: boolean


update

update(): void

Inherited from NodeWidget.update

Returns: void


updateGeometry

updateGeometry(): void

Inherited from NodeWidget.updateGeometry

Returns: void


viewport

viewport(): QWidget

Inherited from QAbstractScrollArea.viewport

Returns: QWidget


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