BrowserWindow

open external class BrowserWindow(options: BrowserWindowConstructorOptions) : EventEmitter

Types

Companion

object Companion

Functions

addBrowserView

open fun addBrowserView(browserView: BrowserView)

addListener

open fun addListener(event: String, listener: (event: Event) -> Unit): BrowserWindow

open fun addListener(event: String, listener: (event: Event, newBounds: Rectangle) -> Unit): BrowserWindow

open fun addListener(event: String, listener: (event: Event, isAlwaysOnTop: Boolean) -> Unit): BrowserWindow

open fun addListener(event: String, listener: (event: Event, rotation: Number) -> Unit): BrowserWindow

open fun addListener(event: String, listener: (event: Event, command: String) -> Unit): BrowserWindow

open fun addListener(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): BrowserWindow

open fun addListener(event: String, listener: Function<*>): BrowserWindow

open fun addListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun addListener(event: String, listener: (args: Any) -> Unit): EventEmitter

addTabbedWindow

open fun addTabbedWindow(browserWindow: BrowserWindow)

blur

open fun blur()

blurWebView

open fun blurWebView()

capturePage

open fun capturePage(rect: Rectangle = definedExternally): Promise<NativeImage>

center

open fun center()

open fun close()

closeFilePreview

open fun closeFilePreview()

destroy

open fun destroy()

emit

open fun emit(event: Any, vararg args: Any): Boolean

open fun emit(event: String, vararg args: Any): Boolean

eventNames

open fun eventNames(): Array<dynamic>

flashFrame

open fun flashFrame(flag: Boolean)

focus

open fun focus()

focusOnWebView

open fun focusOnWebView()

getBounds

open fun getBounds(): Rectangle

getBrowserView

open fun getBrowserView(): BrowserView?

getBrowserViews

open fun getBrowserViews(): Array<BrowserView>

getChildWindows

open fun getChildWindows(): Array<BrowserWindow>

getContentBounds

open fun getContentBounds(): Rectangle

getContentSize

open fun getContentSize(): Array<Number>

getMaximumSize

open fun getMaximumSize(): Array<Number>

getMaxListeners

open fun getMaxListeners(): Number

getMediaSourceId

open fun getMediaSourceId(): String

getMinimumSize

open fun getMinimumSize(): Array<Number>

getNativeWindowHandle

open fun getNativeWindowHandle(): Buffer

getNormalBounds

open fun getNormalBounds(): Rectangle

getOpacity

open fun getOpacity(): Number

getParentWindow

open fun getParentWindow(): BrowserWindow

getPosition

open fun getPosition(): Array<Number>

getRepresentedFilename

open fun getRepresentedFilename(): String

getSize

open fun getSize(): Array<Number>

getTitle

open fun getTitle(): String

getTrafficLightPosition

open fun getTrafficLightPosition(): Point

hasShadow

open fun hasShadow(): Boolean

hide

open fun hide()

hookWindowMessage

open fun hookWindowMessage(message: Number, callback: () -> Unit)

isAlwaysOnTop

open fun isAlwaysOnTop(): Boolean

isClosable

open fun isClosable(): Boolean

isDestroyed

open fun isDestroyed(): Boolean

isDocumentEdited

open fun isDocumentEdited(): Boolean

isEnabled

open fun isEnabled()

isFocused

open fun isFocused(): Boolean

isFullScreen

open fun isFullScreen(): Boolean

isFullScreenable

open fun isFullScreenable(): Boolean

isKiosk

open fun isKiosk(): Boolean

isMaximizable

open fun isMaximizable(): Boolean

isMaximized

open fun isMaximized(): Boolean

isMenuBarAutoHide

open fun isMenuBarAutoHide(): Boolean

isMenuBarVisible

open fun isMenuBarVisible(): Boolean

isMinimizable

open fun isMinimizable(): Boolean

isMinimized

open fun isMinimized(): Boolean

isModal

open fun isModal(): Boolean

isMovable

open fun isMovable(): Boolean

isNormal

open fun isNormal(): Boolean

isResizable

open fun isResizable(): Boolean

isSimpleFullScreen

open fun isSimpleFullScreen(): Boolean

isVisible

open fun isVisible(): Boolean

isVisibleOnAllWorkspaces

open fun isVisibleOnAllWorkspaces(): Boolean

isWindowMessageHooked

open fun isWindowMessageHooked(message: Number): Boolean

listenerCount

open fun listenerCount(type: Any): Number

open fun listenerCount(type: String): Number

listeners

open fun listeners(event: Any): Array<Function<*>>

open fun listeners(event: String): Array<Function<*>>

loadFile

open fun loadFile(filePath: String, options: LoadFileOptions = definedExternally): Promise<Unit>

loadURL

open fun loadURL(url: String, options: LoadURLOptions = definedExternally): Promise<Unit>

maximize

open fun maximize()

mergeAllWindows

open fun mergeAllWindows()

minimize

open fun minimize()

moveAbove

open fun moveAbove(mediaSourceId: String)

moveTabToNewWindow

open fun moveTabToNewWindow()

moveTop

open fun moveTop()

off

open fun off(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun off(event: String, listener: (args: Any) -> Unit): EventEmitter

open fun on(event: String, listener: (event: Event) -> Unit): BrowserWindow

open fun on(event: String, listener: (event: Event, newBounds: Rectangle) -> Unit): BrowserWindow

open fun on(event: String, listener: (event: Event, isAlwaysOnTop: Boolean) -> Unit): BrowserWindow

open fun on(event: String, listener: (event: Event, rotation: Number) -> Unit): BrowserWindow

open fun on(event: String, listener: (event: Event, command: String) -> Unit): BrowserWindow

open fun on(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): BrowserWindow

open fun on(event: String, listener: Function<*>): BrowserWindow

open fun on(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun on(event: String, listener: (args: Any) -> Unit): EventEmitter

once

open fun once(event: String, listener: (event: Event) -> Unit): BrowserWindow

open fun once(event: String, listener: (event: Event, newBounds: Rectangle) -> Unit): BrowserWindow

open fun once(event: String, listener: (event: Event, isAlwaysOnTop: Boolean) -> Unit): BrowserWindow

open fun once(event: String, listener: (event: Event, rotation: Number) -> Unit): BrowserWindow

open fun once(event: String, listener: (event: Event, command: String) -> Unit): BrowserWindow

open fun once(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): BrowserWindow

open fun once(event: String, listener: Function<*>): BrowserWindow

open fun once(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun once(event: String, listener: (args: Any) -> Unit): EventEmitter

prependListener

open fun prependListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun prependListener(event: String, listener: (args: Any) -> Unit): EventEmitter

prependOnceListener

open fun prependOnceListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun prependOnceListener(event: String, listener: (args: Any) -> Unit): EventEmitter

previewFile

open fun previewFile(path: String, displayName: String = definedExternally)

rawListeners

open fun rawListeners(event: Any): Array<Function<*>>

open fun rawListeners(event: String): Array<Function<*>>

reload

open fun reload()

removeAllListeners

open fun removeAllListeners(event: Any = definedExternally): EventEmitter

open fun removeAllListeners(event: String = definedExternally): EventEmitter

removeBrowserView

open fun removeBrowserView(browserView: BrowserView)

removeListener

open fun removeListener(event: String, listener: (event: Event) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: (event: Event, newBounds: Rectangle) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: (event: Event, isAlwaysOnTop: Boolean) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: (event: Event, rotation: Number) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: (event: Event, command: String) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: (event: Event, title: String, explicitSet: Boolean) -> Unit): BrowserWindow

open fun removeListener(event: String, listener: Function<*>): BrowserWindow

open fun removeListener(event: Any, listener: (args: Any) -> Unit): EventEmitter

open fun removeListener(event: String, listener: (args: Any) -> Unit): EventEmitter

removeMenu

open fun removeMenu()

restore

open fun restore()

selectNextTab

open fun selectNextTab()

selectPreviousTab

open fun selectPreviousTab()

setAlwaysOnTop

open fun setAlwaysOnTop(flag: Boolean, level: String = definedExternally, relativeLevel: Number = definedExternally)

setAppDetails

open fun setAppDetails(options: AppDetailsOptions)

setAspectRatio

open fun setAspectRatio(aspectRatio: Number, extraSize: Size = definedExternally)

setAutoHideCursor

open fun setAutoHideCursor(autoHide: Boolean)

setAutoHideMenuBar

open fun setAutoHideMenuBar(hide: Boolean)

setBackgroundColor

open fun setBackgroundColor(backgroundColor: String)

setBounds

open fun setBounds(bounds: RectanglePartial, animate: Boolean = definedExternally)

setBrowserView

open fun setBrowserView(browserView: BrowserView?)

setClosable

open fun setClosable(closable: Boolean)

setContentBounds

open fun setContentBounds(bounds: Rectangle, animate: Boolean = definedExternally)

setContentProtection

open fun setContentProtection(enable: Boolean)

setContentSize

open fun setContentSize(width: Number, height: Number, animate: Boolean = definedExternally)

setDocumentEdited

open fun setDocumentEdited(edited: Boolean)

setEnabled

open fun setEnabled(enable: Boolean)

setFocusable

open fun setFocusable(focusable: Boolean)

setFullScreen

open fun setFullScreen(flag: Boolean)

setFullScreenable

open fun setFullScreenable(fullscreenable: Boolean)

setHasShadow

open fun setHasShadow(hasShadow: Boolean)

setIcon

open fun setIcon(icon: NativeImage)

open fun setIcon(icon: String)

setIgnoreMouseEvents

open fun setIgnoreMouseEvents(ignore: Boolean, options: IgnoreMouseEventsOptions = definedExternally)

setKiosk

open fun setKiosk(flag: Boolean)

setMaximizable

open fun setMaximizable(maximizable: Boolean)

setMaximumSize

open fun setMaximumSize(width: Number, height: Number)

setMaxListeners

open fun setMaxListeners(n: Number): EventEmitter

setMenu

open fun setMenu(menu: Menu?)

setMenuBarVisibility

open fun setMenuBarVisibility(visible: Boolean)

setMinimizable

open fun setMinimizable(minimizable: Boolean)

setMinimumSize

open fun setMinimumSize(width: Number, height: Number)

setMovable

open fun setMovable(movable: Boolean)

setOpacity

open fun setOpacity(opacity: Number)

setOverlayIcon

open fun setOverlayIcon(overlay: NativeImage?, description: String)

setParentWindow

open fun setParentWindow(parent: BrowserWindow?)

setPosition

open fun setPosition(x: Number, y: Number, animate: Boolean = definedExternally)

setProgressBar

open fun setProgressBar(progress: Number, options: ProgressBarOptions = definedExternally)

setRepresentedFilename

open fun setRepresentedFilename(filename: String)

setResizable

open fun setResizable(resizable: Boolean)

setShape

open fun setShape(rects: Array<Rectangle>)

setSheetOffset

open fun setSheetOffset(offsetY: Number, offsetX: Number = definedExternally)

setSimpleFullScreen

open fun setSimpleFullScreen(flag: Boolean)

setSize

open fun setSize(width: Number, height: Number, animate: Boolean = definedExternally)

setSkipTaskbar

open fun setSkipTaskbar(skip: Boolean)

setThumbarButtons

open fun setThumbarButtons(buttons: Array<ThumbarButton>): Boolean

setThumbnailClip

open fun setThumbnailClip(region: Rectangle)

setThumbnailToolTip

open fun setThumbnailToolTip(toolTip: String)

setTitle

open fun setTitle(title: String)

setTouchBar

open fun setTouchBar(touchBar: TouchBar?)

setTrafficLightPosition

open fun setTrafficLightPosition(position: Point)

setVibrancy

open fun setVibrancy(type: String)

setVisibleOnAllWorkspaces

open fun setVisibleOnAllWorkspaces(visible: Boolean, options: VisibleOnAllWorkspacesOptions = definedExternally)

setWindowButtonVisibility

open fun setWindowButtonVisibility(visible: Boolean)

show

open fun show()

showDefinitionForSelection

open fun showDefinitionForSelection()

showInactive

open fun showInactive()

toggleTabBar

open fun toggleTabBar()

unhookAllWindowMessages

open fun unhookAllWindowMessages()

unhookWindowMessage

open fun unhookWindowMessage(message: Number)

unmaximize

open fun unmaximize()

Properties

accessibleTitle

open var accessibleTitle: String

autoHideMenuBar

open var autoHideMenuBar: Boolean

closable

open var closable: Boolean

excludedFromShownWindowsMenu

open var excludedFromShownWindowsMenu: Boolean

fullScreenable

open var fullScreenable: Boolean

open var id: Number

maximizable

open var maximizable: Boolean

minimizable

open var minimizable: Boolean

movable

open var movable: Boolean

resizable

open var resizable: Boolean

webContents

open var webContents: WebContents