kotlin-electron/electron.main/WebContentsView

WebContentsView

open external class WebContentsView : WebContentsView(source)

Constructors

WebContentsView

constructor(options: WebContentsViewConstructorOptions = definedExternally)

Properties

boundsChangedEvent

open override val boundsChangedEvent: EventInstance<JsTuple>

children

val children: ReadonlyArray<View>

A View[] property representing the child views of this view.

webContents

val webContents: WebContents

A WebContents property containing a reference to the displayed WebContents. Use this to interact with the WebContents, for instance to load a URL.

Functions

addChildView

fun addChildView(view: View, index: Double = definedExternally)

If the same View is added to a parent which already contains it, it will be reordered such that it becomes the topmost view.

addListener

fun addListener(type: EventType, listener: EventListener)

emit

fun emit(type: EventType, vararg args: Any?): Boolean

eventNames

fun eventNames(): Array<EventType>

getBounds

fun getBounds(): Rectangle

The bounds of this View, relative to its parent.

getMaxListeners

fun getMaxListeners(): Double

listenerCount

fun listenerCount(type: EventType, listener: EventListener): Double

listeners

fun listeners(type: EventType): Array<EventListener>

off

fun off(type: EventType, listener: EventListener)

fun on(type: EventType, listener: EventListener)

once

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

rawListeners

fun rawListeners(type: EventType): Array<EventListener>

removeAllListeners

fun removeAllListeners(type: EventType)

removeChildView

fun removeChildView(view: View)

If the view passed as a parameter is not a child of this view, this method is a no-op.

removeListener

fun removeListener(type: EventType, listener: EventListener)

setBackgroundColor

fun setBackgroundColor(color: String)

Examples of valid color values:

setBorderRadius

fun setBorderRadius(radius: Double)

Note: The area cutout of the view's border still captures clicks.

setBounds

fun setBounds(bounds: Rectangle)

setMaxListeners

fun setMaxListeners(n: Number)

setVisible

fun setVisible(visible: Boolean)