plastichub/nodeguy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
11bf45466d
nodeguy/website/docs/api/generated/classes/nodetextedit.md
Atul R e6d01fc7f5 update docs
2021-07-09 01:04:06 +02:00

42 KiB
Raw Blame History

id title sidebar_label
nodetextedit NodeTextEdit 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

Accessors

Methods

Constructors

constructor

+ new NodeTextEdit(native: NativeElement): NodeTextEdit

Inherited from NodeWidget.constructor

Overrides EventWidget.constructor

Parameters:

Name Type
native NativeElement

Returns: NodeTextEdit

Properties

Optional _layout

• _layout? : NodeLayout‹Signals›

Inherited from QMenu._layout

_rawInlineStyle

• _rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle

actions

• actions: Set‹QAction›

Inherited from QMenu.actions

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

Accessors

layout

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

Inherited from QMenu.layout

Returns: NodeLayout‹Signals› | undefined

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

Inherited from QMenu.layout

Parameters:

Name Type
l NodeLayout‹Signals› | undefined

Returns: void

Methods

acceptDrops

▸ acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean

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:

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

alignment

▸ alignment(): AlignmentFlag

Returns: AlignmentFlag

append

▸ append(text: string): void

Parameters:

Name Type
text string

Returns: void

autoFormatting

▸ autoFormatting(): AutoFormattingFlag

Returns: AutoFormattingFlag

canPaste

▸ canPaste(): boolean

Returns: boolean

clear

▸ clear(): void

Returns: void

clearFocus

▸ clearFocus(): void

Inherited from QMenu.clearFocus

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:

Name Type
className string

Returns: boolean

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

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:

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

maximumViewportSize

▸ maximumViewportSize(): QSize

Inherited from QAbstractScrollArea.maximumViewportSize

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

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:

Name Type
name string

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:

Name Type
action QAction

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

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

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

setAutoFormatting

▸ setAutoFormatting(features: AutoFormattingFlag): void

Parameters:

Name Type
features AutoFormattingFlag

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

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

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

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

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

setLineWidth

▸ setLineWidth(width: number): void

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

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

setOverwriteMode

▸ setOverwriteMode(overwrite: boolean): void

Parameters:

Name Type
overwrite boolean

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 NodeObject.setProperty

Parameters:

Name Type
name string
value QVariantType

Returns: boolean

setReadOnly

▸ setReadOnly(ro: boolean): void

Parameters:

Name Type
ro boolean

Returns: void

setStyleSheet

▸ setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name Type
styleSheet string

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

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

setUndoRedoEnabled

▸ setUndoRedoEnabled(enable: boolean): void

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: NodeWidget‹any›): void

Inherited from QAbstractScrollArea.setViewport

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

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

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

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:

Name Type Default
range number 1

Returns: void

zoomOut

▸ zoomOut(range: number): void

Parameters:

Name Type Default
range number 1

Returns: void