QScrollArea

A QScrollArea provides a scrolling view onto another widget.

This class is a JS wrapper around Qt's QScrollArea class

Example

const { QScrollArea } = require("@nodegui/nodegui");
const scrollArea = new QScrollArea();
scrollArea.setInlineStyle("flex: 1; width:'100%';");
const imageLabel = new QLabel();
const pixmap = new QPixmap(
path.resolve(__dirname, "../extras/assets/kitchen.png")
);
imageLabel.setPixmap(pixmap);
scrollArea.setWidget(imageLabel);

Hierarchy

QAbstractScrollAreaQScrollAreaSignals

QScrollArea

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new QScrollArea(): QScrollArea

Overrides NodeWidget.constructor

Returns: QScrollArea

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

Overrides NodeWidget.constructor

Parameters:

NameType
parentNodeWidget‹any›

Returns: QScrollArea

Properties

Optional _layout

_layout? : NodeLayoutQScrollAreaSignals

Inherited from QMenu._layout


_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

actions: Set‹QAction

Inherited from QMenu.actions


Optional contentWidget

contentWidget? : NodeWidget‹any› | null


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 QMenu.type


Optional viewportWidget

viewportWidget? : NodeWidget‹any›

Inherited from QAbstractScrollArea.viewportWidget

Accessors

layout

get layout(): NodeLayoutQScrollAreaSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayoutQScrollAreaSignals› | undefined

set layout(l: NodeLayoutQScrollAreaSignals› | undefined): void

Inherited from QMenu.layout

Parameters:

NameType
lNodeLayoutQScrollAreaSignals› | undefined

Returns: void

Methods

acceptDrops

acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean


activateWindow

activateWindow(): void

Inherited from QMenu.activateWindow

Returns: void


addAction

addAction(action: QAction | string): QAction

Inherited from QMenu.addAction

Parameters:

NameType
actionQAction | string

Returns: QAction


addEventListener

addEventListenerSignalType›(signalType: SignalType, callback: QScrollAreaSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QScrollAreaSignals

Parameters:

NameTypeDescription
signalTypeSignalTypeSignalType is a signal from the widgets signals interface.
callbackQScrollAreaSignals[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


adjustSize

adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void


alignment

alignment(): AlignmentFlag

Returns: AlignmentFlag


clearFocus

clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void


close

close(): boolean

Inherited from QMenu.close

Returns: boolean


ensureVisible

ensureVisible(x: number, y: number, xmargin: number, ymargin: number): void

Parameters:

NameTypeDefault
xnumber-
ynumber-
xmarginnumber50
ymarginnumber50

Returns: void


ensureWidgetVisible

ensureWidgetVisible(childWidget: NodeWidget‹any›, xmargin: number, ymargin: number): void

Parameters:

NameTypeDefault
childWidgetNodeWidget‹any›-
xmarginnumber50
ymarginnumber50

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.


font

font(): QFont

Inherited from QMenu.font

Returns: QFont


frameRect

frameRect(): QRect

Inherited from NodeFrame.frameRect

Returns: QRect


frameShadow

frameShadow(): Shadow

Inherited from NodeFrame.frameShadow

Returns: Shadow


frameShape

frameShape(): Shape

Inherited from NodeFrame.frameShape

Returns: Shape


frameStyle

frameStyle(): number

Inherited from NodeFrame.frameStyle

Returns: number


frameWidth

frameWidth(): number

Inherited from NodeFrame.frameWidth

Returns: number


geometry

geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect


getFlexNode

getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode


hasMouseTracking

hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean


hide

hide(): void

Inherited from QMenu.hide

Returns: void


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

NameType
classNamestring

Returns: boolean


isActiveWindow

isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

Returns: boolean


isEnabled

isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean


isVisible

isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean


lineWidth

lineWidth(): number

Inherited from NodeFrame.lineWidth

Returns: number


lower

lower(): void

Inherited from QMenu.lower

Returns: void


mapFromGlobal

mapFromGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapFromGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapFromParent

mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

NameType
posQPoint

Returns: QPoint


mapToGlobal

mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

NameType
posQPoint

Returns: QPoint


mapToParent

mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

NameType
posQPoint

Returns: QPoint


maximumSize

maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize


maximumViewportSize

maximumViewportSize(): QSize

Inherited from QAbstractScrollArea.maximumViewportSize

Returns: QSize


midLineWidth

midLineWidth(): number

Inherited from NodeFrame.midLineWidth

Returns: number


minimumSize

minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize


move

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

Inherited from QMenu.move

Parameters:

NameType
xnumber
ynumber

Returns: void


objectName

objectName(): string

Inherited from NodeObject.objectName

Returns: string


pos

pos(): object

Inherited from QMenu.pos

Returns: object

  • x: number

  • y: number


property

property(name: string): QVariant

Inherited from NodeObject.property

Parameters:

NameType
namestring

Returns: QVariant


raise

raise(): void

Inherited from QMenu.raise

Returns: void


removeAction

removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

NameType
actionQAction

Returns: void


removeEventListener

removeEventListenerSignalType›(signalType: SignalType, callback: QScrollAreaSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QScrollAreaSignals

Parameters:

NameType
signalTypeSignalType
callbackQScrollAreaSignals[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


repaint

repaint(): void

Inherited from QMenu.repaint

Returns: void


repolish

repolish(): void

Inherited from QMenu.repolish

Returns: void


resize

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

Inherited from QMenu.resize

Parameters:

NameType
widthnumber
heightnumber

Returns: void


setAcceptDrops

setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

NameType
onboolean

Returns: void


setAlignment

setAlignment(alignment: AlignmentFlag): void

Parameters:

NameType
alignmentAlignmentFlag

Returns: void


setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

NameType
attributeWidgetAttribute
switchOnboolean

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

NameType
enabledboolean

Returns: void


setEventProcessed

setEventProcessed(isProcessed: boolean): void

Inherited from EventWidget.setEventProcessed

Mark the current event as having been processed

This method is used to indicate that the currently dispatched event has been processed and no further processing by superclasses is required. It only makes sense to call this method from an event handler.

When set, this flag will cause NodeGui's QObject::event() method to return true and not call the superclass event(), effectively preventing any further processing on this event.

Parameters:

NameTypeDescription
isProcessedbooleantrue if the event has been processed.

Returns: void


setFixedSize

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

Inherited from QMenu.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


setFocus

setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

NameTypeDefault
reasonFocusReasonFocusReason.OtherFocusReason

Returns: void


setFocusPolicy

setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

NameType
policyFocusPolicy

Returns: void


setFont

setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

NameType
fontQFont

Returns: void


setFrameRect

setFrameRect(r: QRect): void

Inherited from NodeFrame.setFrameRect

Parameters:

NameType
rQRect

Returns: void


setFrameShadow

setFrameShadow(type: Shadow): void

Inherited from NodeFrame.setFrameShadow

Parameters:

NameType
typeShadow

Returns: void


setFrameShape

setFrameShape(type: Shape): void

Inherited from NodeFrame.setFrameShape

Parameters:

NameType
typeShape

Returns: void


setFrameStyle

setFrameStyle(style: number): void

Inherited from NodeFrame.setFrameStyle

Parameters:

NameType
stylenumber

Returns: void


setGeometry

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

Inherited from QMenu.setGeometry

Parameters:

NameType
xnumber
ynumber
wnumber
hnumber

Returns: void


setGraphicsEffect

setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

NameType
effectQGraphicsEffect‹any›

Returns: void


setHorizontalScrollBar

setHorizontalScrollBar(scrollBar: QScrollBar): void

Inherited from QAbstractScrollArea.setHorizontalScrollBar

Parameters:

NameType
scrollBarQScrollBar

Returns: void


setHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

NameType
policyScrollBarPolicy

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setLayout

setLayout(parentLayout: NodeLayoutQScrollAreaSignals›): void

Inherited from QMenu.setLayout

Parameters:

NameType
parentLayoutNodeLayoutQScrollAreaSignals

Returns: void


setLineWidth

setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

NameType
widthnumber

Returns: void


setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

NameType
maxwnumber
maxhnumber

Returns: void


setMidLineWidth

setMidLineWidth(width: number): void

Inherited from NodeFrame.setMidLineWidth

Parameters:

NameType
widthnumber

Returns: void


setMinimumSize

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

Inherited from QMenu.setMinimumSize

Parameters:

NameType
minwnumber
minhnumber

Returns: void


setMouseTracking

setMouseTracking(isMouseTracked: boolean): void

Inherited from QMenu.setMouseTracking

Parameters:

NameType
isMouseTrackedboolean

Returns: void


setNodeParent

setNodeParent(parent?: Component): void

Inherited from Component.setNodeParent

Parameters:

NameType
parent?Component

Returns: void


setObjectName

setObjectName(objectName: string): void

Inherited from QMenu.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


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setVerticalScrollBar

setVerticalScrollBar(scrollBar: QScrollBar): void

Inherited from QAbstractScrollArea.setVerticalScrollBar

Parameters:

NameType
scrollBarQScrollBar

Returns: void


setVerticalScrollBarPolicy

setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

NameType
policyScrollBarPolicy

Returns: void


setViewport

setViewport(widget: NodeWidget‹any›): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

NameType
widgetNodeWidget‹any›

Returns: void


setViewportMargins

setViewportMargins(left: number, top: number, right: number, bottom: number): void

Parameters:

NameType
leftnumber
topnumber
rightnumber
bottomnumber

Returns: void


setWidget

setWidget(widget: NodeWidget‹any›): void

Parameters:

NameType
widgetNodeWidget‹any›

Returns: void


setWidgetResizable

setWidgetResizable(resizable: boolean): void

Parameters:

NameType
resizableboolean

Returns: void


setWindowFlag

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

Inherited from QMenu.setWindowFlag

Parameters:

NameType
windowTypeWindowType
switchOnboolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

NameType
iconQIcon

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

NameType
opacitynumber

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

NameType
stateWindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

NameType
titlestring

Returns: void


show

show(): void

Inherited from QMenu.show

Returns: void


showFullScreen

showFullScreen(): void

Inherited from QMenu.showFullScreen

Returns: void


showMaximized

showMaximized(): void

Inherited from QMenu.showMaximized

Returns: void


showMinimized

showMinimized(): void

Inherited from QMenu.showMinimized

Returns: void


showNormal

showNormal(): void

Inherited from QMenu.showNormal

Returns: void


size

size(): QSize

Inherited from QMenu.size

Returns: QSize


styleSheet

styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string


takeWidget

takeWidget(): NodeWidget‹any› | null

Returns: NodeWidget‹any› | null


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

NameType
attributeWidgetAttribute

Returns: boolean


update

update(): void

Inherited from QMenu.update

Returns: void


updateGeometry

updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void


viewport

viewport(): QWidget

Inherited from QAbstractScrollArea.viewport

Returns: QWidget


viewportMargins

viewportMargins(): Margins

Returns: Margins


widget

widget(): NodeWidget‹any› | null

Returns: NodeWidget‹any› | null


widgetResizable

widgetResizable(): boolean

Returns: boolean


windowOpacity

windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number


windowState

windowState(): number

Inherited from QMenu.windowState

Returns: number


windowTitle

windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string