NodeTextEdit

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›

NodeTextEdit

QTextEdit

QTextBrowser

Index

Constructors

Properties

Methods

Constructors

constructor

+ new NodeTextEdit(native: NativeElement): NodeTextEdit

Inherited from NodeWidget.constructor

Overrides EventWidget.constructor

Parameters:

NameType
nativeNativeElement

Returns: NodeTextEdit

Properties

_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

actions: Set‹QAction

Inherited from QMenu.actions


Optional layout

layout? : NodeLayout‹Signals›

Inherited from QMenu.layout


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"

Inherited from QMenu.type


Optional viewportWidget

viewportWidget? : NodeWidget‹any›

Inherited from QAbstractScrollArea.viewportWidget

Methods

acceptRichText

acceptRichText(): boolean

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

addEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof Signals

Parameters:

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


append

append(text: string): void

Parameters:

NameType
textstring

Returns: void


autoFormatting

autoFormatting(): AutoFormattingFlag

Returns: AutoFormattingFlag


canPaste

canPaste(): boolean

Returns: boolean


clear

clear(): void

Returns: void


close

close(): boolean

Inherited from QMenu.close

Returns: boolean


copy

copy(): void

Returns: void


currentFont

currentFont(): QFont

Returns: QFont


cursorWidth

cursorWidth(): number

Returns: number


cut

cut(): void

Returns: void


documentTitle

documentTitle(): string

Returns: string


ensureCursorVisible

ensureCursorVisible(): void

Returns: void


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


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


insertHtml

insertHtml(text: string): void

Parameters:

NameType
textstring

Returns: void


insertPlainText

insertPlainText(text: string): void

Parameters:

NameType
textstring

Returns: void


isEnabled

isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean


isReadOnly

isReadOnly(): boolean

Returns: boolean


isUndoRedoEnabled

isUndoRedoEnabled(): boolean

Returns: boolean


isVisible

isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean


lineWidth

lineWidth(): number

Inherited from NodeFrame.lineWidth

Returns: number


lineWrapColumnOrWidth

lineWrapColumnOrWidth(): number

Returns: number


lineWrapMode

lineWrapMode(): QTextEditLineWrapMode

Returns: QTextEditLineWrapMode


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


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


overwriteMode

overwriteMode(): boolean

Returns: boolean


paste

paste(): void

Returns: void


placeholderText

placeholderText(): string

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


redo

redo(): void

Returns: void


removeAction

removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

NameType
actionQAction

Returns: void


removeEventListener

removeEventListener<SignalType>(signalType: SignalType, callback: Signals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof Signals

Parameters:

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


scrollToAnchor

scrollToAnchor(name: string): void

Parameters:

NameType
namestring

Returns: void


selectAll

selectAll(): void

Returns: void


setAcceptRichText

setAcceptRichText(accept: boolean): void

Parameters:

NameType
acceptboolean

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


setAutoFormatting

setAutoFormatting(features: AutoFormattingFlag): void

Parameters:

NameType
featuresAutoFormattingFlag

Returns: void


setContextMenuPolicy

setContextMenuPolicy(contextMenuPolicy: ContextMenuPolicy): void

Inherited from QMenu.setContextMenuPolicy

Parameters:

NameType
contextMenuPolicyContextMenuPolicy

Returns: void


setCurrentFont

setCurrentFont(f: QFont): void

Parameters:

NameType
fQFont

Returns: void


setCursor

setCursor(cursor: CursorShape | QCursor): void

Inherited from QMenu.setCursor

Parameters:

NameType
cursorCursorShape | QCursor

Returns: void


setCursorWidth

setCursorWidth(width: number): void

Parameters:

NameType
widthnumber

Returns: void


setDocumentTitle

setDocumentTitle(title: string): void

Parameters:

NameType
titlestring

Returns: void


setEnabled

setEnabled(enabled: boolean): void

Inherited from QMenu.setEnabled

Parameters:

NameType
enabledboolean

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


setFont

setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

NameType
fontQFont

Returns: void


setFontFamily

setFontFamily(family: string): void

Parameters:

NameType
familystring

Returns: void


setFontItalic

setFontItalic(italic: boolean): void

Parameters:

NameType
italicboolean

Returns: void


setFontPointSize

setFontPointSize(s: number): void

Parameters:

NameType
snumber

Returns: void


setFontUnderline

setFontUnderline(underline: boolean): void

Parameters:

NameType
underlineboolean

Returns: void


setFontWeight

setFontWeight(weight: number): void

Parameters:

NameType
weightnumber

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


setHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

NameType
policyScrollBarPolicy

Returns: void


setHtml

setHtml(text: string): void

Parameters:

NameType
textstring

Returns: void


setInlineStyle

setInlineStyle(style: string): void

Inherited from QMenu.setInlineStyle

Parameters:

NameType
stylestring

Returns: void


setLayout

setLayout(parentLayout: NodeLayout‹Signals›): void

Inherited from QMenu.setLayout

Parameters:

NameType
parentLayoutNodeLayout‹Signals›

Returns: void


setLineWidth

setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

NameType
widthnumber

Returns: void


setLineWrapColumnOrWidth

setLineWrapColumnOrWidth(w: number): void

Parameters:

NameType
wnumber

Returns: void


setLineWrapMode

setLineWrapMode(mode: QTextEditLineWrapMode): void

Parameters:

NameType
modeQTextEditLineWrapMode

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


setOverwriteMode

setOverwriteMode(overwrite: boolean): void

Parameters:

NameType
overwriteboolean

Returns: void


setPlaceholderText

setPlaceholderText(placeholderText: string): void

Parameters:

NameType
placeholderTextstring

Returns: void


setPlainText

setPlainText(text: string): void

Parameters:

NameType
textstring

Returns: void


setProperty

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

Inherited from NodeObject.setProperty

Parameters:

NameType
namestring
valueQVariantType

Returns: boolean


setReadOnly

setReadOnly(ro: boolean): void

Parameters:

NameType
roboolean

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

NameType
styleSheetstring

Returns: void


setTabChangesFocus

setTabChangesFocus(b: boolean): void

Parameters:

NameType
bboolean

Returns: void


setTabStopDistance

setTabStopDistance(distance: number): void

Parameters:

NameType
distancenumber

Returns: void


setText

setText(text: string): void

Parameters:

NameType
textstring

Returns: void


setTextBackgroundColor

setTextBackgroundColor(color: QColor): void

Parameters:

NameType
colorQColor

Returns: void


setTextColor

setTextColor(color: QColor): void

Parameters:

NameType
colorQColor

Returns: void


setTextInteractionFlags

setTextInteractionFlags(flags: TextInteractionFlag): void

Parameters:

NameType
flagsTextInteractionFlag

Returns: void


setUndoRedoEnabled

setUndoRedoEnabled(enable: boolean): void

Parameters:

NameType
enableboolean

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


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


setWordWrapMode

setWordWrapMode(policy: WrapMode): void

Parameters:

NameType
policyWrapMode

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


tabChangesFocus

tabChangesFocus(): boolean

Returns: boolean


tabStopDistance

tabStopDistance(): number

Returns: number


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

NameType
attributeWidgetAttribute

Returns: boolean


textInteractionFlags

textInteractionFlags(): TextInteractionFlag

Returns: TextInteractionFlag


toHtml

toHtml(): string

Returns: string


toPlainText

toPlainText(): string

Returns: string


undo

undo(): void

Returns: void


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


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


wordWrapMode

wordWrapMode(): WrapMode

Returns: WrapMode


zommIn

zommIn(range: number): void

Parameters:

NameTypeDefault
rangenumber1

Returns: void


zoomOut

zoomOut(range: number): void

Parameters:

NameTypeDefault
rangenumber1

Returns: void