22 KiB
| id | title | sidebar_label |
|---|---|---|
| qabstractscrollarea | QAbstractScrollArea | QAbstractScrollArea |
Abstract class to add functionalities common to all scrollarea based widgets.
This class implements all methods, properties of Qt's QAbstractScrollArea class so that it can be inherited by all scroll based widgets*
QAbstractScrollArea is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all scrollable widget's easily. If you wish to create a scrollarea use QScrollArea instead.
QAbstractScrollArea is the base class for all widgets.*
QAbstractScrollArea will list all methods and properties that are common to all scrollable widgets in the NodeGui world.
Type parameters
▪ Signals: QAbstractScrollAreaSignals
Hierarchy
↳ NodeWidget‹Signals›
↳ QAbstractScrollArea
Index
Constructors
Properties
Methods
- activateWindow
- addAction
- addEventListener
- adjustSize
- close
- font
- geometry
- getFlexNode
- hasMouseTracking
- hide
- inherits
- isEnabled
- isVisible
- lower
- move
- objectName
- pos
- property
- raise
- removeEventListener
- repaint
- resize
- setAttribute
- setContextMenuPolicy
- setCursor
- setEnabled
- setFixedSize
- setFlexNodeSizeControlled
- setFont
- setGeometry
- setHorizontalScrollBarPolicy
- setInlineStyle
- setLayout
- setMaximumSize
- setMinimumSize
- setMouseTracking
- setNodeParent
- setObjectName
- setProperty
- setStyleSheet
- setVerticalScrollBarPolicy
- setViewport
- setWindowFlag
- setWindowIcon
- setWindowOpacity
- setWindowState
- setWindowTitle
- show
- showFullScreen
- showMaximized
- showMinimized
- showNormal
- size
- styleSheet
- testAttribute
- update
- updateGeometry
- viewport
- windowOpacity
- windowState
- windowTitle
Constructors
constructor
+ new QAbstractScrollArea(native: NativeElement): QAbstractScrollArea
Inherited from EventWidget.constructor
Overrides Component.constructor
Parameters:
| Name | Type |
|---|---|
native |
NativeElement |
Returns: QAbstractScrollArea
Properties
_rawInlineStyle
• _rawInlineStyle: string = ""
Inherited from QMenu._rawInlineStyle
actions
• actions: Set‹QAction‹›› = new Set()
Optional layout
• layout? : NodeLayout‹Signals›
Abstract native
• native: NativeElement
Inherited from Component.native
nodeChildren
• nodeChildren: Set‹Component›
Inherited from Component.nodeChildren
Optional nodeParent
• nodeParent? : Component
Inherited from Component.nodeParent
type
• type: string = "widget"
Optional viewportWidget
• viewportWidget? : NodeWidget‹any›
Methods
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: Signals[SignalType]): void
Inherited from EventWidget.addEventListener
Type parameters:
▪ SignalType: keyof Signals
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?: NativeRawPointer‹"QEvent"›): void
Parameters:
| Name | Type |
|---|---|
event? |
NativeRawPointer‹"QEvent"› |
Returns: void
adjustSize
▸ adjustSize(): void
Inherited from QMenu.adjustSize
Returns: void
close
▸ close(): boolean
Returns: boolean
font
▸ font(): QFont
Returns: QFont
geometry
▸ geometry(): QRect
Returns: QRect
getFlexNode
▸ getFlexNode(): FlexNode
Inherited from YogaWidget.getFlexNode
Returns: FlexNode
hasMouseTracking
▸ hasMouseTracking(): boolean
Inherited from QMenu.hasMouseTracking
Returns: boolean
hide
▸ hide(): void
Returns: void
inherits
▸ inherits(className: string): boolean
Inherited from NodeObject.inherits
Parameters:
| Name | Type |
|---|---|
className |
string |
Returns: boolean
isEnabled
▸ isEnabled(): boolean
Inherited from QMenu.isEnabled
Returns: boolean
isVisible
▸ isVisible(): boolean
Inherited from QMenu.isVisible
Returns: boolean
lower
▸ lower(): void
Returns: void
move
▸ move(x: number, y: number): void
Parameters:
| Name | Type |
|---|---|
x |
number |
y |
number |
Returns: void
objectName
▸ objectName(): string
Inherited from NodeObject.objectName
Returns: string
pos
▸ pos(): object
Returns: object
-
x: number
-
y: number
property
▸ property(name: string): QVariant
Inherited from NodeObject.property
Parameters:
| Name | Type |
|---|---|
name |
string |
Returns: QVariant
raise
▸ raise(): void
Returns: void
removeEventListener
▸ removeEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void
Inherited from EventWidget.removeEventListener
Type parameters:
▪ SignalType: keyof Signals
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?: NativeRawPointer‹"QEvent"›): void
Parameters:
| Name | Type |
|---|---|
event? |
NativeRawPointer‹"QEvent"› |
Returns: void
repaint
▸ repaint(): void
Returns: void
resize
▸ resize(width: number, height: number): void
Parameters:
| Name | Type |
|---|---|
width |
number |
height |
number |
Returns: void
setAttribute
▸ setAttribute(attribute: WidgetAttribute, switchOn: boolean): void
Inherited from QMenu.setAttribute
Parameters:
| Name | Type |
|---|---|
attribute |
WidgetAttribute |
switchOn |
boolean |
Returns: void
setContextMenuPolicy
▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void
Inherited from QMenu.setContextMenuPolicy
Parameters:
| Name | Type |
|---|---|
contextMenuPolicy |
ContextMenuPolicy |
Returns: void
setCursor
▸ setCursor(cursor: CursorShape | QCursor): void
Inherited from QMenu.setCursor
Parameters:
| Name | Type |
|---|---|
cursor |
CursorShape | QCursor |
Returns: void
setEnabled
▸ setEnabled(enabled: boolean): void
Inherited from QMenu.setEnabled
Parameters:
| Name | Type |
|---|---|
enabled |
boolean |
Returns: void
setFixedSize
▸ setFixedSize(width: number, height: number): void
Inherited from QMenu.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
setFont
▸ setFont(font: QFont): void
Parameters:
| Name | Type |
|---|---|
font |
QFont |
Returns: void
setGeometry
▸ setGeometry(x: number, y: number, w: number, h: number): void
Inherited from QMenu.setGeometry
Parameters:
| Name | Type |
|---|---|
x |
number |
y |
number |
w |
number |
h |
number |
Returns: void
setHorizontalScrollBarPolicy
▸ setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void
Parameters:
| Name | Type |
|---|---|
policy |
ScrollBarPolicy |
Returns: void
setInlineStyle
▸ setInlineStyle(style: string): void
Inherited from QMenu.setInlineStyle
Parameters:
| Name | Type |
|---|---|
style |
string |
Returns: void
setLayout
▸ setLayout(parentLayout: NodeLayout‹Signals›): void
Inherited from QMenu.setLayout
Parameters:
| Name | Type |
|---|---|
parentLayout |
NodeLayout‹Signals› |
Returns: void
setMaximumSize
▸ setMaximumSize(maxw: number, maxh: number): void
Inherited from QMenu.setMaximumSize
Parameters:
| Name | Type |
|---|---|
maxw |
number |
maxh |
number |
Returns: void
setMinimumSize
▸ setMinimumSize(minw: number, minh: number): void
Inherited from QMenu.setMinimumSize
Parameters:
| Name | Type |
|---|---|
minw |
number |
minh |
number |
Returns: void
setMouseTracking
▸ setMouseTracking(isMouseTracked: boolean): void
Inherited from QMenu.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 QMenu.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
setStyleSheet
▸ setStyleSheet(styleSheet: string): void
Inherited from QMenu.setStyleSheet
Parameters:
| Name | Type |
|---|---|
styleSheet |
string |
Returns: void
setVerticalScrollBarPolicy
▸ setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void
Parameters:
| Name | Type |
|---|---|
policy |
ScrollBarPolicy |
Returns: void
setViewport
▸ setViewport(widget: NodeWidget‹any›): void
Parameters:
| Name | Type |
|---|---|
widget |
NodeWidget‹any› |
Returns: void
setWindowFlag
▸ setWindowFlag(windowType: WindowType, switchOn: boolean): void
Inherited from QMenu.setWindowFlag
Parameters:
| Name | Type |
|---|---|
windowType |
WindowType |
switchOn |
boolean |
Returns: void
setWindowIcon
▸ setWindowIcon(icon: QIcon): void
Inherited from QMenu.setWindowIcon
Parameters:
| Name | Type |
|---|---|
icon |
QIcon |
Returns: void
setWindowOpacity
▸ setWindowOpacity(opacity: number): void
Inherited from QMenu.setWindowOpacity
Parameters:
| Name | Type |
|---|---|
opacity |
number |
Returns: void
setWindowState
▸ setWindowState(state: WindowState): void
Inherited from QMenu.setWindowState
Parameters:
| Name | Type |
|---|---|
state |
WindowState |
Returns: void
setWindowTitle
▸ setWindowTitle(title: string): void
Inherited from QMenu.setWindowTitle
Parameters:
| Name | Type |
|---|---|
title |
string |
Returns: void
show
▸ show(): void
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
Returns: QSize
styleSheet
▸ styleSheet(): string
Inherited from QMenu.styleSheet
Returns: string
testAttribute
▸ testAttribute(attribute: WidgetAttribute): boolean
Inherited from QMenu.testAttribute
Parameters:
| Name | Type |
|---|---|
attribute |
WidgetAttribute |
Returns: boolean
update
▸ update(): void
Returns: void
updateGeometry
▸ updateGeometry(): void
Inherited from QMenu.updateGeometry
Returns: void
viewport
▸ viewport(): QWidget
Returns: QWidget
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