QFrame

Create and control frame.

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

The QFrame class is the base class of widgets that can have a frame. It can be used directly for creating simple placeholder frames without any contents.

Example

const { QFrame } = require("@nodegui/nodegui");

const frame = new QFrame();

Hierarchy

↳ NodeFrame‹QFrameSignals›

↳ QFrame

Index

Constructors

• constructor

Properties

• _layout
• _rawInlineStyle
• native
• nodeChildren
• nodeParent
• type

Accessors

• layout

Methods

• acceptDrops
• activateWindow
• addAction
• addEventListener
• adjustSize
• clearFocus
• close
• dumpObjectInfo
• dumpObjectTree
• eventProcessed
• font
• frameGeometry
• frameRect
• frameShadow
• frameShape
• frameStyle
• frameWidth
• geometry
• getFlexNode
• hasFocus
• hasMouseTracking
• height
• hide
• inherits
• isActiveWindow
• isEnabled
• isFullScreen
• isHidden
• isMaximized
• isMinimized
• isModal
• isVisible
• isWindow
• isWindowModified
• lineWidth
• lower
• mapFromGlobal
• mapFromParent
• mapToGlobal
• mapToParent
• maximumSize
• midLineWidth
• minimumSize
• move
• objectName
• pos
• property
• raise
• removeAction
• removeEventListener
• repaint
• repolish
• resize
• setAcceptDrops
• setAttribute
• setContextMenuPolicy
• setCursor
• setDisabled
• setEnabled
• setEventProcessed
• setFixedSize
• setFlexNodeSizeControlled
• setFocus
• setFocusPolicy
• setFont
• setFrameRect
• setFrameShadow
• setFrameShape
• setFrameStyle
• setGeometry
• setGraphicsEffect
• setHidden
• setInlineStyle
• setLayout
• setLineWidth
• setMaximumHeight
• setMaximumSize
• setMaximumWidth
• setMidLineWidth
• setMinimumHeight
• setMinimumSize
• setMinimumWidth
• setMouseTracking
• setNodeParent
• setObjectName
• setProperty
• setSizePolicy
• setStyleSheet
• setVisible
• setWindowFlag
• setWindowIcon
• setWindowModified
• setWindowOpacity
• setWindowState
• setWindowTitle
• show
• showFullScreen
• showMaximized
• showMinimized
• showNormal
• size
• style
• styleSheet
• testAttribute
• update
• updateGeometry
• width
• windowHandle
• windowOpacity
• windowState
• windowTitle
• x
• y

Constructors

constructor

+ new QFrame(arg?: NodeWidget‹QWidgetSignals› | NativeElement): QFrame

Overrides NodeFrame.constructor

Parameters:

Name	Type
arg?	NodeWidget‹QWidgetSignals› | NativeElement

Returns: QFrame

Properties

Optional _layout

• _layout? : NodeLayout‹QFrameSignals›

Inherited from QMenu._layout

---

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle

---

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

Accessors

layout

• get layout(): NodeLayout‹QFrameSignals› | undefined

Inherited from QMenu.layout

Returns: NodeLayout‹QFrameSignals› | undefined

• set layout(l: NodeLayout‹QFrameSignals› | undefined): void

Inherited from QMenu.layout

Parameters:

Name	Type
l	NodeLayout‹QFrameSignals› | 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:

Name	Type
action	QAction | string

Returns: QAction

---

addEventListener

▸ addEventListener‹SignalType›(signalType: SignalType, callback: QFrameSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

▪ SignalType: keyof QFrameSignals

Parameters:

Name	Type	Description
signalType	SignalType	SignalType is a signal from the widgets signals interface.
callback	QFrameSignals[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

---

clearFocus

▸ clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void

---

close

▸ close(): boolean

Inherited from QMenu.close

Returns: boolean

---

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from NodeObject.dumpObjectInfo

Returns: void

---

dumpObjectTree

▸ dumpObjectTree(): void

Inherited from NodeObject.dumpObjectTree

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

---

frameGeometry

▸ frameGeometry(): QRect

Inherited from QMenu.frameGeometry

Returns: QRect

---

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

---

hasFocus

▸ hasFocus(): boolean

Inherited from QMenu.hasFocus

Returns: boolean

---

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean

---

height

▸ height(): number

Inherited from QMenu.height

Returns: number

---

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

---

isActiveWindow

▸ isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

Returns: boolean

---

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

---

isFullScreen

▸ isFullScreen(): boolean

Inherited from QMenu.isFullScreen

Returns: boolean

---

isHidden

▸ isHidden(): boolean

Inherited from QMenu.isHidden

Returns: boolean

---

isMaximized

▸ isMaximized(): boolean

Inherited from QMenu.isMaximized

Returns: boolean

---

isMinimized

▸ isMinimized(): boolean

Inherited from QMenu.isMinimized

Returns: boolean

---

isModal

▸ isModal(): boolean

Inherited from QMenu.isModal

Returns: boolean

---

isVisible

▸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean

---

isWindow

▸ isWindow(): boolean

Inherited from QMenu.isWindow

Returns: boolean

---

isWindowModified

▸ isWindowModified(): boolean

Inherited from QMenu.isWindowModified

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:

Name	Type
pos	QPoint

Returns: QPoint

---

mapFromParent

▸ mapFromParent(pos: QPoint): QPoint

Inherited from QMenu.mapFromParent

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToGlobal

▸ mapToGlobal(pos: QPoint): QPoint

Inherited from QMenu.mapToGlobal

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

mapToParent

▸ mapToParent(pos: QPoint): QPoint

Inherited from QMenu.mapToParent

Parameters:

Name	Type
pos	QPoint

Returns: QPoint

---

maximumSize

▸ maximumSize(): QSize

Inherited from QMenu.maximumSize

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:

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

---

removeAction

▸ removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

Name	Type
action	QAction

Returns: void

---

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: QFrameSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof QFrameSignals

Parameters:

Name	Type
signalType	SignalType
callback	QFrameSignals[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

---

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

Name	Type
on	boolean

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

---

setDisabled

▸ setDisabled(disable: boolean): void

Inherited from QMenu.setDisabled

Parameters:

Name	Type
disable	boolean

Returns: void

---

setEnabled

▸ setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

Name	Type
enabled	boolean

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:

Name	Type	Description
isProcessed	boolean	true if the event has been processed.

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

---

setFocus

▸ setFocus(reason: FocusReason): void

Inherited from QMenu.setFocus

Parameters:

Name	Type	Default
reason	FocusReason	FocusReason.OtherFocusReason

Returns: void

---

setFocusPolicy

▸ setFocusPolicy(policy: FocusPolicy): void

Inherited from QMenu.setFocusPolicy

Parameters:

Name	Type
policy	FocusPolicy

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

---

setGraphicsEffect

▸ setGraphicsEffect(effect: QGraphicsEffect‹any›): void

Inherited from QMenu.setGraphicsEffect

Parameters:

Name	Type
effect	QGraphicsEffect‹any›

Returns: void

---

setHidden

▸ setHidden(hidden: boolean): void

Inherited from QMenu.setHidden

Parameters:

Name	Type
hidden	boolean

Returns: void

---

setInlineStyle

▸ setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type
style	string

Returns: void

---

setLayout

▸ setLayout(parentLayout: NodeLayout‹QFrameSignals›): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
parentLayout	NodeLayout‹QFrameSignals›

Returns: void

---

setLineWidth

▸ setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

Name	Type
width	number

Returns: void

---

setMaximumHeight

▸ setMaximumHeight(maxh: number): void

Inherited from QMenu.setMaximumHeight

Parameters:

Name	Type
maxh	number

Returns: void

---

setMaximumSize

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

Inherited from QMenu.setMaximumSize

Parameters:

Name	Type
maxw	number
maxh	number

Returns: void

---

setMaximumWidth

▸ setMaximumWidth(maxw: number): void

Inherited from QMenu.setMaximumWidth

Parameters:

Name	Type
maxw	number

Returns: void

---

setMidLineWidth

▸ setMidLineWidth(width: number): void

Inherited from NodeFrame.setMidLineWidth

Parameters:

Name	Type
width	number

Returns: void

---

setMinimumHeight

▸ setMinimumHeight(minh: number): void

Inherited from QMenu.setMinimumHeight

Parameters:

Name	Type
minh	number

Returns: void

---

setMinimumSize

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

Inherited from QMenu.setMinimumSize

Parameters:

Name	Type
minw	number
minh	number

Returns: void

---

setMinimumWidth

▸ setMinimumWidth(minw: number): void

Inherited from QMenu.setMinimumWidth

Parameters:

Name	Type
minw	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

---

setSizePolicy

▸ setSizePolicy(horizontal: QSizePolicyPolicy, vertical: QSizePolicyPolicy): void

Inherited from QMenu.setSizePolicy

Parameters:

Name	Type
horizontal	QSizePolicyPolicy
vertical	QSizePolicyPolicy

Returns: void

---

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type
styleSheet	string

Returns: void

---

setVisible

▸ setVisible(visible: boolean): void

Inherited from QMenu.setVisible

Parameters:

Name	Type
visible	boolean

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

---

setWindowModified

▸ setWindowModified(modified: boolean): void

Inherited from QMenu.setWindowModified

Parameters:

Name	Type
modified	boolean

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

---

style

▸ style(): QStyle

Inherited from QMenu.style

Returns: QStyle

---

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

---

width

▸ width(): number

Inherited from QMenu.width

Returns: number

---

windowHandle

▸ windowHandle(): QWindow | null

Inherited from QMenu.windowHandle

Returns: QWindow | null

---

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

---

x

▸ x(): number

Inherited from QMenu.x

Returns: number

---

y

▸ y(): number

Inherited from QMenu.y

Returns: number