nodeguy/website/docs/api/generated/classes/qtextbrowser.md
2020-06-26 17:05:02 +02:00

48 KiB
Raw Blame History

id title sidebar_label
qtextbrowser QTextBrowser QTextBrowser

Create and control text browser.

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

A QTextBrowser provides ability to add and manipulate native text browser widgets.

Example

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

const textBrowser = new QTextBrowser();

Hierarchy

NodeTextEditQTextBrowserSignals

QTextBrowser

Index

Constructors

Properties

Methods

Constructors

constructor

+ new QTextBrowser(): QTextBrowser

Overrides NodeWidget.constructor

Returns: QTextBrowser

+ new QTextBrowser(parent: NodeWidgetany): QTextBrowser

Overrides NodeWidget.constructor

Parameters:

Name Type
parent NodeWidgetany

Returns: QTextBrowser

Properties

_rawInlineStyle

_rawInlineStyle: string = ""

Inherited from QMenu._rawInlineStyle


actions

actions: SetQAction

Inherited from QMenu.actions


Optional layout

layout? : NodeLayoutQTextBrowserSignals

Inherited from QMenu.layout


native

native: NativeElement

Overrides Component.native


nodeChildren

nodeChildren: SetComponent

Inherited from Component.nodeChildren


Optional nodeParent

nodeParent? : Component

Inherited from Component.nodeParent


type

type: string = "widget"

Inherited from QMenu.type


Optional viewportWidget

viewportWidget? : NodeWidgetany

Inherited from QAbstractScrollArea.viewportWidget

Methods

acceptDrops

acceptDrops(): boolean

Inherited from QMenu.acceptDrops

Returns: boolean


acceptRichText

acceptRichText(): boolean

Inherited from NodeTextEdit.acceptRichText

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

addEventListenerSignalType(signalType: SignalType, callback: QTextBrowserSignals[SignalType]): void

Inherited from EventWidget.addEventListener

Type parameters:

SignalType: keyof QTextBrowserSignals

Parameters:

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

Inherited from NodeTextEdit.alignment

Returns: AlignmentFlag


append

append(text: string): void

Inherited from NodeTextEdit.append

Parameters:

Name Type
text string

Returns: void


autoFormatting

autoFormatting(): AutoFormattingFlag

Inherited from NodeTextEdit.autoFormatting

Returns: AutoFormattingFlag


backward

backward(): void

Returns: void


backwardHistoryCount

backwardHistoryCount(): number

Returns: number


canPaste

canPaste(): boolean

Inherited from NodeTextEdit.canPaste

Returns: boolean


clear

clear(): void

Inherited from NodeTextEdit.clear

Returns: void


clearHistory

clearHistory(): void

Returns: void


close

close(): boolean

Inherited from QMenu.close

Returns: boolean


copy

copy(): void

Inherited from NodeTextEdit.copy

Returns: void


currentFont

currentFont(): QFont

Inherited from NodeTextEdit.currentFont

Returns: QFont


cursorWidth

cursorWidth(): number

Inherited from NodeTextEdit.cursorWidth

Returns: number


cut

cut(): void

Inherited from NodeTextEdit.cut

Returns: void


documentTitle

documentTitle(): string

Inherited from NodeTextEdit.documentTitle

Returns: string


ensureCursorVisible

ensureCursorVisible(): void

Inherited from NodeTextEdit.ensureCursorVisible

Returns: void


font

font(): QFont

Inherited from QMenu.font

Returns: QFont


fontFamily

fontFamily(): string

Inherited from NodeTextEdit.fontFamily

Returns: string


fontItalic

fontItalic(): boolean

Inherited from NodeTextEdit.fontItalic

Returns: boolean


fontPointSize

fontPointSize(): number

Inherited from NodeTextEdit.fontPointSize

Returns: number


fontUnderline

fontUnderline(): boolean

Inherited from NodeTextEdit.fontUnderline

Returns: boolean


fontWeight

fontWeight(): number

Inherited from NodeTextEdit.fontWeight

Returns: number


forward

forward(): void

Returns: void


forwardHistoryCount

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


historyTitle

historyTitle(i: number): string

Parameters:

Name Type
i number

Returns: string


historyUrl

historyUrl(): QUrl

Returns: QUrl


home

home(): void

Returns: void


inherits

inherits(className: string): boolean

Inherited from NodeObject.inherits

Parameters:

Name Type
className string

Returns: boolean


insertHtml

insertHtml(text: string): void

Inherited from NodeTextEdit.insertHtml

Parameters:

Name Type
text string

Returns: void


insertPlainText

insertPlainText(text: string): void

Inherited from NodeTextEdit.insertPlainText

Parameters:

Name Type
text string

Returns: void


isBackwardAvailable

isBackwardAvailable(): boolean

Returns: boolean


isEnabled

isEnabled(): boolean

Inherited from QMenu.isEnabled

Returns: boolean


isForwardAvailable

isForwardAvailable(): boolean

Returns: boolean


isReadOnly

isReadOnly(): boolean

Inherited from NodeTextEdit.isReadOnly

Returns: boolean


isUndoRedoEnabled

isUndoRedoEnabled(): boolean

Inherited from NodeTextEdit.isUndoRedoEnabled

Returns: boolean


isVisible

isVisible(): boolean

Inherited from QMenu.isVisible

Returns: boolean


lineWidth

lineWidth(): number

Inherited from NodeFrame.lineWidth

Returns: number


lineWrapColumnOrWidth

lineWrapColumnOrWidth(): number

Inherited from NodeTextEdit.lineWrapColumnOrWidth

Returns: number


lineWrapMode

lineWrapMode(): QTextEditLineWrapMode

Inherited from NodeTextEdit.lineWrapMode

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


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


openExternalLinks(): boolean

Returns: boolean


openLinks(): boolean

Returns: boolean


overwriteMode

overwriteMode(): boolean

Inherited from NodeTextEdit.overwriteMode

Returns: boolean


paste

paste(): void

Inherited from NodeTextEdit.paste

Returns: void


placeholderText

placeholderText(): string

Inherited from NodeTextEdit.placeholderText

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

Inherited from NodeTextEdit.redo

Returns: void


reload

reload(): void

Returns: void


removeAction

removeAction(action: QAction): void

Inherited from QMenu.removeAction

Parameters:

Name Type
action QAction

Returns: void


removeEventListener

removeEventListenerSignalType(signalType: SignalType, callback: QTextBrowserSignals[SignalType]): void

Inherited from EventWidget.removeEventListener

Type parameters:

SignalType: keyof QTextBrowserSignals

Parameters:

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

Inherited from NodeTextEdit.scrollToAnchor

Parameters:

Name Type
name string

Returns: void


selectAll

selectAll(): void

Inherited from NodeTextEdit.selectAll

Returns: void


setAcceptDrops

setAcceptDrops(on: boolean): void

Inherited from QMenu.setAcceptDrops

Parameters:

Name Type
on boolean

Returns: void


setAcceptRichText

setAcceptRichText(accept: boolean): void

Inherited from NodeTextEdit.setAcceptRichText

Parameters:

Name Type
accept boolean

Returns: void


setAlignment

setAlignment(alignment: AlignmentFlag): void

Inherited from NodeTextEdit.setAlignment

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

Inherited from NodeTextEdit.setAutoFormatting

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

Inherited from NodeTextEdit.setCurrentFont

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

Inherited from NodeTextEdit.setCursorWidth

Parameters:

Name Type
width number

Returns: void


setDocumentTitle

setDocumentTitle(title: string): void

Inherited from NodeTextEdit.setDocumentTitle

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


setFont

setFont(font: QFont): void

Inherited from QMenu.setFont

Parameters:

Name Type
font QFont

Returns: void


setFontFamily

setFontFamily(family: string): void

Inherited from NodeTextEdit.setFontFamily

Parameters:

Name Type
family string

Returns: void


setFontItalic

setFontItalic(italic: boolean): void

Inherited from NodeTextEdit.setFontItalic

Parameters:

Name Type
italic boolean

Returns: void


setFontPointSize

setFontPointSize(s: number): void

Inherited from NodeTextEdit.setFontPointSize

Parameters:

Name Type
s number

Returns: void


setFontUnderline

setFontUnderline(underline: boolean): void

Inherited from NodeTextEdit.setFontUnderline

Parameters:

Name Type
underline boolean

Returns: void


setFontWeight

setFontWeight(weight: number): void

Inherited from NodeTextEdit.setFontWeight

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

Inherited from QMenu.setGraphicsEffect

Parameters:

Name Type
effect QGraphicsEffectany

Returns: void


setHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setHorizontalScrollBarPolicy

Parameters:

Name Type
policy ScrollBarPolicy

Returns: void


setHtml

setHtml(text: string): void

Inherited from NodeTextEdit.setHtml

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

Inherited from QMenu.setLayout

Parameters:

Name Type
parentLayout NodeLayoutQTextBrowserSignals

Returns: void


setLineWidth

setLineWidth(width: number): void

Inherited from NodeFrame.setLineWidth

Parameters:

Name Type
width number

Returns: void


setLineWrapColumnOrWidth

setLineWrapColumnOrWidth(w: number): void

Inherited from NodeTextEdit.setLineWrapColumnOrWidth

Parameters:

Name Type
w number

Returns: void


setLineWrapMode

setLineWrapMode(mode: QTextEditLineWrapMode): void

Inherited from NodeTextEdit.setLineWrapMode

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


setOpenExternalLinks(open: boolean): void

Parameters:

Name Type
open boolean

Returns: void


setOpenLinks(open: boolean): void

Parameters:

Name Type
open boolean

Returns: void


setOverwriteMode

setOverwriteMode(overwrite: boolean): void

Inherited from NodeTextEdit.setOverwriteMode

Parameters:

Name Type
overwrite boolean

Returns: void


setPlaceholderText

setPlaceholderText(placeholderText: string): void

Inherited from NodeTextEdit.setPlaceholderText

Parameters:

Name Type
placeholderText string

Returns: void


setPlainText

setPlainText(text: string): void

Inherited from NodeTextEdit.setPlainText

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

Inherited from NodeTextEdit.setReadOnly

Parameters:

Name Type
ro boolean

Returns: void


setSource

setSource(name: QUrl): void

Parameters:

Name Type
name QUrl

Returns: void


setStyleSheet

setStyleSheet(styleSheet: string): void

Inherited from QMenu.setStyleSheet

Parameters:

Name Type
styleSheet string

Returns: void


setTabChangesFocus

setTabChangesFocus(b: boolean): void

Inherited from NodeTextEdit.setTabChangesFocus

Parameters:

Name Type
b boolean

Returns: void


setTabStopDistance

setTabStopDistance(distance: number): void

Inherited from NodeTextEdit.setTabStopDistance

Parameters:

Name Type
distance number

Returns: void


setText

setText(text: string): void

Inherited from NodeTextEdit.setText

Parameters:

Name Type
text string

Returns: void


setTextBackgroundColor

setTextBackgroundColor(color: QColor): void

Inherited from NodeTextEdit.setTextBackgroundColor

Parameters:

Name Type
color QColor

Returns: void


setTextColor

setTextColor(color: QColor): void

Inherited from NodeTextEdit.setTextColor

Parameters:

Name Type
color QColor

Returns: void


setTextInteractionFlags

setTextInteractionFlags(flags: TextInteractionFlag): void

Inherited from NodeTextEdit.setTextInteractionFlags

Parameters:

Name Type
flags TextInteractionFlag

Returns: void


setUndoRedoEnabled

setUndoRedoEnabled(enable: boolean): void

Inherited from NodeTextEdit.setUndoRedoEnabled

Parameters:

Name Type
enable boolean

Returns: void


setVerticalScrollBarPolicy

setVerticalScrollBarPolicy(policy: ScrollBarPolicy): void

Inherited from QAbstractScrollArea.setVerticalScrollBarPolicy

Parameters:

Name Type
policy ScrollBarPolicy

Returns: void


setViewport

setViewport(widget: NodeWidgetany): void

Inherited from QAbstractScrollArea.setViewport

Parameters:

Name Type
widget NodeWidgetany

Returns: void


setWindowFlag

setWindowFlag(windowType: WindowType, switchOn: boolean): void

Inherited from QMenu.setWindowFlag

Parameters:

Name Type
windowType WindowType
switchOn boolean

Returns: void


setWindowIcon

setWindowIcon(icon: QIcon): void

Inherited from QMenu.setWindowIcon

Parameters:

Name Type
icon QIcon

Returns: void


setWindowOpacity

setWindowOpacity(opacity: number): void

Inherited from QMenu.setWindowOpacity

Parameters:

Name Type
opacity number

Returns: void


setWindowState

setWindowState(state: WindowState): void

Inherited from QMenu.setWindowState

Parameters:

Name Type
state WindowState

Returns: void


setWindowTitle

setWindowTitle(title: string): void

Inherited from QMenu.setWindowTitle

Parameters:

Name Type
title string

Returns: void


setWordWrapMode

setWordWrapMode(policy: WrapMode): void

Inherited from NodeTextEdit.setWordWrapMode

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


source

source(): QUrl

Returns: QUrl


styleSheet

styleSheet(): string

Inherited from QMenu.styleSheet

Returns: string


tabChangesFocus

tabChangesFocus(): boolean

Inherited from NodeTextEdit.tabChangesFocus

Returns: boolean


tabStopDistance

tabStopDistance(): number

Inherited from NodeTextEdit.tabStopDistance

Returns: number


testAttribute

testAttribute(attribute: WidgetAttribute): boolean

Inherited from QMenu.testAttribute

Parameters:

Name Type
attribute WidgetAttribute

Returns: boolean


textInteractionFlags

textInteractionFlags(): TextInteractionFlag

Inherited from NodeTextEdit.textInteractionFlags

Returns: TextInteractionFlag


toHtml

toHtml(): string

Inherited from NodeTextEdit.toHtml

Returns: string


toPlainText

toPlainText(): string

Inherited from NodeTextEdit.toPlainText

Returns: string


undo

undo(): void

Inherited from NodeTextEdit.undo

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

Inherited from NodeTextEdit.wordWrapMode

Returns: WrapMode


zommIn

zommIn(range: number): void

Inherited from NodeTextEdit.zommIn

Parameters:

Name Type Default
range number 1

Returns: void


zoomOut

zoomOut(range: number): void

Inherited from NodeTextEdit.zoomOut

Parameters:

Name Type Default
range number 1

Returns: void