QTextEdit

Create and control editable text field.

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

A QTextEdit provides ability to add and manipulate native editable text field widgets.

Example

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

const textEdit = new QTextEdit();

Type parameters

▪ Signals: QTextEditSignals

Hierarchy

↳ QAbstractScrollArea‹Signals›

↳ QTextEdit

↳ QTextBrowser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

+ new QTextEdit(arg?: QWidget‹QWidgetSignals› | NativeElement): QTextEdit

Overrides QFrame.constructor

Parameters:

Name	Type
`arg?`	QWidget‹QWidgetSignals› \| NativeElement

Returns: QTextEdit

Properties

_rawInlineStyle

• _rawInlineStyle: string

Inherited from QMenu._rawInlineStyle

native

• native: NativeElement | null

Inherited from Component.native

type

• type: string

Inherited from QMenu.type

Methods

_id

▸ _id(): number

Inherited from QObject._id

Get an ID identifying the underlying C++ object.

This can be useful when debugging memory problems with help from setLogCreateQObject() and setLogDestroyQObject(). The number is hash of the memory address of the C++ object.

Returns: number

a unique number which is valid for the lifetime of the C++ object.

acceptDrops

▸ acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean

acceptRichText

▸ acceptRichText(): boolean

Returns: boolean

accessibleDescription

▸ accessibleDescription(): string

Inherited from QMenu.accessibleDescription

Returns: string

accessibleName

▸ accessibleName(): string

Inherited from QMenu.accessibleName

Returns: string

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], options?: EventListenerOptions): 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
`options?`	EventListenerOptions	Extra optional options controlling how this event listener is added.

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, options?: EventListenerOptions): void

Inherited from EventWidget.addEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

Extra optional options controlling how this event listener is added.

For example in the case of QPushButton:

const button = new QPushButton();
button.addEventListener(WidgetEventTypes.HoverEnter,()=>console.log("hovered"));

Returns: void

adjustSize

▸ adjustSize(): void

Inherited from QMenu.adjustSize

Returns: void

alignment

▸ alignment(): AlignmentFlag

Returns: AlignmentFlag

append

▸ append(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

autoFillBackground

▸ autoFillBackground(): boolean

Inherited from QMenu.autoFillBackground

Returns: boolean

autoFormatting

▸ autoFormatting(): AutoFormattingFlag

Returns: AutoFormattingFlag

baseSize

▸ baseSize(): QSize

Inherited from QMenu.baseSize

Returns: QSize

canPaste

▸ canPaste(): boolean

Returns: boolean

childAt

▸ childAt(x: number, y: number): QWidget

Inherited from QMenu.childAt

Parameters:

Name	Type
`x`	number
`y`	number

Returns: QWidget

children

▸ children(): QObject[]

Inherited from QObject.children

Returns: QObject[]

childrenRect

▸ childrenRect(): QRect

Inherited from QMenu.childrenRect

Returns: QRect

clear

▸ clear(): void

Returns: void

clearFocus

▸ clearFocus(): void

Inherited from QMenu.clearFocus

Returns: void

clearMask

▸ clearMask(): void

Inherited from QMenu.clearMask

Returns: void

close

▸ close(): boolean

Inherited from QMenu.close

Returns: boolean

colorCount

▸ colorCount(): number

Inherited from QMenu.colorCount

Returns: number

contentsRect

▸ contentsRect(): QRect

Inherited from QMenu.contentsRect

Returns: QRect

contextMenuPolicy

▸ contextMenuPolicy(): ContextMenuPolicy

Inherited from QMenu.contextMenuPolicy

Returns: ContextMenuPolicy

copy

▸ copy(): void

Returns: void

currentFont

▸ currentFont(): QFont

Returns: QFont

cursorWidth

▸ cursorWidth(): number

Returns: number

cut

▸ cut(): void

Returns: void

delete

▸ delete(): void

Inherited from QObject.delete

Returns: void

deleteLater

▸ deleteLater(): void

Inherited from QObject.deleteLater

Returns: void

depth

▸ depth(): number

Inherited from QMenu.depth

Returns: number

devicePixelRatio

▸ devicePixelRatio(): number

Inherited from QMenu.devicePixelRatio

Returns: number

devicePixelRatioF

▸ devicePixelRatioF(): number

Inherited from QMenu.devicePixelRatioF

Returns: number

documentTitle

▸ documentTitle(): string

Returns: string

dumpObjectInfo

▸ dumpObjectInfo(): void

Inherited from QObject.dumpObjectInfo

Returns: void

dumpObjectTree

▸ dumpObjectTree(): void

Inherited from QObject.dumpObjectTree

Returns: void

ensureCursorVisible

▸ ensureCursorVisible(): void

Returns: void

ensurePolished

▸ ensurePolished(): void

Inherited from QMenu.ensurePolished

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.

focusProxy

▸ focusProxy(): QWidget

Inherited from QMenu.focusProxy

Returns: QWidget

focusWidget

▸ focusWidget(): QWidget

Inherited from QMenu.focusWidget

Returns: QWidget

font

▸ font(): QFont

Inherited from QMenu.font

Returns: QFont

fontFamily

▸ fontFamily(): string

Returns: string

fontItalic

▸ fontItalic(): boolean

Returns: boolean

fontPointSize

▸ fontPointSize(): number

Returns: number

fontUnderline

▸ fontUnderline(): boolean

Returns: boolean

fontWeight

▸ fontWeight(): number

Returns: number

frameGeometry

▸ frameGeometry(): QRect

Inherited from QMenu.frameGeometry

Returns: QRect

frameRect

▸ frameRect(): QRect

Inherited from QFrame.frameRect

Returns: QRect

frameShadow

▸ frameShadow(): Shadow

Inherited from QFrame.frameShadow

Returns: Shadow

frameShape

▸ frameShape(): Shape

Inherited from QFrame.frameShape

Returns: Shape

frameSize

▸ frameSize(): QSize

Inherited from QMenu.frameSize

Returns: QSize

frameStyle

▸ frameStyle(): number

Inherited from QFrame.frameStyle

Returns: number

frameWidth

▸ frameWidth(): number

Inherited from QFrame.frameWidth

Returns: number

geometry

▸ geometry(): QRect

Inherited from QMenu.geometry

Returns: QRect

getFlexNode

▸ getFlexNode(): FlexNode

Inherited from YogaWidget.getFlexNode

Returns: FlexNode

grab

▸ grab(rect?: QRect): QPixmap

Inherited from QMenu.grab

Parameters:

Name	Type
`rect?`	QRect

Returns: QPixmap

grabKeyboard

▸ grabKeyboard(): void

Inherited from QMenu.grabKeyboard

Returns: void

grabMouse

▸ grabMouse(): void

Inherited from QMenu.grabMouse

Returns: void

hasFocus

▸ hasFocus(): boolean

Inherited from QMenu.hasFocus

Returns: boolean

hasHeightForWidth

▸ hasHeightForWidth(): boolean

Inherited from QMenu.hasHeightForWidth

Returns: boolean

hasMouseTracking

▸ hasMouseTracking(): boolean

Inherited from QMenu.hasMouseTracking

Returns: boolean

hasTabletTracking

▸ hasTabletTracking(): boolean

Inherited from QMenu.hasTabletTracking

Returns: boolean

height

▸ height(): number

Inherited from QMenu.height

Returns: number

heightForWidth

▸ heightForWidth(w: number): number

Inherited from QMenu.heightForWidth

Parameters:

Name	Type
`w`	number

Returns: number

heightMM

▸ heightMM(): number

Inherited from QMenu.heightMM

Returns: number

hide

▸ hide(): void

Inherited from QMenu.hide

Returns: void

horizontalScrollBar

▸ horizontalScrollBar(): QScrollBar

Inherited from QAbstractScrollArea.horizontalScrollBar

Returns: QScrollBar

inherits

▸ inherits(className: string): boolean

Inherited from QObject.inherits

Parameters:

Name	Type
`className`	string

Returns: boolean

inputMethodHints

▸ inputMethodHints(): number

Inherited from QMenu.inputMethodHints

Returns: number

insertHtml

▸ insertHtml(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

insertPlainText

▸ insertPlainText(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

isActiveWindow

▸ isActiveWindow(): boolean

Inherited from QMenu.isActiveWindow

Returns: boolean

isAncestorOf

▸ isAncestorOf(child: QWidget): boolean

Inherited from QMenu.isAncestorOf

Parameters:

Name	Type
`child`	QWidget

Returns: boolean

isEnabled

▸ isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean

isEnabledTo

▸ isEnabledTo(ancestor: QWidget): boolean

Inherited from QMenu.isEnabledTo

Parameters:

Name	Type
`ancestor`	QWidget

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

isReadOnly

▸ isReadOnly(): boolean

Returns: boolean

isUndoRedoEnabled

▸ isUndoRedoEnabled(): boolean

Returns: boolean

isVisible

▸ isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean

isVisibleTo

▸ isVisibleTo(ancestor: QWidget): boolean

Inherited from QMenu.isVisibleTo

Parameters:

Name	Type
`ancestor`	QWidget

Returns: boolean

isWindow

▸ isWindow(): boolean

Inherited from QMenu.isWindow

Returns: boolean

isWindowModified

▸ isWindowModified(): boolean

Inherited from QMenu.isWindowModified

Returns: boolean

killTimer

▸ killTimer(timerId: number): void

Inherited from QObject.killTimer

Parameters:

Name	Type
`timerId`	number

Returns: void

layout

▸ layout(): QLayout | null

Inherited from QMenu.layout

Returns: QLayout | null

lineWidth

▸ lineWidth(): number

Inherited from QFrame.lineWidth

Returns: number

lineWrapColumnOrWidth

▸ lineWrapColumnOrWidth(): number

Returns: number

lineWrapMode

▸ lineWrapMode(): QTextEditLineWrapMode

Returns: QTextEditLineWrapMode

logicalDpiX

▸ logicalDpiX(): number

Inherited from QMenu.logicalDpiX

Returns: number

logicalDpiY

▸ logicalDpiY(): number

Inherited from QMenu.logicalDpiY

Returns: number

lower

▸ lower(): void

Inherited from QMenu.lower

Returns: void

mapFrom

▸ mapFrom(parent: QWidget, pos: QPoint): QPoint

Inherited from QMenu.mapFrom

Parameters:

Name	Type
`parent`	QWidget
`pos`	QPoint

Returns: QPoint

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

mapTo

▸ mapTo(parent: QWidget, pos: QPoint): QPoint

Inherited from QMenu.mapTo

Parameters:

Name	Type
`parent`	QWidget
`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

maximumHeight

▸ maximumHeight(): number

Inherited from QMenu.maximumHeight

Returns: number

maximumSize

▸ maximumSize(): QSize

Inherited from QMenu.maximumSize

Returns: QSize

maximumViewportSize

▸ maximumViewportSize(): QSize

Inherited from QAbstractScrollArea.maximumViewportSize

Returns: QSize

maximumWidth

▸ maximumWidth(): number

Inherited from QMenu.maximumWidth

Returns: number

midLineWidth

▸ midLineWidth(): number

Inherited from QFrame.midLineWidth

Returns: number

minimumHeight

▸ minimumHeight(): number

Inherited from QMenu.minimumHeight

Returns: number

minimumSize

▸ minimumSize(): QSize

Inherited from QMenu.minimumSize

Returns: QSize

minimumSizeHint

▸ minimumSizeHint(): QSize

Inherited from QMenu.minimumSizeHint

Returns: QSize

minimumWidth

▸ minimumWidth(): number

Inherited from QMenu.minimumWidth

Returns: number

move

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

Inherited from QMenu.move

Parameters:

Name	Type
`x`	number
`y`	number

Returns: void

nativeParentWidget

▸ nativeParentWidget(): QWidget

Inherited from QMenu.nativeParentWidget

Returns: QWidget

nextInFocusChain

▸ nextInFocusChain(): QWidget

Inherited from QMenu.nextInFocusChain

Returns: QWidget

normalGeometry

▸ normalGeometry(): QRect

Inherited from QMenu.normalGeometry

Returns: QRect

objectName

▸ objectName(): string

Inherited from QObject.objectName

Returns: string

overwriteMode

▸ overwriteMode(): boolean

Returns: boolean

paintingActive

▸ paintingActive(): boolean

Inherited from QMenu.paintingActive

Returns: boolean

parent

▸ parent(): QObject

Inherited from QObject.parent

Returns: QObject

parentWidget

▸ parentWidget(): QWidget

Inherited from QMenu.parentWidget

Returns: QWidget

paste

▸ paste(): void

Returns: void

physicalDpiX

▸ physicalDpiX(): number

Inherited from QMenu.physicalDpiX

Returns: number

physicalDpiY

▸ physicalDpiY(): number

Inherited from QMenu.physicalDpiY

Returns: number

placeholderText

▸ placeholderText(): string

Returns: string

pos

▸ pos(): object

Inherited from QMenu.pos

Returns: object

x: number
y: number

previousInFocusChain

▸ previousInFocusChain(): QWidget

Inherited from QMenu.previousInFocusChain

Returns: QWidget

property

▸ property(name: string): QVariant

Inherited from QObject.property

Parameters:

Name	Type
`name`	string

Returns: QVariant

raise

▸ raise(): void

Inherited from QMenu.raise

Returns: void

rect

▸ rect(): QRect

Inherited from QMenu.rect

Returns: QRect

redo

▸ redo(): void

Returns: void

releaseKeyboard

▸ releaseKeyboard(): void

Inherited from QMenu.releaseKeyboard

Returns: void

releaseMouse

▸ releaseMouse(): void

Inherited from QMenu.releaseMouse

Returns: void

releaseShortcut

▸ releaseShortcut(id: number): void

Inherited from QMenu.releaseShortcut

Parameters:

Name	Type
`id`	number

Returns: void

removeAction

▸ removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

Name	Type
`action`	QAction

Returns: void

removeEventListener

▸ removeEventListener‹SignalType›(signalType: SignalType, callback: Signals[SignalType], options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Type parameters:

▪ SignalType: keyof Signals

Parameters:

Name	Type
`signalType`	SignalType
`callback`	Signals[SignalType]
`options?`	EventListenerOptions

Returns: void

▸ removeEventListener(eventType: WidgetEventTypes, callback: function, options?: EventListenerOptions): void

Inherited from EventWidget.removeEventListener

Parameters:

▪ eventType: WidgetEventTypes

▪ callback: function

▸ (event?: NativeRawPointer‹"QEvent"›): void

Parameters:

Name	Type
`event?`	NativeRawPointer‹"QEvent"›

▪Optional options: EventListenerOptions

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

scrollToAnchor

▸ scrollToAnchor(name: string): void

Parameters:

Name	Type
`name`	string

Returns: void

selectAll

▸ selectAll(): void

Returns: void

setAcceptDrops

▸ setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

Name	Type
`on`	boolean

Returns: void

setAcceptRichText

▸ setAcceptRichText(accept: boolean): void

Parameters:

Name	Type
`accept`	boolean

Returns: void

setAccessibleDescription

▸ setAccessibleDescription(description: string): void

Inherited from QMenu.setAccessibleDescription

Parameters:

Name	Type
`description`	string

Returns: void

setAccessibleName

▸ setAccessibleName(name: string): void

Inherited from QMenu.setAccessibleName

Parameters:

Name	Type
`name`	string

Returns: void

setAlignment

▸ setAlignment(alignment: AlignmentFlag): void

Parameters:

Name	Type
`alignment`	AlignmentFlag

Returns: void

setAttribute

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

Inherited from QMenu.setAttribute

Parameters:

Name	Type
`attribute`	WidgetAttribute
`switchOn`	boolean

Returns: void

setAutoFillBackground

▸ setAutoFillBackground(enabled: boolean): void

Inherited from QMenu.setAutoFillBackground

Parameters:

Name	Type
`enabled`	boolean

Returns: void

setAutoFormatting

▸ setAutoFormatting(features: AutoFormattingFlag): void

Parameters:

Name	Type
`features`	AutoFormattingFlag

Returns: void

setBaseSize

▸ setBaseSize(size: QSize): void

Inherited from QMenu.setBaseSize

Parameters:

Name	Type
`size`	QSize

Returns: void

setContentsMargins

▸ setContentsMargins(left: number, top: number, right: number, bottom: number): void

Inherited from QMenu.setContentsMargins

Parameters:

Name	Type
`left`	number
`top`	number
`right`	number
`bottom`	number

Returns: void

setContextMenuPolicy

▸ setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

Name	Type
`contextMenuPolicy`	ContextMenuPolicy

Returns: void

setCurrentFont

▸ setCurrentFont(f: QFont): void

Parameters:

Name	Type
`f`	QFont

Returns: void

setCursor

▸ setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

Name	Type
`cursor`	CursorShape \| QCursor

Returns: void

setCursorWidth

▸ setCursorWidth(width: number): void

Parameters:

Name	Type
`width`	number

Returns: void

setDisabled

▸ setDisabled(disable: boolean): void

Inherited from QMenu.setDisabled

Parameters:

Name	Type
`disable`	boolean

Returns: void

setDocumentTitle

▸ setDocumentTitle(title: string): void

Parameters:

Name	Type
`title`	string

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

setFixedHeight

▸ setFixedHeight(h: number): void

Inherited from QMenu.setFixedHeight

Parameters:

Name	Type
`h`	number

Returns: void

setFixedSize

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

Inherited from QMenu.setFixedSize

Parameters:

Name	Type
`width`	number
`height`	number

Returns: void

setFixedWidth

▸ setFixedWidth(w: number): void

Inherited from QMenu.setFixedWidth

Parameters:

Name	Type
`w`	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

setFocusProxy

▸ setFocusProxy(widget: QWidget): void

Inherited from QMenu.setFocusProxy

Parameters:

Name	Type
`widget`	QWidget

Returns: void

setFont

▸ setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

Name	Type
`font`	QFont

Returns: void

setFontFamily

▸ setFontFamily(family: string): void

Parameters:

Name	Type
`family`	string

Returns: void

setFontItalic

▸ setFontItalic(italic: boolean): void

Parameters:

Name	Type
`italic`	boolean

Returns: void

setFontPointSize

▸ setFontPointSize(s: number): void

Parameters:

Name	Type
`s`	number

Returns: void

setFontUnderline

▸ setFontUnderline(underline: boolean): void

Parameters:

Name	Type
`underline`	boolean

Returns: void

setFontWeight

▸ setFontWeight(weight: number): void

Parameters:

Name	Type
`weight`	number

Returns: void

setFrameRect

▸ setFrameRect(r: QRect): void

Inherited from QFrame.setFrameRect

Parameters:

Name	Type
`r`	QRect

Returns: void

setFrameShadow

▸ setFrameShadow(type: Shadow): void

Inherited from QFrame.setFrameShadow

Parameters:

Name	Type
`type`	Shadow

Returns: void

setFrameShape

▸ setFrameShape(type: Shape): void

Inherited from QFrame.setFrameShape

Parameters:

Name	Type
`type`	Shape

Returns: void

setFrameStyle

▸ setFrameStyle(style: number): void

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

setHorizontalScrollBar

▸ setHorizontalScrollBar(scrollBar: QScrollBar): void

Inherited from QAbstractScrollArea.setHorizontalScrollBar

Parameters:

Name	Type
`scrollBar`	QScrollBar

Returns: void

setHorizontalScrollBarPolicy

▸ setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

Name	Type
`policy`	ScrollBarPolicy

Returns: void

setHtml

▸ setHtml(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

setInlineStyle

▸ setInlineStyle(style: string, postprocess: boolean): void

Inherited from QMenu.setInlineStyle

Parameters:

Name	Type	Default
`style`	string	-
`postprocess`	boolean	true

Returns: void

setInputMethodHints

▸ setInputMethodHints(hints: number): void

Inherited from QMenu.setInputMethodHints

Parameters:

Name	Type
`hints`	number

Returns: void

setLayout

▸ setLayout(layout: QLayout): void

Inherited from QMenu.setLayout

Parameters:

Name	Type
`layout`	QLayout

Returns: void

setLineWidth

▸ setLineWidth(width: number): void

Inherited from QFrame.setLineWidth

Parameters:

Name	Type
`width`	number

Returns: void

setLineWrapColumnOrWidth

▸ setLineWrapColumnOrWidth(w: number): void

Parameters:

Name	Type
`w`	number

Returns: void

setLineWrapMode

▸ setLineWrapMode(mode: QTextEditLineWrapMode): void

Parameters:

Name	Type
`mode`	QTextEditLineWrapMode

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 QFrame.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

setObjectName

▸ setObjectName(objectName: string): void

Inherited from QMenu.setObjectName

Overrides QObject.setObjectName

Parameters:

Name	Type
`objectName`	string

Returns: void

setOverwriteMode

▸ setOverwriteMode(overwrite: boolean): void

Parameters:

Name	Type
`overwrite`	boolean

Returns: void

setParent

▸ setParent(parent: QObject): void

Inherited from QObject.setParent

Parameters:

Name	Type
`parent`	QObject

Returns: void

setPlaceholderText

▸ setPlaceholderText(placeholderText: string): void

Parameters:

Name	Type
`placeholderText`	string

Returns: void

setPlainText

▸ setPlainText(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

setProperty

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

Inherited from QObject.setProperty

Parameters:

Name	Type
`name`	string
`value`	QVariantType

Returns: boolean

setReadOnly

▸ setReadOnly(ro: boolean): void

Parameters:

Name	Type
`ro`	boolean

Returns: void

setShortcutAutoRepeat

▸ setShortcutAutoRepeat(id: number, enable: boolean): void

Inherited from QMenu.setShortcutAutoRepeat

Parameters:

Name	Type	Default
`id`	number	-
`enable`	boolean	true

Returns: void

setShortcutEnabled

▸ setShortcutEnabled(id: number, enable: boolean): void

Inherited from QMenu.setShortcutEnabled

Parameters:

Name	Type	Default
`id`	number	-
`enable`	boolean	true

Returns: void

setSizeIncrement

▸ setSizeIncrement(w_or_size: QSize | number, h: number): void

Inherited from QMenu.setSizeIncrement

Parameters:

Name	Type	Default
`w_or_size`	QSize \| number	-
`h`	number	0

Returns: void

setSizePolicy

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

Inherited from QMenu.setSizePolicy

Parameters:

Name	Type
`horizontal`	QSizePolicyPolicy
`vertical`	QSizePolicyPolicy

Returns: void

setStatusTip

▸ setStatusTip(statusTip: string): void

Inherited from QMenu.setStatusTip

Parameters:

Name	Type
`statusTip`	string

Returns: void

setStyleSheet

▸ setStyleSheet(styleSheet: string, postprocess: boolean): void

Inherited from QMenu.setStyleSheet

Parameters:

Name	Type	Default
`styleSheet`	string	-
`postprocess`	boolean	true

Returns: void

setTabChangesFocus

▸ setTabChangesFocus(b: boolean): void

Parameters:

Name	Type
`b`	boolean

Returns: void

setTabStopDistance

▸ setTabStopDistance(distance: number): void

Parameters:

Name	Type
`distance`	number

Returns: void

setTabletTracking

▸ setTabletTracking(enable: boolean): void

Inherited from QMenu.setTabletTracking

Parameters:

Name	Type
`enable`	boolean

Returns: void

setText

▸ setText(text: string): void

Parameters:

Name	Type
`text`	string

Returns: void

setTextBackgroundColor

▸ setTextBackgroundColor(color: QColor): void

Parameters:

Name	Type
`color`	QColor

Returns: void

setTextColor

▸ setTextColor(color: QColor): void

Parameters:

Name	Type
`color`	QColor

Returns: void

setTextInteractionFlags

▸ setTextInteractionFlags(flags: TextInteractionFlag): void

Parameters:

Name	Type
`flags`	TextInteractionFlag

Returns: void

setToolTip

▸ setToolTip(text: string): void

Inherited from QMenu.setToolTip

Parameters:

Name	Type
`text`	string

Returns: void

setToolTipDuration

▸ setToolTipDuration(msec: number): void

Inherited from QMenu.setToolTipDuration

Parameters:

Name	Type
`msec`	number

Returns: void

setUndoRedoEnabled

▸ setUndoRedoEnabled(enable: boolean): void

Parameters:

Name	Type
`enable`	boolean

Returns: void

setUpdatesEnabled

▸ setUpdatesEnabled(enable: boolean): void

Inherited from QMenu.setUpdatesEnabled

Parameters:

Name	Type
`enable`	boolean

Returns: void

setVerticalScrollBar

▸ setVerticalScrollBar(scrollBar: QScrollBar): void

Inherited from QAbstractScrollArea.setVerticalScrollBar

Parameters:

Name	Type
`scrollBar`	QScrollBar

Returns: void

setVerticalScrollBarPolicy

▸ setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

Name	Type
`policy`	ScrollBarPolicy

Returns: void

setViewport

▸ setViewport(widget: QWidget): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

Name	Type
`widget`	QWidget

Returns: void

setVisible

▸ setVisible(visible: boolean): void

Inherited from QMenu.setVisible

Parameters:

Name	Type
`visible`	boolean

Returns: void

setWhatsThis

▸ setWhatsThis(whatsThis: string): void

Inherited from QMenu.setWhatsThis

Parameters:

Name	Type
`whatsThis`	string

Returns: void

setWindowFilePath

▸ setWindowFilePath(filePath: string): void

Inherited from QMenu.setWindowFilePath

Parameters:

Name	Type
`filePath`	string

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

setWindowRole

▸ setWindowRole(role: string): void

Inherited from QMenu.setWindowRole

Parameters:

Name	Type
`role`	string

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

setWordWrapMode

▸ setWordWrapMode(policy: WrapMode): void

Parameters:

Name	Type
`policy`	WrapMode

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

sizeHint

▸ sizeHint(): QSize

Inherited from QMenu.sizeHint

Returns: QSize

sizeIncrement

▸ sizeIncrement(): QSize

Inherited from QMenu.sizeIncrement

Returns: QSize

stackUnder

▸ stackUnder(w: QWidget): void

Inherited from QMenu.stackUnder

Parameters:

Name	Type
`w`	QWidget

Returns: void

startTimer

▸ startTimer(intervalMS: number, timerType: TimerType): number

Inherited from QObject.startTimer

Parameters:

Name	Type	Default
`intervalMS`	number	-
`timerType`	TimerType	TimerType.CoarseTimer

Returns: number

statusTip

▸ statusTip(): string

Inherited from QMenu.statusTip

Returns: string

style

▸ style(): QStyle

Inherited from QMenu.style

Returns: QStyle

styleSheet

▸ styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string

tabChangesFocus

▸ tabChangesFocus(): boolean

Returns: boolean

tabStopDistance

▸ tabStopDistance(): number

Returns: number

testAttribute

▸ testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name	Type
`attribute`	WidgetAttribute

Returns: boolean

textInteractionFlags

▸ textInteractionFlags(): TextInteractionFlag

Returns: TextInteractionFlag

toHtml

▸ toHtml(): string

Returns: string

toPlainText

▸ toPlainText(): string

Returns: string

▸ toolTip(): string

Inherited from QMenu.toolTip

Returns: string

toolTipDuration

▸ toolTipDuration(): number

Inherited from QMenu.toolTipDuration

Returns: number

underMouse

▸ underMouse(): boolean

Inherited from QMenu.underMouse

Returns: boolean

undo

▸ undo(): void

Returns: void

unsetCursor

▸ unsetCursor(): void

Inherited from QMenu.unsetCursor

Returns: void

unsetLayoutDirection

▸ unsetLayoutDirection(): void

Inherited from QMenu.unsetLayoutDirection

Returns: void

unsetLocale

▸ unsetLocale(): void

Inherited from QMenu.unsetLocale

Returns: void

update

▸ update(): void

Inherited from QMenu.update

Returns: void

updateGeometry

▸ updateGeometry(): void

Inherited from QMenu.updateGeometry

Returns: void

updateMicroFocus

▸ updateMicroFocus(query: number): void

Inherited from QMenu.updateMicroFocus

Parameters:

Name	Type	Default
`query`	number	InputMethodQuery.ImQueryAll

Returns: void

updatesEnabled

▸ updatesEnabled(): boolean

Inherited from QMenu.updatesEnabled

Returns: boolean

verticalScrollBar

▸ verticalScrollBar(): QScrollBar

Inherited from QAbstractScrollArea.verticalScrollBar

Returns: QScrollBar

viewport

▸ viewport(): QWidget

Inherited from QAbstractScrollArea.viewport

Returns: QWidget

whatsThis

▸ whatsThis(): string

Inherited from QMenu.whatsThis

Returns: string

width

▸ width(): number

Inherited from QMenu.width

Returns: number

widthMM

▸ widthMM(): number

Inherited from QMenu.widthMM

Returns: number

winId

▸ winId(): number

Inherited from QMenu.winId

Returns: number

window

▸ window(): QWidget

Inherited from QMenu.window

Returns: QWidget

windowFilePath

▸ windowFilePath(): string

Inherited from QMenu.windowFilePath

Returns: string

windowHandle

▸ windowHandle(): QWindow | null

Inherited from QMenu.windowHandle

Returns: QWindow | null

windowIcon

▸ windowIcon(): QIcon

Inherited from QMenu.windowIcon

Returns: QIcon

windowOpacity

▸ windowOpacity(): number

Inherited from QMenu.windowOpacity

Returns: number

windowRole

▸ windowRole(): string

Inherited from QMenu.windowRole

Returns: string

windowState

▸ windowState(): WindowState

Inherited from QMenu.windowState

Returns: WindowState

windowTitle

▸ windowTitle(): string

Inherited from QMenu.windowTitle

Returns: string

wordWrapMode

▸ wordWrapMode(): WrapMode

Returns: WrapMode

x

▸ x(): number

Inherited from QMenu.x

Returns: number

y

▸ y(): number

Inherited from QMenu.y

Returns: number

zommIn

▸ zommIn(range: number): void

Parameters:

Name	Type	Default
`range`	number	1

Returns: void

zoomOut

▸ zoomOut(range: number): void

Parameters:

Name	Type	Default
`range`	number	1

Returns: void

Example​

Type parameters​

Hierarchy​

Index​

Constructors​

Properties​

Methods​

Constructors​

constructor​

Properties​

_rawInlineStyle​

native​

type​

Methods​

_id​

acceptDrops​

acceptRichText​

accessibleDescription​

accessibleName​

activateWindow​

addAction​

addEventListener​

adjustSize​

alignment​

append​

autoFillBackground​

autoFormatting​

baseSize​

canPaste​

childAt​

children​

childrenRect​

clear​

clearFocus​

clearMask​

close​

colorCount​

contentsRect​

contextMenuPolicy​

copy​

currentFont​

cursorWidth​

cut​

delete​

deleteLater​

depth​

devicePixelRatio​

devicePixelRatioF​

documentTitle​

dumpObjectInfo​

dumpObjectTree​

ensureCursorVisible​

ensurePolished​

eventProcessed​

focusProxy​

focusWidget​

font​

fontFamily​

fontItalic​

fontPointSize​

fontUnderline​

fontWeight​

frameGeometry​

frameRect​

frameShadow​

frameShape​

frameSize​

frameStyle​

frameWidth​

geometry​

getFlexNode​

grab​

grabKeyboard​

grabMouse​

hasFocus​

hasHeightForWidth​

hasMouseTracking​

hasTabletTracking​

height​

heightForWidth​

Example

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_rawInlineStyle

native

type

Methods

_id

acceptDrops

acceptRichText

accessibleDescription

accessibleName

activateWindow

addAction

addEventListener

adjustSize

alignment

append

autoFillBackground

autoFormatting

baseSize

canPaste

childAt

children

childrenRect

clear

clearFocus

clearMask

close

colorCount

contentsRect

contextMenuPolicy

copy

currentFont

cursorWidth

cut

delete

deleteLater

depth

devicePixelRatio

devicePixelRatioF

documentTitle

dumpObjectInfo

dumpObjectTree

ensureCursorVisible

ensurePolished

eventProcessed

focusProxy

focusWidget

font

fontFamily

fontItalic

fontPointSize

fontUnderline

fontWeight

frameGeometry

frameRect

frameShadow

frameShape

frameSize

frameStyle

frameWidth

geometry

getFlexNode

grab

grabKeyboard

grabMouse

hasFocus

hasHeightForWidth

hasMouseTracking

hasTabletTracking

height

heightForWidth