nodeguy/website/docs/api/generated/classes/qabstractscrollarea.md
2020-03-15 12:35:48 +01:00

26 KiB
Raw Blame History

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

NodeFrameSignals

QAbstractScrollArea

QAbstractItemView

QTableWidget

QPlainTextEdit

QScrollArea

QTreeWidget

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QAbstractScrollArea(native: NativeElement): QAbstractScrollArea

Inherited from NodeWidget.constructor

Overrides EventWidget.constructor

Parameters:

Name Type
native NativeElement

Returns: QAbstractScrollArea

Properties

_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

actions: SetQAction

Inherited from QMenu.actions


Optional layout

layout? : NodeLayoutSignals

Inherited from QMenu.layout


Abstract native

native: NativeElement

Inherited from Component.native


nodeChildren

nodeChildren: SetComponent

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent


type

type: string = "widget"

Inherited from QMenu.type


Optional viewportWidget

viewportWidget? : NodeWidgetany

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

Inherited from QMenu.close

Returns: boolean


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:

Name Type
className string

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


midLineWidth

midLineWidth(): number

Inherited from NodeFrame.midLineWidth

Returns: number


move

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

Inherited from QMenu.move

Parameters:

Name Type
x number
y number

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:

Name Type
name string

Returns: QVariant


raise

raise(): void

Inherited from QMenu.raise

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

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:

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

Inherited from QMenu.setFont

Parameters:

Name Type
font QFont

Returns: void


setFrameRect

setFrameRect(r: QRect): void

Inherited from NodeFrame.setFrameRect

Parameters:

Name Type
r QRect

Returns: void


setFrameShadow

setFrameShadow(type: Shadow): void

Inherited from NodeFrame.setFrameShadow

Parameters:

Name Type
type Shadow

Returns: void


setFrameShape

setFrameShape(type: Shape): void

Inherited from NodeFrame.setFrameShape

Parameters:

Name Type
type Shape

Returns: void


setFrameStyle

setFrameStyle(style: number): void

Inherited from NodeFrame.setFrameStyle

Parameters:

Name Type
style number

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

Inherited from QMenu.setLayout

Parameters:

Name Type
parentLayout NodeLayoutSignals

Returns: void


setLineWidth

setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

Name Type
width number

Returns: void


setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

Name Type
maxw number
maxh number

Returns: void


setMidLineWidth

setMidLineWidth(width: number): void

Inherited from NodeFrame.setMidLineWidth

Parameters:

Name Type
width 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: NodeWidgetany): void

Parameters:

Name Type
widget NodeWidgetany

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

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


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name Type
attribute WidgetAttribute

Returns: boolean


update

update(): void

Inherited from QMenu.update

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