From c8e16b8f2f1c8fe9967531c57faa5fe89ae300df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Belin?= Date: Tue, 14 Nov 2023 17:05:08 +0100 Subject: [PATCH] Update the API reference --- docs/api/404.html | 2 +- docs/api/index.html | 2 +- docs/api/js/Nw.html | 2 +- docs/api/js/NwFlavor.html | 2 +- docs/api/js/nw/App.html | 2 +- docs/api/js/nw/AppComponent.html | 2 +- docs/api/js/nw/AppEvent.html | 2 +- docs/api/js/nw/CaptureDataType.html | 2 +- docs/api/js/nw/CaptureImageFormat.html | 2 +- docs/api/js/nw/CapturePageOptions.html | 2 +- docs/api/js/nw/CaptureScreenshotOptions.html | 2 +- docs/api/js/nw/Clipboard.html | 2 +- docs/api/js/nw/ClipboardData.html | 4 ++-- docs/api/js/nw/ClipboardDataType.html | 2 +- docs/api/js/nw/ClipboardOptions.html | 10 ++++++++++ docs/api/js/nw/Cookie.html | 2 +- docs/api/js/nw/CookieChange.html | 2 +- docs/api/js/nw/Cookies.html | 2 +- docs/api/js/nw/DesktopCaptureMonitor.html | 2 +- docs/api/js/nw/DesktopCaptureMonitorEvent.html | 2 +- docs/api/js/nw/DesktopMediaSource.html | 2 +- docs/api/js/nw/Menu.html | 2 +- docs/api/js/nw/MenuItem.html | 2 +- docs/api/js/nw/MenuItemEvent.html | 2 +- docs/api/js/nw/MenuItemOptions.html | 2 +- docs/api/js/nw/MenuItemType.html | 2 +- docs/api/js/nw/MenuType.html | 2 +- docs/api/js/nw/OnChangedCause.html | 2 +- docs/api/js/nw/PrintCustomMargins.html | 2 +- docs/api/js/nw/PrintMarginsType.html | 2 +- docs/api/js/nw/PrintMediaSize.html | 2 +- docs/api/js/nw/PrintOptions.html | 2 +- docs/api/js/nw/Printer.html | 2 +- docs/api/js/nw/PrinterOptions.html | 2 +- docs/api/js/nw/SameSiteStatus.html | 2 +- docs/api/js/nw/Screen.html | 2 +- docs/api/js/nw/ScreenDefinition.html | 2 +- docs/api/js/nw/ScreenEvent.html | 2 +- docs/api/js/nw/Shell.html | 2 +- docs/api/js/nw/Shortcut.html | 2 +- docs/api/js/nw/ShortcutEvent.html | 2 +- docs/api/js/nw/ShortcutOptions.html | 2 +- docs/api/js/nw/Tray.html | 2 +- docs/api/js/nw/TrayEvent.html | 2 +- docs/api/js/nw/TrayOptions.html | 2 +- docs/api/js/nw/Window.html | 2 +- docs/api/js/nw/WindowEvent.html | 2 +- docs/api/js/nw/WindowManifest.html | 2 +- docs/api/js/nw/WindowOpenOptions.html | 2 +- docs/api/js/nw/WindowPolicy.html | 2 +- docs/api/js/nw/WindowPosition.html | 2 +- docs/api/js/nw/index.html | 2 +- docs/api/nav.js | 2 +- docs/changelog.md | 3 +++ 54 files changed, 66 insertions(+), 53 deletions(-) create mode 100644 docs/api/js/nw/ClipboardOptions.html diff --git a/docs/api/404.html b/docs/api/404.html index 579eb4e..160a900 100644 --- a/docs/api/404.html +++ b/docs/api/404.html @@ -1 +1 @@ -File not found - Haxe Externs for NW.js

404 Page not found

Page not found, sorry.

\ No newline at end of file +File not found - Haxe Externs for NW.js

404 Page not found

Page not found, sorry.

\ No newline at end of file diff --git a/docs/api/index.html b/docs/api/index.html index 126015d..4d77a6e 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

js version 1.4.0

Type definitions for using NW.js with Haxe.

nw
Nw

The top-level NW.js object.

NwFlavor

Defines the NW.js build flavors.

\ No newline at end of file +

js version 1.4.1

Type definitions for using NW.js with Haxe.

nw
Nw

The top-level NW.js object.

NwFlavor

Defines the NW.js build flavors.

\ No newline at end of file diff --git a/docs/api/js/Nw.html b/docs/api/js/Nw.html index 51eea37..a8d06da 100644 --- a/docs/api/js/Nw.html +++ b/docs/api/js/Nw.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Nw

package js

@:native("nw")

The top-level NW.js object.

Static variables

staticread onlyflavor:NwFlavor

The build flavor of NW.js.

staticread onlyversion:String

The version number of NW.js.

Static methods

staticinlineget_flavor():NwFlavor

staticinlineget_version():String

\ No newline at end of file +
View source

class Nw

package js

@:native("nw")

The top-level NW.js object.

Static variables

staticread onlyflavor:NwFlavor

The build flavor of NW.js.

staticread onlyversion:String

The version number of NW.js.

Static methods

staticinlineget_flavor():NwFlavor

staticinlineget_version():String

\ No newline at end of file diff --git a/docs/api/js/NwFlavor.html b/docs/api/js/NwFlavor.html index e1645f2..7c2a15f 100644 --- a/docs/api/js/NwFlavor.html +++ b/docs/api/js/NwFlavor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract NwFlavor(String)

package js

from String to String

import js.Nw

@:enum

Defines the NW.js build flavors.

Variables

@:value(cast "normal")@:impl@:enuminlineread onlyNormal:NwFlavor = "normal"

The NW.js binary is a normal build.

@:value(cast "sdk")@:impl@:enuminlineread onlySdk:NwFlavor = "sdk"

The NW.js binary is an SDK build.

\ No newline at end of file +
View source

enum abstract NwFlavor(String)

package js

from String to String

import js.Nw

@:enum

Defines the NW.js build flavors.

Variables

@:value(cast "normal")@:impl@:enuminlineread onlyNormal:NwFlavor = "normal"

The NW.js binary is a normal build.

@:value(cast "sdk")@:impl@:enuminlineread onlySdk:NwFlavor = "sdk"

The NW.js binary is an SDK build.

\ No newline at end of file diff --git a/docs/api/js/nw/App.html b/docs/api/js/nw/App.html index 2ba8142..3885b1c 100644 --- a/docs/api/js/nw/App.html +++ b/docs/api/js/nw/App.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class App

package js.nw

@:native("nw.App")

Represents the application.

Static variables

staticfinalread onlyargv:Array<String>

The filtered command line arguments.

staticfinalread onlydataPath:String

The application's data path in user's directory.

staticfinalread onlyfilteredArgv:Array<String>

The patterns used to filter the command line arguments.

staticfinalread onlyfullArgv:Array<String>

The unfiltered command line arguments.

staticfinalread onlymanifest:DynamicAccess<Dynamic>

The JSON object of the manifest file.

staticfinalread onlystartPath:String

The directory where the application starts.

Static methods

staticaddListener<T>(event:AppEvent<T>, listener:T):App

Adds a listener that will be invoked when the specified event is triggered.

staticaddOriginAccessWhitelistEntry(sourceOrigin:String, destinationProtocol:String, destinationHost:String, allowDestinationSubdomains:Bool):Void

Adds an entry to the whitelist used for controlling cross-origin access.

staticclearAppCache(manifestUrl:String):Void

Marks the application cache group specified by manifestUrl obsolete.

staticclearCache():Void

Clears the HTTP cache in memory and the one on disk.

staticcloseAllWindows():Void

Sends the close event to all windows.

staticcrashBrowser():Void

Crashes the browser process.

staticcrashRenderer():Void

Crashes the renderer process.

staticenableComponent(component:AppComponent, callback:String ‑> Void):Void

Enables an application component.

staticgetProxyForURL(url:String):Void

Queries the proxy to be used for loading url in DOM.

staticoff<T>(event:AppEvent<T>, listener:T):App

Removes the specified listener for the given event.

staticon<T>(event:AppEvent<T>, listener:T):App

Adds a listener that will be invoked when the specified event is triggered.

staticonce<T>(event:AppEvent<T>, listener:T):App

Adds a one-time listener that will be removed and then invoked whenever the next time event is triggered.

staticquit():Void

Terminates the application.

staticregisterGlobalHotKey(shortcut:Shortcut):Void

Registers a global keyboard shortcut.

staticremoveListener<T>(event:AppEvent<T>, listener:T):App

Removes the specified listener for the given event.

staticremoveOriginAccessWhitelistEntry(sourceOrigin:String, destinationProtocol:String, destinationHost:String, allowDestinationSubdomains:Bool):Void

Removes an entry from the whitelist used for controlling cross-origin access.

staticsetCrashDumpDir(directory:String):Void

Deprecated: "This feature is deprecated since 0.11.0."

Set the directory where the minidump file will be saved on crash.

staticsetProxyConfig(config:String, pacUrl:String):Void

Sets the proxy configuration which the web engine will use to request network resources.

staticunregisterGlobalHotKey(shortcut:Shortcut):Void

Unregisters a global keyboard shortcut.

staticupdateComponent(component:AppComponent, callback:Bool ‑> Void):Void

Updates an application component.

\ No newline at end of file +
View source

class App

package js.nw

@:native("nw.App")

Represents the application.

Static variables

staticfinalread onlyargv:Array<String>

The filtered command line arguments.

staticfinalread onlydataPath:String

The application's data path in user's directory.

staticfinalread onlyfilteredArgv:Array<String>

The patterns used to filter the command line arguments.

staticfinalread onlyfullArgv:Array<String>

The unfiltered command line arguments.

staticfinalread onlymanifest:DynamicAccess<Dynamic>

The JSON object of the manifest file.

staticfinalread onlystartPath:String

The directory where the application starts.

Static methods

staticaddListener<T>(event:AppEvent<T>, listener:T):App

Adds a listener that will be invoked when the specified event is triggered.

staticaddOriginAccessWhitelistEntry(sourceOrigin:String, destinationProtocol:String, destinationHost:String, allowDestinationSubdomains:Bool):Void

Adds an entry to the whitelist used for controlling cross-origin access.

staticclearAppCache(manifestUrl:String):Void

Marks the application cache group specified by manifestUrl obsolete.

staticclearCache():Void

Clears the HTTP cache in memory and the one on disk.

staticcloseAllWindows():Void

Sends the close event to all windows.

staticcrashBrowser():Void

Crashes the browser process.

staticcrashRenderer():Void

Crashes the renderer process.

staticenableComponent(component:AppComponent, callback:String ‑> Void):Void

Enables an application component.

staticgetProxyForURL(url:String):Void

Queries the proxy to be used for loading url in DOM.

staticoff<T>(event:AppEvent<T>, listener:T):App

Removes the specified listener for the given event.

staticon<T>(event:AppEvent<T>, listener:T):App

Adds a listener that will be invoked when the specified event is triggered.

staticonce<T>(event:AppEvent<T>, listener:T):App

Adds a one-time listener that will be removed and then invoked whenever the next time event is triggered.

staticquit():Void

Terminates the application.

staticregisterGlobalHotKey(shortcut:Shortcut):Void

Registers a global keyboard shortcut.

staticremoveListener<T>(event:AppEvent<T>, listener:T):App

Removes the specified listener for the given event.

staticremoveOriginAccessWhitelistEntry(sourceOrigin:String, destinationProtocol:String, destinationHost:String, allowDestinationSubdomains:Bool):Void

Removes an entry from the whitelist used for controlling cross-origin access.

staticsetCrashDumpDir(directory:String):Void

Deprecated: "This feature is deprecated since 0.11.0."

Set the directory where the minidump file will be saved on crash.

staticsetProxyConfig(config:String, pacUrl:String):Void

Sets the proxy configuration which the web engine will use to request network resources.

staticunregisterGlobalHotKey(shortcut:Shortcut):Void

Unregisters a global keyboard shortcut.

staticupdateComponent(component:AppComponent, callback:Bool ‑> Void):Void

Updates an application component.

\ No newline at end of file diff --git a/docs/api/js/nw/AppComponent.html b/docs/api/js/nw/AppComponent.html index 7486be6..a9a0589 100644 --- a/docs/api/js/nw/AppComponent.html +++ b/docs/api/js/nw/AppComponent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract AppComponent(String)

package js.nw

to String

import js.nw.App

@:enum

Defines the components of an App instance.

Variables

@:value(cast "WIDEVINE")@:impl@:enuminlineread onlyWidevine:AppComponent = "WIDEVINE"

The Widevine component.

\ No newline at end of file +
View source

enum abstract AppComponent(String)

package js.nw

from String to String

import js.nw.App

@:enum

Defines the components of an App instance.

Variables

@:value(cast "WIDEVINE")@:impl@:enuminlineread onlyWidevine:AppComponent = "WIDEVINE"

The Widevine component.

\ No newline at end of file diff --git a/docs/api/js/nw/AppEvent.html b/docs/api/js/nw/AppEvent.html index 1829917..48d42da 100644 --- a/docs/api/js/nw/AppEvent.html +++ b/docs/api/js/nw/AppEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract AppEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.App

@:enum

Defines the events of an App instance.

Variables

@:value(cast "open")@:impl@:enuminlineread onlyOpen:AppEvent<String ‑> Void> = "open"

The open event.

@:value(cast "reopen")@:impl@:enuminlineread onlyReopen:AppEvent<() ‑> Void> = "reopen"

The reopen event.

\ No newline at end of file +
View source

enum abstract AppEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.App

@:enum

Defines the events of an App instance.

Variables

@:value(cast "open")@:impl@:enuminlineread onlyOpen:AppEvent<String ‑> Void> = "open"

The open event.

@:value(cast "reopen")@:impl@:enuminlineread onlyReopen:AppEvent<() ‑> Void> = "reopen"

The reopen event.

\ No newline at end of file diff --git a/docs/api/js/nw/CaptureDataType.html b/docs/api/js/nw/CaptureDataType.html index 4901d57..418de20 100644 --- a/docs/api/js/nw/CaptureDataType.html +++ b/docs/api/js/nw/CaptureDataType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract CaptureDataType(String)

package js.nw

to String

import js.nw.Window

@:enum

Defines the data type of a captured image.

Variables

@:value(cast "buffer")@:impl@:enuminlineread onlyBuffer:CaptureDataType = "buffer"

The image data is a Buffer instance.

@:value(cast "datauri")@:impl@:enuminlineread onlyDataUri:CaptureDataType = "datauri"

The image data is a Data URI.

@:value(cast "raw")@:impl@:enuminlineread onlyRaw:CaptureDataType = "raw"

The image data is a Base64 string.

\ No newline at end of file +
View source

enum abstract CaptureDataType(String)

package js.nw

from String to String

import js.nw.Window

@:enum

Defines the data type of a captured image.

Variables

@:value(cast "buffer")@:impl@:enuminlineread onlyBuffer:CaptureDataType = "buffer"

The image data is a Buffer instance.

@:value(cast "datauri")@:impl@:enuminlineread onlyDataUri:CaptureDataType = "datauri"

The image data is a Data URI.

@:value(cast "raw")@:impl@:enuminlineread onlyRaw:CaptureDataType = "raw"

The image data is a Base64 string.

\ No newline at end of file diff --git a/docs/api/js/nw/CaptureImageFormat.html b/docs/api/js/nw/CaptureImageFormat.html index e2e45e2..1c5d0d7 100644 --- a/docs/api/js/nw/CaptureImageFormat.html +++ b/docs/api/js/nw/CaptureImageFormat.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract CaptureImageFormat(String)

package js.nw

to String

import js.nw.Window

@:enum

Defines the format of a captured image.

Variables

@:value(cast "jpeg")@:impl@:enuminlineread onlyJpeg:CaptureImageFormat = "jpeg"

The image format is JPEG.

@:value(cast "png")@:impl@:enuminlineread onlyPng:CaptureImageFormat = "png"

The image format is PNG.

\ No newline at end of file +
View source

enum abstract CaptureImageFormat(String)

package js.nw

from String to String

import js.nw.Window

@:enum

Defines the format of a captured image.

Variables

@:value(cast "jpeg")@:impl@:enuminlineread onlyJpeg:CaptureImageFormat = "jpeg"

The image format is JPEG.

@:value(cast "png")@:impl@:enuminlineread onlyPng:CaptureImageFormat = "png"

The image format is PNG.

\ No newline at end of file diff --git a/docs/api/js/nw/CapturePageOptions.html b/docs/api/js/nw/CapturePageOptions.html index 71c6ea7..dc8f1b1 100644 --- a/docs/api/js/nw/CapturePageOptions.html +++ b/docs/api/js/nw/CapturePageOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef CapturePageOptions

package js.nw

import js.nw.Window

Defines the options of the Window.capturePage() method.

Fields

@:optionaloptionalformat:Null<CaptureImageFormat>

The image format.

@:optionaloptionaldatatype:Null<CaptureDataType>

The data type of the captured image.

\ No newline at end of file +
View source

typedef CapturePageOptions

package js.nw

import js.nw.Window

Defines the options of the Window.capturePage() method.

Fields

@:optionaloptionalformat:Null<CaptureImageFormat>

The image format.

@:optionaloptionaldatatype:Null<CaptureDataType>

The data type of the captured image.

\ No newline at end of file diff --git a/docs/api/js/nw/CaptureScreenshotOptions.html b/docs/api/js/nw/CaptureScreenshotOptions.html index 9a0b727..51de270 100644 --- a/docs/api/js/nw/CaptureScreenshotOptions.html +++ b/docs/api/js/nw/CaptureScreenshotOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef CaptureScreenshotOptions

package js.nw

import js.nw.Window

Defines the options of the Window.captureScreenshot() method.

Fields

@:optionaloptionalquality:Null<Int>

The compression quality.

@:optionaloptionalfullSize:Null<Bool>

Value indicating whether to capture the whole page beyond the visible area.

@:optionaloptionalformat:Null<CaptureImageFormat>

The image format.

@:optionaloptionalclip:Null<{y:Float, x:Float, width:Float, scale:Float, height:Float}>

Captures the screenshot of a given region only.

\ No newline at end of file +
View source

typedef CaptureScreenshotOptions

package js.nw

import js.nw.Window

Defines the options of the Window.captureScreenshot() method.

Fields

@:optionaloptionalquality:Null<Int>

The compression quality.

@:optionaloptionalfullSize:Null<Bool>

Value indicating whether to capture the whole page beyond the visible area.

@:optionaloptionalformat:Null<CaptureImageFormat>

The image format.

@:optionaloptionalclip:Null<{y:Float, x:Float, width:Float, scale:Float, height:Float}>

Captures the screenshot of a given region only.

\ No newline at end of file diff --git a/docs/api/js/nw/Clipboard.html b/docs/api/js/nw/Clipboard.html index 92ba26f..bf0b831 100644 --- a/docs/api/js/nw/Clipboard.html +++ b/docs/api/js/nw/Clipboard.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Clipboard

package js.nw

@:native("nw.Clipboard")

An abstraction of the clipboard.

Static methods

staticget():Clipboard

Returns the clipboard object.

Methods

clear():Void

Clears the clipboard.

get(data:ClipboardData):String

@:value({ raw : false, type : Text })get(type:ClipboardDataType = Text, raw:Bool = false):String

get(dataList:Array<ClipboardData>):String

Gets the data from the clipboard.

readAvailableTypes():Array<ClipboardDataType>

Returns the list of available types of data in clipboard.

set(data:ClipboardData):Void

@:value({ raw : false, type : Text })set(data:String, type:ClipboardDataType = Text, raw:Bool = false):Void

set(dataList:Array<ClipboardData>):Void

Writes the specified data to the clipboard.

\ No newline at end of file +
View source

class Clipboard

package js.nw

@:native("nw.Clipboard")

An abstraction of the clipboard.

Static methods

staticget():Clipboard

Returns the clipboard object.

Methods

clear():Void

Clears the clipboard.

get(data:ClipboardOptions):String

@:value({ raw : false, type : Text })get(type:ClipboardDataType = Text, raw:Bool = false):String

get(dataList:Array<ClipboardOptions>):Array<ClipboardData>

Gets the data from the clipboard.

readAvailableTypes():Array<ClipboardDataType>

Returns the list of available types of data in clipboard.

set(data:ClipboardData):Void

@:value({ raw : false, type : Text })set(data:String, type:ClipboardDataType = Text, raw:Bool = false):Void

set(dataList:Array<ClipboardData>):Void

Writes the specified data to the clipboard.

\ No newline at end of file diff --git a/docs/api/js/nw/ClipboardData.html b/docs/api/js/nw/ClipboardData.html index e537a01..0feccc0 100644 --- a/docs/api/js/nw/ClipboardData.html +++ b/docs/api/js/nw/ClipboardData.html @@ -1,10 +1,10 @@ -js.nw.ClipboardData - Haxe Externs for NW.js
View source

typedef ClipboardData

package js.nw

import js.nw.Clipboard

Defines the options of clipboard data.

Fields

@:optionaloptionaltype:Null<ClipboardDataType>

The type of clipboard data.

@:optionaloptionalraw:Null<Bool>

Value indicating whether to require raw image data.

data:String

The clipboard data.

\ No newline at end of file +
View source

typedef ClipboardData

package js.nw

import js.nw.Clipboard

Represents data from the clipboard.

Fields

type:ClipboardDataType

The type of clipboard data.

@:optionaloptionalraw:Null<Bool>

Value indicating whether to require raw image data.

data:String

The clipboard data.

\ No newline at end of file diff --git a/docs/api/js/nw/ClipboardDataType.html b/docs/api/js/nw/ClipboardDataType.html index bfff130..47fa1ca 100644 --- a/docs/api/js/nw/ClipboardDataType.html +++ b/docs/api/js/nw/ClipboardDataType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract ClipboardDataType(String)

package js.nw

to String

import js.nw.Clipboard

@:enum

Defines the type of clipboard data.

Variables

@:value(cast "html")@:impl@:enuminlineread onlyHtml:ClipboardDataType = "html"

The clipboard data is an HTML string.

@:value(cast "jpeg")@:impl@:enuminlineread onlyJpeg:ClipboardDataType = "jpeg"

The clipboard data is a JPEG image.

@:value(cast "png")@:impl@:enuminlineread onlyPng:ClipboardDataType = "png"

The clipboard data is a PNG image.

@:value(cast "rtf")@:impl@:enuminlineread onlyRtf:ClipboardDataType = "rtf"

The clipboard data is Rich Text Format.

@:value(cast "text")@:impl@:enuminlineread onlyText:ClipboardDataType = "text"

The clipboard data is plain text.

\ No newline at end of file +
View source

enum abstract ClipboardDataType(String)

package js.nw

from String to String

import js.nw.Clipboard

@:enum

Defines the type of clipboard data.

Variables

@:value(cast "html")@:impl@:enuminlineread onlyHtml:ClipboardDataType = "html"

The clipboard data is an HTML string.

@:value(cast "jpeg")@:impl@:enuminlineread onlyJpeg:ClipboardDataType = "jpeg"

The clipboard data is a JPEG image.

@:value(cast "png")@:impl@:enuminlineread onlyPng:ClipboardDataType = "png"

The clipboard data is a PNG image.

@:value(cast "rtf")@:impl@:enuminlineread onlyRtf:ClipboardDataType = "rtf"

The clipboard data is Rich Text Format.

@:value(cast "text")@:impl@:enuminlineread onlyText:ClipboardDataType = "text"

The clipboard data is plain text.

\ No newline at end of file diff --git a/docs/api/js/nw/ClipboardOptions.html b/docs/api/js/nw/ClipboardOptions.html new file mode 100644 index 0000000..e3c65d5 --- /dev/null +++ b/docs/api/js/nw/ClipboardOptions.html @@ -0,0 +1,10 @@ + + + +js.nw.ClipboardOptions - Haxe Externs for NW.js
View source

typedef ClipboardOptions

package js.nw

import js.nw.Clipboard

Defines the options of the Clipboard.get() method.

Fields

type:ClipboardDataType

The type of clipboard data.

@:optionaloptionalraw:Null<Bool>

Value indicating whether to require raw image data.

\ No newline at end of file diff --git a/docs/api/js/nw/Cookie.html b/docs/api/js/nw/Cookie.html index 71270a0..6cbdf54 100644 --- a/docs/api/js/nw/Cookie.html +++ b/docs/api/js/nw/Cookie.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef Cookie

package js.nw

import js.nw.Cookies

Represents information about an HTTP cookie.

Fields

value:String

The cookie value.

session:Bool

Value indicating whether the cookie is a session cookie.

secure:Bool

Value indicating whether the cookie is marked as Secure.

sameSite:SameSiteStatus

The cookie's same-site status.

path:String

The cookie path.

name:String

The cookie name.

httpOnly:Bool

Value indicating whether the cookie is marked as HttpOnly.

hostOnly:Bool

Value indicating whether the cookie is a host-only cookie.

@:optionaloptionalexpirationDate:Null<Float>

The expiration date of the cookie as the number of seconds since the UNIX epoch.

domain:String

The cookie domain.

\ No newline at end of file +
View source

typedef Cookie

package js.nw

import js.nw.Cookies

Represents information about an HTTP cookie.

Fields

value:String

The cookie value.

session:Bool

Value indicating whether the cookie is a session cookie.

secure:Bool

Value indicating whether the cookie is marked as Secure.

sameSite:SameSiteStatus

The cookie's same-site status.

path:String

The cookie path.

name:String

The cookie name.

httpOnly:Bool

Value indicating whether the cookie is marked as HttpOnly.

hostOnly:Bool

Value indicating whether the cookie is a host-only cookie.

@:optionaloptionalexpirationDate:Null<Float>

The expiration date of the cookie as the number of seconds since the UNIX epoch.

domain:String

The cookie domain.

\ No newline at end of file diff --git a/docs/api/js/nw/CookieChange.html b/docs/api/js/nw/CookieChange.html index 9098aef..f816ff0 100644 --- a/docs/api/js/nw/CookieChange.html +++ b/docs/api/js/nw/CookieChange.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef CookieChange

package js.nw

import js.nw.Cookies

Provides information about a cookie's change.

Fields

removed:Bool

Value indicating whether the cookie was removed.

cookie:Cookie

Information about the cookie that was set or removed.

cause:OnChangedCause

The underlying reason behind the cookie's change.

\ No newline at end of file +
View source

typedef CookieChange

package js.nw

import js.nw.Cookies

Provides information about a cookie's change.

Fields

removed:Bool

Value indicating whether the cookie was removed.

cookie:Cookie

Information about the cookie that was set or removed.

cause:OnChangedCause

The underlying reason behind the cookie's change.

\ No newline at end of file diff --git a/docs/api/js/nw/Cookies.html b/docs/api/js/nw/Cookies.html index 8ed1296..eed5ffc 100644 --- a/docs/api/js/nw/Cookies.html +++ b/docs/api/js/nw/Cookies.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Cookies

package js.nw

A collection of the available cookies.

Variables

finalonChanged:{removeListener:(listener:CookieChange ‑> Void) ‑> Void, addListener:(listener:CookieChange ‑> Void) ‑> Void}

The event fired when a cookie is set or removed.

Methods

get(details:{url:String, name:String}, callback:Cookie ‑> Void):Void

Retrieves information about a single cookie.

getAll(details:{url:Null<String>, session:Null<Bool>, secure:Null<Bool>, path:Null<String>, name:Null<String>, domain:Null<String>}, callback:Array<Cookie> ‑> Void):Void

Retrieves all cookies that match the given information.

remove(details:{url:String, name:String}, callback:{url:String, name:String} ‑> Void):Void

Deletes a cookie by name.

set(details:{value:Null<String>, url:String, secure:Null<Bool>, sameSite:Null<SameSiteStatus>, path:Null<String>, name:Null<String>, httpOnly:Null<Bool>, expirationDate:Null<Float>, domain:Null<String>}, callback:Cookie ‑> Void):Void

Sets a cookie with the given cookie data.

\ No newline at end of file +
View source

class Cookies

package js.nw

A collection of the available cookies.

Variables

finalonChanged:{removeListener:(listener:CookieChange ‑> Void) ‑> Void, addListener:(listener:CookieChange ‑> Void) ‑> Void}

The event fired when a cookie is set or removed.

Methods

get(details:{url:String, name:String}, callback:Cookie ‑> Void):Void

Retrieves information about a single cookie.

getAll(details:{url:Null<String>, session:Null<Bool>, secure:Null<Bool>, path:Null<String>, name:Null<String>, domain:Null<String>}, callback:Array<Cookie> ‑> Void):Void

Retrieves all cookies that match the given information.

remove(details:{url:String, name:String}, callback:{url:String, name:String} ‑> Void):Void

Deletes a cookie by name.

set(details:{value:Null<String>, url:String, secure:Null<Bool>, sameSite:Null<SameSiteStatus>, path:Null<String>, name:Null<String>, httpOnly:Null<Bool>, expirationDate:Null<Float>, domain:Null<String>}, callback:Cookie ‑> Void):Void

Sets a cookie with the given cookie data.

\ No newline at end of file diff --git a/docs/api/js/nw/DesktopCaptureMonitor.html b/docs/api/js/nw/DesktopCaptureMonitor.html index c5825a3..c880bf4 100644 --- a/docs/api/js/nw/DesktopCaptureMonitor.html +++ b/docs/api/js/nw/DesktopCaptureMonitor.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class DesktopCaptureMonitor

package js.nw

extends EventEmitter

import js.nw.Screen

Monitors the changes of screens and windows on the desktop.

Variables

finalstarted:Bool

Value indicating whether the dektop capture monitor is started.

Methods

registerStream(id:String):Void

Registers and returns a valid stream identifier.

start(shouldIncludeScreens:Bool, shouldIncludeWindows:Bool):Void

Starts monitoring the system and triggering the events.

stop():Void

Stops monitoring the system.

\ No newline at end of file +
View source

class DesktopCaptureMonitor

package js.nw

extends EventEmitter

import js.nw.Screen

Monitors the changes of screens and windows on the desktop.

Variables

finalstarted:Bool

Value indicating whether the dektop capture monitor is started.

Methods

registerStream(id:String):Void

Registers and returns a valid stream identifier.

start(shouldIncludeScreens:Bool, shouldIncludeWindows:Bool):Void

Starts monitoring the system and triggering the events.

stop():Void

Stops monitoring the system.

\ No newline at end of file diff --git a/docs/api/js/nw/DesktopCaptureMonitorEvent.html b/docs/api/js/nw/DesktopCaptureMonitorEvent.html index 324a6a8..f720cbf 100644 --- a/docs/api/js/nw/DesktopCaptureMonitorEvent.html +++ b/docs/api/js/nw/DesktopCaptureMonitorEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract DesktopCaptureMonitorEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Screen

@:enum

Defines the events of a DesktopCaptureMonitor instance.

Variables

@:value(cast "added")@:impl@:enuminlineread onlyAdded:DesktopCaptureMonitorEvent<(String, String, Int, String, Bool) ‑> Void> = "added"

The added event.

@:value(cast "namechanged")@:impl@:enuminlineread onlyNameChanged:DesktopCaptureMonitorEvent<(String, String) ‑> Void> = "namechanged"

The namechanged event.

@:value(cast "orderchanged")@:impl@:enuminlineread onlyOrderChanged:DesktopCaptureMonitorEvent<(String, Int, Int) ‑> Void> = "orderchanged"

The orderchanged event.

@:value(cast "removed")@:impl@:enuminlineread onlyRemoved:DesktopCaptureMonitorEvent<Int ‑> Void> = "removed"

The removed event.

@:value(cast "thumbnailchanged")@:impl@:enuminlineread onlyThumbnailChanged:DesktopCaptureMonitorEvent<(String, String) ‑> Void> = "thumbnailchanged"

The thumbnailchanged event.

\ No newline at end of file +
View source

enum abstract DesktopCaptureMonitorEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Screen

@:enum

Defines the events of a DesktopCaptureMonitor instance.

Variables

@:value(cast "added")@:impl@:enuminlineread onlyAdded:DesktopCaptureMonitorEvent<(String, String, Int, String, Bool) ‑> Void> = "added"

The added event.

@:value(cast "namechanged")@:impl@:enuminlineread onlyNameChanged:DesktopCaptureMonitorEvent<(String, String) ‑> Void> = "namechanged"

The namechanged event.

@:value(cast "orderchanged")@:impl@:enuminlineread onlyOrderChanged:DesktopCaptureMonitorEvent<(String, Int, Int) ‑> Void> = "orderchanged"

The orderchanged event.

@:value(cast "removed")@:impl@:enuminlineread onlyRemoved:DesktopCaptureMonitorEvent<Int ‑> Void> = "removed"

The removed event.

@:value(cast "thumbnailchanged")@:impl@:enuminlineread onlyThumbnailChanged:DesktopCaptureMonitorEvent<(String, String) ‑> Void> = "thumbnailchanged"

The thumbnailchanged event.

\ No newline at end of file diff --git a/docs/api/js/nw/DesktopMediaSource.html b/docs/api/js/nw/DesktopMediaSource.html index 53c4ef5..58beda2 100644 --- a/docs/api/js/nw/DesktopMediaSource.html +++ b/docs/api/js/nw/DesktopMediaSource.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract DesktopMediaSource(String)

package js.nw

to String

import js.nw.Screen

@:enum

Defines the desktop media sources used in Screen.chooseDesktopMedia() method.

Variables

@:value(cast "screen")@:impl@:enuminlineread onlyScreen:DesktopMediaSource = "screen"

The media source is a screen.

@:value(cast "window")@:impl@:enuminlineread onlyWindow:DesktopMediaSource = "window"

The media source is a window.

\ No newline at end of file +
View source

enum abstract DesktopMediaSource(String)

package js.nw

from String to String

import js.nw.Screen

@:enum

Defines the desktop media sources used in Screen.chooseDesktopMedia() method.

Variables

@:value(cast "screen")@:impl@:enuminlineread onlyScreen:DesktopMediaSource = "screen"

The media source is a screen.

@:value(cast "window")@:impl@:enuminlineread onlyWindow:DesktopMediaSource = "window"

The media source is a window.

\ No newline at end of file diff --git a/docs/api/js/nw/Menu.html b/docs/api/js/nw/Menu.html index 9d7ca9e..a1dd9e6 100644 --- a/docs/api/js/nw/Menu.html +++ b/docs/api/js/nw/Menu.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Menu

package js.nw

@:native("nw.Menu")

Represents a menubar or a context menu.

Static methods

staticinlinenewMenubar():Menu

Creates a new menubar.

Constructor

new(?options:{type:MenuType})

Creates a new menu.

Variables

finalitems:Array<MenuItem>

The menu items.

Methods

append(item:MenuItem):Void

Append an item to the tail of this menu.

createMacBuiltin(appName:String, ?options:{hideWindow:Null<Bool>, hideEdit:Null<Bool>}):Void

Creates the built-in menus within the menubar on Mac.

insert(item:MenuItem, position:Int):Void

Inserts the specified item at the given position of this menu.

popup(x:Int, y:Int):Void

Popups this context menu at the specified point in the current window.

remove(item:MenuItem):Void

Removes the specified item from this menu

removeAt(position:Int):Void

Removes the item at the specified position from this menu.

\ No newline at end of file +
View source

class Menu

package js.nw

@:native("nw.Menu")

Represents a menubar or a context menu.

Static methods

staticinlinenewMenubar():Menu

Creates a new menubar.

Constructor

new(?options:{type:MenuType})

Creates a new menu.

Variables

finalitems:Array<MenuItem>

The menu items.

Methods

append(item:MenuItem):Void

Append an item to the tail of this menu.

createMacBuiltin(appName:String, ?options:{hideWindow:Null<Bool>, hideEdit:Null<Bool>}):Void

Creates the built-in menus within the menubar on Mac.

insert(item:MenuItem, position:Int):Void

Inserts the specified item at the given position of this menu.

popup(x:Int, y:Int):Void

Popups this context menu at the specified point in the current window.

remove(item:MenuItem):Void

Removes the specified item from this menu

removeAt(position:Int):Void

Removes the item at the specified position from this menu.

\ No newline at end of file diff --git a/docs/api/js/nw/MenuItem.html b/docs/api/js/nw/MenuItem.html index 297f69d..1104d46 100644 --- a/docs/api/js/nw/MenuItem.html +++ b/docs/api/js/nw/MenuItem.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class MenuItem

package js.nw

extends EventEmitter

@:native("nw.MenuItem")

Represents an item in a menu.

Static methods

staticinlinenewSeparator():MenuItem

Creates a new menu separator.

Constructor

new(options:MenuItemOptions)

Creates a new menu item.

Variables

checked:Bool

Value indicating whether the checkbox is checked.

enabled:Bool

Value indicating whether this item is enabled.

icon:String

The item icon.

iconIsTemplate:Bool

Value indicating whether the item icon is treated as a template.

key:String

The key of the shortcut.

label:String

The item label.

modifiers:String

The modifiers of the shortcut.

submenu:Menu

The item submenu.

tooltip:String

The item tooltip.

finaltype:MenuItemType

The item type.

Methods

dynamicclick():Void

The callback invoked when the user activates this item.

\ No newline at end of file +
View source

class MenuItem

package js.nw

extends EventEmitter

@:native("nw.MenuItem")

Represents an item in a menu.

Static methods

staticinlinenewSeparator():MenuItem

Creates a new menu separator.

Constructor

new(options:MenuItemOptions)

Creates a new menu item.

Variables

checked:Bool

Value indicating whether the checkbox is checked.

enabled:Bool

Value indicating whether this item is enabled.

icon:String

The item icon.

iconIsTemplate:Bool

Value indicating whether the item icon is treated as a template.

key:String

The key of the shortcut.

label:String

The item label.

modifiers:String

The modifiers of the shortcut.

submenu:Menu

The item submenu.

tooltip:String

The item tooltip.

finaltype:MenuItemType

The item type.

Methods

dynamicclick():Void

The callback invoked when the user activates this item.

\ No newline at end of file diff --git a/docs/api/js/nw/MenuItemEvent.html b/docs/api/js/nw/MenuItemEvent.html index e4a8282..3a0c583 100644 --- a/docs/api/js/nw/MenuItemEvent.html +++ b/docs/api/js/nw/MenuItemEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract MenuItemEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.MenuItem

@:enum

Defines the events of a MenuItem instance.

Variables

@:value(cast "click")@:impl@:enuminlineread onlyClick:MenuItemEvent<() ‑> Void> = "click"

The click event.

\ No newline at end of file +
View source

enum abstract MenuItemEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.MenuItem

@:enum

Defines the events of a MenuItem instance.

Variables

@:value(cast "click")@:impl@:enuminlineread onlyClick:MenuItemEvent<() ‑> Void> = "click"

The click event.

\ No newline at end of file diff --git a/docs/api/js/nw/MenuItemOptions.html b/docs/api/js/nw/MenuItemOptions.html index 0dc3fa8..05a1edc 100644 --- a/docs/api/js/nw/MenuItemOptions.html +++ b/docs/api/js/nw/MenuItemOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef MenuItemOptions

package js.nw

import js.nw.MenuItem

Defines the options of a MenuItem instance.

Fields

@:optionaloptionaltype:Null<MenuItemType>

The item type.

@:optionaloptionaltooltip:Null<String>

The item tooltip.

@:optionaloptionalsubmenu:Null<Menu>

The item submenu.

@:optionaloptionalmodifiers:Null<String>

The modifiers of the shortcut.

@:optionaloptionallabel:Null<String>

The item label.

@:optionaloptionalkey:Null<String>

The key of the shortcut.

@:optionaloptionalicon:Null<String>

The item icon.

@:optionaloptionalenabled:Null<Bool>

Value indicating whether the item is enabled.

@:optionaloptionalclick:Null<() ‑> Void>

The callback to invoke when the user activates the item.

@:optionaloptionalchecked:Null<Bool>

Value indicating whether the checkbox is checked.

\ No newline at end of file +
View source

typedef MenuItemOptions

package js.nw

import js.nw.MenuItem

Defines the options of a MenuItem instance.

Fields

@:optionaloptionaltype:Null<MenuItemType>

The item type.

@:optionaloptionaltooltip:Null<String>

The item tooltip.

@:optionaloptionalsubmenu:Null<Menu>

The item submenu.

@:optionaloptionalmodifiers:Null<String>

The modifiers of the shortcut.

@:optionaloptionallabel:Null<String>

The item label.

@:optionaloptionalkey:Null<String>

The key of the shortcut.

@:optionaloptionalicon:Null<String>

The item icon.

@:optionaloptionalenabled:Null<Bool>

Value indicating whether the item is enabled.

@:optionaloptionalclick:Null<() ‑> Void>

The callback to invoke when the user activates the item.

@:optionaloptionalchecked:Null<Bool>

Value indicating whether the checkbox is checked.

\ No newline at end of file diff --git a/docs/api/js/nw/MenuItemType.html b/docs/api/js/nw/MenuItemType.html index cbfff58..ed7004a 100644 --- a/docs/api/js/nw/MenuItemType.html +++ b/docs/api/js/nw/MenuItemType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract MenuItemType(String)

package js.nw

to String

import js.nw.MenuItem

@:enum

Defines the type of a menu item.

Variables

@:value(cast "checkbox")@:impl@:enuminlineread onlyCheckbox:MenuItemType = "checkbox"

The menu item has a checkbox.

@:value(cast "normal")@:impl@:enuminlineread onlyNormal:MenuItemType = "normal"

The menu item is standard.

@:value(cast "separator")@:impl@:enuminlineread onlySeparator:MenuItemType = "separator"

The menu item is a separator.

\ No newline at end of file +
View source

enum abstract MenuItemType(String)

package js.nw

from String to String

import js.nw.MenuItem

@:enum

Defines the type of a menu item.

Variables

@:value(cast "checkbox")@:impl@:enuminlineread onlyCheckbox:MenuItemType = "checkbox"

The menu item has a checkbox.

@:value(cast "normal")@:impl@:enuminlineread onlyNormal:MenuItemType = "normal"

The menu item is standard.

@:value(cast "separator")@:impl@:enuminlineread onlySeparator:MenuItemType = "separator"

The menu item is a separator.

\ No newline at end of file diff --git a/docs/api/js/nw/MenuType.html b/docs/api/js/nw/MenuType.html index 7967d06..e8e191b 100644 --- a/docs/api/js/nw/MenuType.html +++ b/docs/api/js/nw/MenuType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract MenuType(String)

package js.nw

to String

import js.nw.Menu

@:enum

Defines the type of a menu.

Variables

@:value(cast "contextmenu")@:impl@:enuminlineread onlyContextMenu:MenuType = "contextmenu"

It's a context menu.

@:value(cast "menubar")@:impl@:enuminlineread onlyMenuBar:MenuType = "menubar"

It's a menubar.

\ No newline at end of file +
View source

enum abstract MenuType(String)

package js.nw

from String to String

import js.nw.Menu

@:enum

Defines the type of a menu.

Variables

@:value(cast "contextmenu")@:impl@:enuminlineread onlyContextMenu:MenuType = "contextmenu"

It's a context menu.

@:value(cast "menubar")@:impl@:enuminlineread onlyMenuBar:MenuType = "menubar"

It's a menubar.

\ No newline at end of file diff --git a/docs/api/js/nw/OnChangedCause.html b/docs/api/js/nw/OnChangedCause.html index 81d8a13..8d05ad2 100644 --- a/docs/api/js/nw/OnChangedCause.html +++ b/docs/api/js/nw/OnChangedCause.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract OnChangedCause(String)

package js.nw

to String

import js.nw.Cookies

@:enum

Defines the underlying reason behind a cookie change.

Variables

@:value(cast "evicted")@:impl@:enuminlineread onlyEvicted:OnChangedCause = "evicted"

The cookie was automatically removed due to garbage collection.

@:value(cast "expired")@:impl@:enuminlineread onlyExpired:OnChangedCause = "expired"

The cookie was automatically removed due to expiry.

@:value(cast "expired_overwrite")@:impl@:enuminlineread onlyExpiredOverwrite:OnChangedCause = "expired_overwrite"

The cookie was removed due to being overwritten with an already-expired expiration date.

@:value(cast "explicit")@:impl@:enuminlineread onlyExplicit:OnChangedCause = "explicit"

The cookie was inserted, or removed via an explicit call to remove.

@:value(cast "overwrite")@:impl@:enuminlineread onlyOverwrite:OnChangedCause = "overwrite"

The cookie was automatically removed due to a set call that overwrote it.

\ No newline at end of file +
View source

enum abstract OnChangedCause(String)

package js.nw

from String to String

import js.nw.Cookies

@:enum

Defines the underlying reason behind a cookie change.

Variables

@:value(cast "evicted")@:impl@:enuminlineread onlyEvicted:OnChangedCause = "evicted"

The cookie was automatically removed due to garbage collection.

@:value(cast "expired")@:impl@:enuminlineread onlyExpired:OnChangedCause = "expired"

The cookie was automatically removed due to expiry.

@:value(cast "expired_overwrite")@:impl@:enuminlineread onlyExpiredOverwrite:OnChangedCause = "expired_overwrite"

The cookie was removed due to being overwritten with an already-expired expiration date.

@:value(cast "explicit")@:impl@:enuminlineread onlyExplicit:OnChangedCause = "explicit"

The cookie was inserted, or removed via an explicit call to remove.

@:value(cast "overwrite")@:impl@:enuminlineread onlyOverwrite:OnChangedCause = "overwrite"

The cookie was automatically removed due to a set call that overwrote it.

\ No newline at end of file diff --git a/docs/api/js/nw/PrintCustomMargins.html b/docs/api/js/nw/PrintCustomMargins.html index d43d54a..4f496ef 100644 --- a/docs/api/js/nw/PrintCustomMargins.html +++ b/docs/api/js/nw/PrintCustomMargins.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef PrintCustomMargins

package js.nw

import js.nw.Printer

Represents the settings of custom margins.

Fields

marginTop:Int

The top margin.

marginRight:Int

The right margin.

marginLeft:Int

The left margin.

marginBottom:Int

The bottom margin.

\ No newline at end of file +
View source

typedef PrintCustomMargins

package js.nw

import js.nw.Printer

Represents the settings of custom margins.

Fields

marginTop:Int

The top margin.

marginRight:Int

The right margin.

marginLeft:Int

The left margin.

marginBottom:Int

The bottom margin.

\ No newline at end of file diff --git a/docs/api/js/nw/PrintMarginsType.html b/docs/api/js/nw/PrintMarginsType.html index ed26a4a..31ce990 100644 --- a/docs/api/js/nw/PrintMarginsType.html +++ b/docs/api/js/nw/PrintMarginsType.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract PrintMarginsType(Int)

package js.nw

to Int

import js.nw.Printer

@:enum

Defines the type of print margins.

Variables

@:value(cast 3)@:impl@:enuminlineread onlyCustom:PrintMarginsType = 3

Use custom margins.

@:value(cast 0)@:impl@:enuminlineread onlyDefault:PrintMarginsType = 0

Use the default margins.

@:value(cast 2)@:impl@:enuminlineread onlyMinimum:PrintMarginsType = 2

Use the minimum margins.

@:value(cast 1)@:impl@:enuminlineread onlyNoMargins:PrintMarginsType = 1

Do not use margins.

\ No newline at end of file +
View source

enum abstract PrintMarginsType(Int)

package js.nw

from Int to Int

import js.nw.Printer

@:enum

Defines the type of print margins.

Variables

@:value(cast 3)@:impl@:enuminlineread onlyCustom:PrintMarginsType = 3

Use custom margins.

@:value(cast 0)@:impl@:enuminlineread onlyDefault:PrintMarginsType = 0

Use the default margins.

@:value(cast 2)@:impl@:enuminlineread onlyMinimum:PrintMarginsType = 2

Use the minimum margins.

@:value(cast 1)@:impl@:enuminlineread onlyNoMargins:PrintMarginsType = 1

Do not use margins.

\ No newline at end of file diff --git a/docs/api/js/nw/PrintMediaSize.html b/docs/api/js/nw/PrintMediaSize.html index b617aa7..6bf538c 100644 --- a/docs/api/js/nw/PrintMediaSize.html +++ b/docs/api/js/nw/PrintMediaSize.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef PrintMediaSize

package js.nw

import js.nw.Printer

Represents a paper size specification.

Fields

width_microns:Int

The media width.

name:String

The media name.

is_default:Bool

Value indicating whether this media size is the default one.

height_microns:Int

The media height.

custom_display_name:String

The custom display name.

\ No newline at end of file +
View source

typedef PrintMediaSize

package js.nw

import js.nw.Printer

Represents a paper size specification.

Fields

width_microns:Int

The media width.

name:String

The media name.

is_default:Bool

Value indicating whether this media size is the default one.

height_microns:Int

The media height.

custom_display_name:String

The custom display name.

\ No newline at end of file diff --git a/docs/api/js/nw/PrintOptions.html b/docs/api/js/nw/PrintOptions.html index 80446fb..d0c7b85 100644 --- a/docs/api/js/nw/PrintOptions.html +++ b/docs/api/js/nw/PrintOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef PrintOptions

package js.nw

import js.nw.Printer

Defines the options of the Window.print() method.

Fields

@:optionaloptionalsilent:Null<Bool>

Value indicating whether to hide the flashing print preview dialog.

@:optionaloptionalshouldPrintBackgrounds:Null<Bool>

Value indicating whether to print CSS backgrounds.

@:optionaloptionalscaleFactor:Null<Int>

The scale factor.

@:optionaloptionalprinter:Null<String>

The device name of the printer.

@:optionaloptionalpdf_path:Null<String>

The path of the output file when printing to PDF.

@:optionaloptionalmediaSize:Null<PrintMediaSize>

The paper size specification.

@:optionaloptionalmarginsType:Null<PrintMarginsType>

The type of printer margins.

@:optionaloptionalmarginsCustom:Null<PrintCustomMargins>

The settings of custom margins.

@:optionaloptionallandscape:Null<Bool>

Value indicating whether to use landscape or portrait.

@:optionaloptionalheaderString:Null<String>

The string to replace the URL in the header.

@:optionaloptionalfooterString:Null<String>

The string to replace the URL in the footer.

@:optionaloptionalcopies:Null<Int>

The number of copies to print.

@:optionaloptionalautoprint:Null<Bool>

Value indicating whether to print without the need for user's interaction.

\ No newline at end of file +
View source

typedef PrintOptions

package js.nw

import js.nw.Printer

Defines the options of the Window.print() method.

Fields

@:optionaloptionalsilent:Null<Bool>

Value indicating whether to hide the flashing print preview dialog.

@:optionaloptionalshouldPrintBackgrounds:Null<Bool>

Value indicating whether to print CSS backgrounds.

@:optionaloptionalscaleFactor:Null<Int>

The scale factor.

@:optionaloptionalprinter:Null<String>

The device name of the printer.

@:optionaloptionalpdf_path:Null<String>

The path of the output file when printing to PDF.

@:optionaloptionalmediaSize:Null<PrintMediaSize>

The paper size specification.

@:optionaloptionalmarginsType:Null<PrintMarginsType>

The type of printer margins.

@:optionaloptionalmarginsCustom:Null<PrintCustomMargins>

The settings of custom margins.

@:optionaloptionallandscape:Null<Bool>

Value indicating whether to use landscape or portrait.

@:optionaloptionalheaderString:Null<String>

The string to replace the URL in the header.

@:optionaloptionalfooterString:Null<String>

The string to replace the URL in the footer.

@:optionaloptionalcopies:Null<Int>

The number of copies to print.

@:optionaloptionalautoprint:Null<Bool>

Value indicating whether to print without the need for user's interaction.

\ No newline at end of file diff --git a/docs/api/js/nw/Printer.html b/docs/api/js/nw/Printer.html index 313f0aa..7b7e877 100644 --- a/docs/api/js/nw/Printer.html +++ b/docs/api/js/nw/Printer.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef Printer

package js.nw

Represents a printer.

Fields

printerOptions:PrinterOptions

The printer options.

printerName:String

The printer name.

printerDescription:String

The printer description.

deviceName:String

The device name.

\ No newline at end of file +
View source

typedef Printer

package js.nw

Represents a printer.

Fields

printerOptions:PrinterOptions

The printer options.

printerName:String

The printer name.

printerDescription:String

The printer description.

deviceName:String

The device name.

\ No newline at end of file diff --git a/docs/api/js/nw/PrinterOptions.html b/docs/api/js/nw/PrinterOptions.html index c39bc7d..959510a 100644 --- a/docs/api/js/nw/PrinterOptions.html +++ b/docs/api/js/nw/PrinterOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

interface PrinterOptions

package js.nw

import js.nw.Printer

Defines the options of a Printer instance.

Variables

@:native("printer-location")printerLocation:String

The printer location.

@:native("printer-make-and-model")printerMakeAndModel:String

The printer make and model.

@:native("system_driverinfo")systemDriverInfo:String

Information about the system driver.

\ No newline at end of file +
View source

interface PrinterOptions

package js.nw

import js.nw.Printer

Defines the options of a Printer instance.

Variables

@:native("printer-location")printerLocation:String

The printer location.

@:native("printer-make-and-model")printerMakeAndModel:String

The printer make and model.

@:native("system_driverinfo")systemDriverInfo:String

Information about the system driver.

\ No newline at end of file diff --git a/docs/api/js/nw/SameSiteStatus.html b/docs/api/js/nw/SameSiteStatus.html index 05634c6..aec22a7 100644 --- a/docs/api/js/nw/SameSiteStatus.html +++ b/docs/api/js/nw/SameSiteStatus.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract SameSiteStatus(String)

package js.nw

to String

import js.nw.Cookies

@:enum

Defines the state of a cookie's SameSite attribute.

Variables

@:value(cast "lax")@:impl@:enuminlineread onlyLax:SameSiteStatus = "lax"

The cookie is set with SameSite=Lax.

@:value(cast "no_restriction")@:impl@:enuminlineread onlyNoRestriction:SameSiteStatus = "no_restriction"

The cookie is set with SameSite=None.

@:value(cast "strict")@:impl@:enuminlineread onlyStrict:SameSiteStatus = "strict"

The cookie is set with SameSite=Strict.

@:value(cast "unspecified")@:impl@:enuminlineread onlyUnspecified:SameSiteStatus = "unspecified"

The cookie is set without the SameSite attribute.

\ No newline at end of file +
View source

enum abstract SameSiteStatus(String)

package js.nw

from String to String

import js.nw.Cookies

@:enum

Defines the state of a cookie's SameSite attribute.

Variables

@:value(cast "lax")@:impl@:enuminlineread onlyLax:SameSiteStatus = "lax"

The cookie is set with SameSite=Lax.

@:value(cast "no_restriction")@:impl@:enuminlineread onlyNoRestriction:SameSiteStatus = "no_restriction"

The cookie is set with SameSite=None.

@:value(cast "strict")@:impl@:enuminlineread onlyStrict:SameSiteStatus = "strict"

The cookie is set with SameSite=Strict.

@:value(cast "unspecified")@:impl@:enuminlineread onlyUnspecified:SameSiteStatus = "unspecified"

The cookie is set without the SameSite attribute.

\ No newline at end of file diff --git a/docs/api/js/nw/Screen.html b/docs/api/js/nw/Screen.html index 8bd33de..d1e5364 100644 --- a/docs/api/js/nw/Screen.html +++ b/docs/api/js/nw/Screen.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Screen

package js.nw

@:native("nw.Screen")

A collection of APIs to query the screens connected to the computer.

Static variables

staticfinalread onlyDesktopCaptureMonitor:DesktopCaptureMonitor

The object used to monitor the changes of screens and windows on the desktop.

staticfinalread onlyscreens:Array<ScreenDefinition>

The list of screens connected to the computer.

Static methods

staticInit():Void

Initializes the Screen singleton object.

staticaddListener<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a listener that will be invoked whenever the specified event is triggered.

staticchooseDesktopMedia(sources:Array<DesktopMediaSource>, callback:EitherType<Bool, String> ‑> Void):Void

Shows the desktop media picker UI with the specified set of sources.

staticoff<T>(event:ScreenEvent<T>, listener:T):Screen

Removes the specified listener for the given event.

staticon<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a listener that will be invoked whenever the specified event is triggered.

staticonce<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a one-time listener that will be removed and then invoked whenever the next time event is triggered.

staticremoveListener<T>(event:ScreenEvent<T>, listener:T):Screen

Removes the specified listener for the given event.

\ No newline at end of file +
View source

class Screen

package js.nw

@:native("nw.Screen")

A collection of APIs to query the screens connected to the computer.

Static variables

staticfinalread onlyDesktopCaptureMonitor:DesktopCaptureMonitor

The object used to monitor the changes of screens and windows on the desktop.

staticfinalread onlyscreens:Array<ScreenDefinition>

The list of screens connected to the computer.

Static methods

staticInit():Void

Initializes the Screen singleton object.

staticaddListener<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a listener that will be invoked whenever the specified event is triggered.

staticchooseDesktopMedia(sources:Array<DesktopMediaSource>, callback:EitherType<Bool, String> ‑> Void):Void

Shows the desktop media picker UI with the specified set of sources.

staticoff<T>(event:ScreenEvent<T>, listener:T):Screen

Removes the specified listener for the given event.

staticon<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a listener that will be invoked whenever the specified event is triggered.

staticonce<T>(event:ScreenEvent<T>, listener:T):Screen

Adds a one-time listener that will be removed and then invoked whenever the next time event is triggered.

staticremoveListener<T>(event:ScreenEvent<T>, listener:T):Screen

Removes the specified listener for the given event.

\ No newline at end of file diff --git a/docs/api/js/nw/ScreenDefinition.html b/docs/api/js/nw/ScreenDefinition.html index a3f5c98..8cbdbbf 100644 --- a/docs/api/js/nw/ScreenDefinition.html +++ b/docs/api/js/nw/ScreenDefinition.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef ScreenDefinition

package js.nw

import js.nw.Screen

Defines the structure of a screen.

Fields

work_area:{y:Int, x:Int, width:Int, height:Int}

The usable area within the screen bounds.

touchSupport:Int

The number of touch points supported by the screen.

scaleFactor:Float

The scale factor.

rotation:Int

The angle of rotation applied to the screen.

isBuiltIn:Bool

Value indicating whether the screen is built-in.

id:Int

The screen identifier.

bounds:{y:Int, x:Int, width:Int, height:Int}

The physical screen resolution.

\ No newline at end of file +
View source

typedef ScreenDefinition

package js.nw

import js.nw.Screen

Defines the structure of a screen.

Fields

work_area:{y:Int, x:Int, width:Int, height:Int}

The usable area within the screen bounds.

touchSupport:Int

The number of touch points supported by the screen.

scaleFactor:Float

The scale factor.

rotation:Int

The angle of rotation applied to the screen.

isBuiltIn:Bool

Value indicating whether the screen is built-in.

id:Int

The screen identifier.

bounds:{y:Int, x:Int, width:Int, height:Int}

The physical screen resolution.

\ No newline at end of file diff --git a/docs/api/js/nw/ScreenEvent.html b/docs/api/js/nw/ScreenEvent.html index 3d1fa63..daa134f 100644 --- a/docs/api/js/nw/ScreenEvent.html +++ b/docs/api/js/nw/ScreenEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract ScreenEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Screen

@:enum

Defines the events of a Screen instance.

Variables

@:value(cast "displayAdded")@:impl@:enuminlineread onlyDisplayAdded:ScreenEvent<ScreenDefinition ‑> Void> = "displayAdded"

The displayAdded event.

@:value(cast "displayBoundsChanged")@:impl@:enuminlineread onlyDisplayBoundsChanged:ScreenEvent<ScreenDefinition ‑> Void> = "displayBoundsChanged"

The displayBoundsChanged event.

@:value(cast "displayRemoved")@:impl@:enuminlineread onlyDisplayRemoved:ScreenEvent<ScreenDefinition ‑> Void> = "displayRemoved"

The displayRemoved event.

\ No newline at end of file +
View source

enum abstract ScreenEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Screen

@:enum

Defines the events of a Screen instance.

Variables

@:value(cast "displayAdded")@:impl@:enuminlineread onlyDisplayAdded:ScreenEvent<ScreenDefinition ‑> Void> = "displayAdded"

The displayAdded event.

@:value(cast "displayBoundsChanged")@:impl@:enuminlineread onlyDisplayBoundsChanged:ScreenEvent<ScreenDefinition ‑> Void> = "displayBoundsChanged"

The displayBoundsChanged event.

@:value(cast "displayRemoved")@:impl@:enuminlineread onlyDisplayRemoved:ScreenEvent<ScreenDefinition ‑> Void> = "displayRemoved"

The displayRemoved event.

\ No newline at end of file diff --git a/docs/api/js/nw/Shell.html b/docs/api/js/nw/Shell.html index 86d5fef..3886ca7 100644 --- a/docs/api/js/nw/Shell.html +++ b/docs/api/js/nw/Shell.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Shell

package js.nw

@:native("nw.Shell")

A collection of APIs that do desktop related jobs.

Static methods

staticopenExternal(url:String):Void

Opens the given external URI in the desktop's default manner.

staticopenItem(filePath:String):Void

Opens the given file path in the desktop's default manner.

staticshowItemInFolder(filePath:String):Void

Shows the given file path in the parent folder with the file manager.

\ No newline at end of file +
View source

class Shell

package js.nw

@:native("nw.Shell")

A collection of APIs that do desktop related jobs.

Static methods

staticopenExternal(url:String):Void

Opens the given external URI in the desktop's default manner.

staticopenItem(filePath:String):Void

Opens the given file path in the desktop's default manner.

staticshowItemInFolder(filePath:String):Void

Shows the given file path in the parent folder with the file manager.

\ No newline at end of file diff --git a/docs/api/js/nw/Shortcut.html b/docs/api/js/nw/Shortcut.html index 5992494..d7619a8 100644 --- a/docs/api/js/nw/Shortcut.html +++ b/docs/api/js/nw/Shortcut.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Shortcut

package js.nw

extends EventEmitter

@:native("nw.Shortcut")

Represents a global keyboard shortcut, also known as system-wide hotkey.

Constructor

new(options:ShortcutOptions)

Creates a new shortcut.

Variables

finalkey:String

The key combinations of the shortcut.

Methods

dynamicactive():Void

The callback invoked when the hotkey is triggered.

dynamicfailed():Void

The callback invoked when failed to register the hotkey.

\ No newline at end of file +
View source

class Shortcut

package js.nw

extends EventEmitter

@:native("nw.Shortcut")

Represents a global keyboard shortcut, also known as system-wide hotkey.

Constructor

new(options:ShortcutOptions)

Creates a new shortcut.

Variables

finalkey:String

The key combinations of the shortcut.

Methods

dynamicactive():Void

The callback invoked when the hotkey is triggered.

dynamicfailed():Void

The callback invoked when failed to register the hotkey.

\ No newline at end of file diff --git a/docs/api/js/nw/ShortcutEvent.html b/docs/api/js/nw/ShortcutEvent.html index c8e1547..6e03481 100644 --- a/docs/api/js/nw/ShortcutEvent.html +++ b/docs/api/js/nw/ShortcutEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract ShortcutEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Shortcut

@:enum

Defines the events of a Shortcut instance.

Variables

@:value(cast "active")@:impl@:enuminlineread onlyActive:ShortcutEvent<() ‑> Void> = "active"

The active event.

@:value(cast "failed")@:impl@:enuminlineread onlyFailed:ShortcutEvent<() ‑> Void> = "failed"

The failed event.

\ No newline at end of file +
View source

enum abstract ShortcutEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Shortcut

@:enum

Defines the events of a Shortcut instance.

Variables

@:value(cast "active")@:impl@:enuminlineread onlyActive:ShortcutEvent<() ‑> Void> = "active"

The active event.

@:value(cast "failed")@:impl@:enuminlineread onlyFailed:ShortcutEvent<() ‑> Void> = "failed"

The failed event.

\ No newline at end of file diff --git a/docs/api/js/nw/ShortcutOptions.html b/docs/api/js/nw/ShortcutOptions.html index 24a309a..e91b89a 100644 --- a/docs/api/js/nw/ShortcutOptions.html +++ b/docs/api/js/nw/ShortcutOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef ShortcutOptions

package js.nw

import js.nw.Shortcut

Defines the options of a Shortcut instance.

Fields

key:String

The key combinations of the shortcut.

@:optionaloptionalfailed:Null<() ‑> Void>

The callback to invoke when failed to register the hotkey.

@:optionaloptionalactive:Null<() ‑> Void>

The callback to invoke when the hotkey is triggered.

\ No newline at end of file +
View source

typedef ShortcutOptions

package js.nw

import js.nw.Shortcut

Defines the options of a Shortcut instance.

Fields

key:String

The key combinations of the shortcut.

@:optionaloptionalfailed:Null<() ‑> Void>

The callback to invoke when failed to register the hotkey.

@:optionaloptionalactive:Null<() ‑> Void>

The callback to invoke when the hotkey is triggered.

\ No newline at end of file diff --git a/docs/api/js/nw/Tray.html b/docs/api/js/nw/Tray.html index 6b4a266..4bf35e6 100644 --- a/docs/api/js/nw/Tray.html +++ b/docs/api/js/nw/Tray.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Tray

package js.nw

extends EventEmitter

@:native("nw.Tray")

An abstraction of different controls on different platforms, usually it's a small icon shown on the OS's notification area.

Constructor

new(options:TrayOptions)

Creates a new tray.

Variables

alticon:String

The alternate icon.

icon:String

The tray icon.

iconsAreTemplates:Bool

Value indicating whether icons are treated as templates.

menu:Menu

The popup menu.

title:String

The tray title.

tooltip:String

The tray tooltip.

Methods

remove():Void

Removes the tray.

\ No newline at end of file +
View source

class Tray

package js.nw

extends EventEmitter

@:native("nw.Tray")

An abstraction of different controls on different platforms, usually it's a small icon shown on the OS's notification area.

Constructor

new(options:TrayOptions)

Creates a new tray.

Variables

alticon:String

The alternate icon.

icon:String

The tray icon.

iconsAreTemplates:Bool

Value indicating whether icons are treated as templates.

menu:Menu

The popup menu.

title:String

The tray title.

tooltip:String

The tray tooltip.

Methods

remove():Void

Removes the tray.

\ No newline at end of file diff --git a/docs/api/js/nw/TrayEvent.html b/docs/api/js/nw/TrayEvent.html index 8ee7c2f..fbf64cc 100644 --- a/docs/api/js/nw/TrayEvent.html +++ b/docs/api/js/nw/TrayEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract TrayEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Tray

@:enum

Defines the events of a Tray instance.

Variables

@:value(cast "click")@:impl@:enuminlineread onlyClick:TrayEvent<() ‑> Void> = "click"

The click event.

\ No newline at end of file +
View source

enum abstract TrayEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Tray

@:enum

Defines the events of a Tray instance.

Variables

@:value(cast "click")@:impl@:enuminlineread onlyClick:TrayEvent<() ‑> Void> = "click"

The click event.

\ No newline at end of file diff --git a/docs/api/js/nw/TrayOptions.html b/docs/api/js/nw/TrayOptions.html index 9cb3e43..a5a9f0a 100644 --- a/docs/api/js/nw/TrayOptions.html +++ b/docs/api/js/nw/TrayOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef TrayOptions

package js.nw

import js.nw.Tray

Defines the options of a Tray instance.

Fields

@:optionaloptionaltooltip:Null<String>

The tray tooltip.

@:optionaloptionaltitle:Null<String>

The tray title.

@:optionaloptionalmenu:Null<Menu>

The popup menu.

@:optionaloptionaliconsAreTemplates:Null<Bool>

Value indicating whether icons are treated as templates.

@:optionaloptionalicon:Null<String>

The tray icon.

@:optionaloptionalalticon:Null<String>

The alternate icon.

\ No newline at end of file +
View source

typedef TrayOptions

package js.nw

import js.nw.Tray

Defines the options of a Tray instance.

Fields

@:optionaloptionaltooltip:Null<String>

The tray tooltip.

@:optionaloptionaltitle:Null<String>

The tray title.

@:optionaloptionalmenu:Null<Menu>

The popup menu.

@:optionaloptionaliconsAreTemplates:Null<Bool>

Value indicating whether icons are treated as templates.

@:optionaloptionalicon:Null<String>

The tray icon.

@:optionaloptionalalticon:Null<String>

The alternate icon.

\ No newline at end of file diff --git a/docs/api/js/nw/Window.html b/docs/api/js/nw/Window.html index 539eb0d..9779582 100644 --- a/docs/api/js/nw/Window.html +++ b/docs/api/js/nw/Window.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

class Window

package js.nw

extends EventEmitter

@:native("nw.Window")

A wrapper of the DOM's topmost window object.

Static methods

staticget(?windowObject:DomWindow):Window

Returns the window object.

staticgetAll(callback:Array<Window> ‑> Void):Void

Returns all windows.

staticopen(url:String, ?callback:Window ‑> Void):Void

staticopen(url:String, options:WindowOpenOptions, ?callback:Window ‑> Void):Void

Open a new window and loads the specified URL in it.

Variables

finalcookies:Cookies

The cookies manager.

height:Int

The window's height.

finalisAlwaysOnTop:Bool

Value indicating whether this window is always on top of other windows.

finalisFullscreen:Bool

Value indicating whether the fullscreen mode is enabled.

finalisKioskMode:Bool

Value indicating whether the kiosk mode is enabled.

finalisTransparent:Bool

Value indicating whether the transparency is enabled.

menu:Menu

The window's menubar.

title:String

The window's title.

width:Int

The window's width.

finalwindow:DomWindow

The underlying DOM window object.

x:Int

The left offset from window frame to screen.

y:Int

The top offset from window frame to screen.

zoomLevel:Float

The page zoom.

Methods

blur():Void

Moves the focus away.

canSetVisibleOnAllWorkspaces():Bool

Gets a value indicating whether the platform supports the setVisibleOnAllWorkspaces() method.

capturePage(callback:EitherType<Buffer, String> ‑> Void, ?options:EitherType<CapturePageOptions, String>):Void

Captures the visible area of this window.

captureScreenshot(options:CaptureScreenshotOptions):Promise<String>

captureScreenshot(options:CaptureScreenshotOptions, callback:(Null<Error>, String) ‑> Void):Promise<String>

Captures a portion of this window.

close(?force:Bool):Void

Closes this window.

closeDevTools():Void

Close the development tools window.

enterFullscreen():Void

Enters the fullscreen mode.

enterKioskMode():Void

Enters the kiosk mode.

eval(frame:Null<IFrameElement>, script:String):Void

Executes a piece of JavaScript.

evalNWBin(frame:Null<IFrameElement>, path:EitherType<ArrayBuffer, EitherType<Buffer, String>>):Void

Loads and executes a compiled binary.

evalNWBinModule(frame:Null<IFrameElement>, path:EitherType<ArrayBuffer, EitherType<Buffer, String>>, modulePath:String):Void

Loads and executes a compiled binary for modules.

focus():Void

Puts the focus on this window.

getPrinters(callback:Array<Printer>):Void

Enumerates the printers in the system.

hide():Void

Hides this window.

isDevToolsOpen():Bool

Returns a value indicating whether the development tools window is open.

leaveFullscreen():Void

Leaves the fullscreen mode.

leaveKioskMode():Void

Leaves the kiosk mode.

maximize():Void

Maximizes this window.

minimize():Void

Minimizes this window.

moveBy(x:Int, y:Int):Void

Moves this window a specified number of pixels relative to its current coordinates.

moveTo(x:Int, y:Int):Void

Moves this window's left and top edge to the specified coordinates.

print(options:PrintOptions):Void

Print the web contents in the window.

reload():Void

Reloads this window.

reloadDev():Void

Reloads this window by starting a new renderer process from scratch.

reloadIgnoringCache():Void

Reloads this window by ignoring caches.

requestAttention(attention:EitherType<Bool, Int>):Void

Request the user's attention by making the window flashes in the task bar.

resizeBy(width:Int, height:Int):Void

Resizes this window by the specified width and height

resizeTo(width:Int, height:Int):Void

Resizes this window to the specified width and height.

restore():Void

Restores this window to its previous state.

setAlwaysOnTop(isAlwaysOnTop:Bool):Void

Sets this window to be on top of all other windows in the window system.

setBadgeLabel(label:String):Void

Sets the badge label on the window icon in taskbar or dock.

setInnerHeight(height:Int):Void

Sets the inner height of this window.

setInnerWidth(width:Int):Void

Sets the inner width of this window.

setMaximumSize(width:Int, height:Int):Void

Sets the window's maximum size.

setMinimumSize(width:Int, height:Int):Void

Sets the window's minimum size.

setPosition(position:WindowPosition):Void

Moves this window to the specified position.

setProgressBar(progress:Float):Void

Sets the progress bar on the window icon in taskbar or dock.

setResizable(isResizable:Bool):Void

Sets whether this window is resizable.

setShadow(hasShadow:Bool):Void

Enables or disables the window's native shadow.

setShowInTaskbar(isShown:Bool):Void

Controls whether to show this window in taskbar or dock.

setTransparent(transparent:Bool):Void

Deprecated: "This feature is deprecated since 0.13.0."

Turns on/off the transparency support.

setVisibleOnAllWorkspaces(isVisible:Bool):Void

Controls whether this window is visible on all workspaces simultaneously.

show(?isShown:Bool):Void

Shows this window.

showDevTools(?callback:Window ‑> Void):Void

showDevTools(iframe:EitherType<IFrameElement, String>, ?callback:Window ‑> Void):Void

Opens the development tools to inspect this window.

toggleFullscreen():Void

Toggles the fullscreen mode.

toggleKioskMode():Void

Toggles the kiosk mode.

unmaximize():Void

Deprecated: "This feature is deprecated since 0.13.0."

Unmaximizes this window.

\ No newline at end of file +
View source

class Window

package js.nw

extends EventEmitter

@:native("nw.Window")

A wrapper of the DOM's topmost window object.

Static methods

staticget(?windowObject:DomWindow):Window

Returns the window object.

staticgetAll(callback:Array<Window> ‑> Void):Void

Returns all windows.

staticopen(url:String, ?callback:Window ‑> Void):Void

staticopen(url:String, options:WindowOpenOptions, ?callback:Window ‑> Void):Void

Open a new window and loads the specified URL in it.

Variables

finalcookies:Cookies

The cookies manager.

height:Int

The window's height.

finalisAlwaysOnTop:Bool

Value indicating whether this window is always on top of other windows.

finalisFullscreen:Bool

Value indicating whether the fullscreen mode is enabled.

finalisKioskMode:Bool

Value indicating whether the kiosk mode is enabled.

finalisTransparent:Bool

Value indicating whether the transparency is enabled.

menu:Menu

The window's menubar.

title:String

The window's title.

width:Int

The window's width.

finalwindow:DomWindow

The underlying DOM window object.

x:Int

The left offset from window frame to screen.

y:Int

The top offset from window frame to screen.

zoomLevel:Float

The page zoom.

Methods

blur():Void

Moves the focus away.

canSetVisibleOnAllWorkspaces():Bool

Gets a value indicating whether the platform supports the setVisibleOnAllWorkspaces() method.

capturePage(callback:EitherType<Buffer, String> ‑> Void, ?options:EitherType<CapturePageOptions, String>):Void

Captures the visible area of this window.

captureScreenshot(options:CaptureScreenshotOptions):Promise<String>

captureScreenshot(options:CaptureScreenshotOptions, callback:(Null<Error>, String) ‑> Void):Promise<String>

Captures a portion of this window.

close(?force:Bool):Void

Closes this window.

closeDevTools():Void

Close the development tools window.

enterFullscreen():Void

Enters the fullscreen mode.

enterKioskMode():Void

Enters the kiosk mode.

eval(frame:Null<IFrameElement>, script:String):Void

Executes a piece of JavaScript.

evalNWBin(frame:Null<IFrameElement>, path:EitherType<ArrayBuffer, EitherType<Buffer, String>>):Void

Loads and executes a compiled binary.

evalNWBinModule(frame:Null<IFrameElement>, path:EitherType<ArrayBuffer, EitherType<Buffer, String>>, modulePath:String):Void

Loads and executes a compiled binary for modules.

focus():Void

Puts the focus on this window.

getPrinters(callback:Array<Printer>):Void

Enumerates the printers in the system.

hide():Void

Hides this window.

isDevToolsOpen():Bool

Returns a value indicating whether the development tools window is open.

leaveFullscreen():Void

Leaves the fullscreen mode.

leaveKioskMode():Void

Leaves the kiosk mode.

maximize():Void

Maximizes this window.

minimize():Void

Minimizes this window.

moveBy(x:Int, y:Int):Void

Moves this window a specified number of pixels relative to its current coordinates.

moveTo(x:Int, y:Int):Void

Moves this window's left and top edge to the specified coordinates.

print(options:PrintOptions):Void

Print the web contents in the window.

reload():Void

Reloads this window.

reloadDev():Void

Reloads this window by starting a new renderer process from scratch.

reloadIgnoringCache():Void

Reloads this window by ignoring caches.

requestAttention(attention:EitherType<Bool, Int>):Void

Request the user's attention by making the window flashes in the task bar.

resizeBy(width:Int, height:Int):Void

Resizes this window by the specified width and height

resizeTo(width:Int, height:Int):Void

Resizes this window to the specified width and height.

restore():Void

Restores this window to its previous state.

setAlwaysOnTop(isAlwaysOnTop:Bool):Void

Sets this window to be on top of all other windows in the window system.

setBadgeLabel(label:String):Void

Sets the badge label on the window icon in taskbar or dock.

setInnerHeight(height:Int):Void

Sets the inner height of this window.

setInnerWidth(width:Int):Void

Sets the inner width of this window.

setMaximumSize(width:Int, height:Int):Void

Sets the window's maximum size.

setMinimumSize(width:Int, height:Int):Void

Sets the window's minimum size.

setPosition(position:WindowPosition):Void

Moves this window to the specified position.

setProgressBar(progress:Float):Void

Sets the progress bar on the window icon in taskbar or dock.

setResizable(isResizable:Bool):Void

Sets whether this window is resizable.

setShadow(hasShadow:Bool):Void

Enables or disables the window's native shadow.

setShowInTaskbar(isShown:Bool):Void

Controls whether to show this window in taskbar or dock.

setTransparent(transparent:Bool):Void

Deprecated: "This feature is deprecated since 0.13.0."

Turns on/off the transparency support.

setVisibleOnAllWorkspaces(isVisible:Bool):Void

Controls whether this window is visible on all workspaces simultaneously.

show(?isShown:Bool):Void

Shows this window.

showDevTools(?callback:Window ‑> Void):Void

showDevTools(iframe:EitherType<IFrameElement, String>, ?callback:Window ‑> Void):Void

Opens the development tools to inspect this window.

toggleFullscreen():Void

Toggles the fullscreen mode.

toggleKioskMode():Void

Toggles the kiosk mode.

unmaximize():Void

Deprecated: "This feature is deprecated since 0.13.0."

Unmaximizes this window.

\ No newline at end of file diff --git a/docs/api/js/nw/WindowEvent.html b/docs/api/js/nw/WindowEvent.html index 882f918..fe8c74f 100644 --- a/docs/api/js/nw/WindowEvent.html +++ b/docs/api/js/nw/WindowEvent.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract WindowEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Window

@:enum

Defines the events of a Window instance.

Variables

@:value(cast "blur")@:impl@:enuminlineread onlyBlur:WindowEvent<() ‑> Void> = "blur"

The blur event.

@:value(cast "capturepagedone")@:impl@:enuminlineread onlyCapturePageDone:WindowEvent<() ‑> Void> = "capturepagedone"

Deprecated: "This feature is deprecated since 0.13.0."

The capturepagedone event.

@:value(cast "close")@:impl@:enuminlineread onlyClose:WindowEvent<() ‑> Void> = "close"

The close event.

@:value(cast "closed")@:impl@:enuminlineread onlyClosed:WindowEvent<() ‑> Void> = "closed"

The closed event.

@:value(cast "devtools-closed")@:impl@:enuminlineread onlyDevToolsClosed:WindowEvent<() ‑> Void> = "devtools-closed"

The devtools-closed event.

@:value(cast "devtools-opened")@:impl@:enuminlineread onlyDevToolsOpened:WindowEvent<String ‑> Void> = "devtools-opened"

Deprecated: "This feature is deprecated since 0.13.0."

The devtools-opened event.

@:value(cast "document-end")@:impl@:enuminlineread onlyDocumentEnd:WindowEvent<Null<IFrameElement> ‑> Void> = "document-end"

The document-end event.

@:value(cast "document-start")@:impl@:enuminlineread onlyDocumentStart:WindowEvent<Null<IFrameElement> ‑> Void> = "document-start"

The document-start event.

@:value(cast "enter-fullscreen")@:impl@:enuminlineread onlyEnterFullscreen:WindowEvent<() ‑> Void> = "enter-fullscreen"

The enter-fullscreen event.

@:value(cast "focus")@:impl@:enuminlineread onlyFocus:WindowEvent<() ‑> Void> = "focus"

The focus event.

@:value(cast "leave-fullscreen")@:impl@:enuminlineread onlyLeaveFullscreen:WindowEvent<() ‑> Void> = "leave-fullscreen"

Deprecated: "This feature is deprecated since 0.13.0."

The leave-fullscreen event.

@:value(cast "loaded")@:impl@:enuminlineread onlyLoaded:WindowEvent<() ‑> Void> = "loaded"

The loaded event.

@:value(cast "loading")@:impl@:enuminlineread onlyLoading:WindowEvent<() ‑> Void> = "loading"

The loading event.

@:value(cast "maximize")@:impl@:enuminlineread onlyMaximize:WindowEvent<() ‑> Void> = "maximize"

The maximize event.

@:value(cast "minimize")@:impl@:enuminlineread onlyMinimize:WindowEvent<() ‑> Void> = "minimize"

The minimize event.

@:value(cast "move")@:impl@:enuminlineread onlyMove:WindowEvent<(Int, Int) ‑> Void> = "move"

The move event.

@:value(cast "navigation")@:impl@:enuminlineread onlyNavigation:WindowEvent<(Null<IFrameElement>, String, WindowPolicy) ‑> Void> = "navigation"

The navigation event.

@:value(cast "new-win-policy")@:impl@:enuminlineread onlyNewWinPolicy:WindowEvent<(Null<IFrameElement>, String, WindowPolicy) ‑> Void> = "new-win-policy"

The new-win-policy event.

@:value(cast "resize")@:impl@:enuminlineread onlyResize:WindowEvent<(Int, Int) ‑> Void> = "resize"

The resize event.

@:value(cast "restore")@:impl@:enuminlineread onlyRestore:WindowEvent<() ‑> Void> = "restore"

The restore event.

@:value(cast "zoom")@:impl@:enuminlineread onlyZoom:WindowEvent<Float ‑> Void> = "zoom"

The zoom event.

\ No newline at end of file +
View source

enum abstract WindowEvent<T>(Event<T>)

package js.nw

to Event<T>

import js.nw.Window

@:enum

Defines the events of a Window instance.

Variables

@:value(cast "blur")@:impl@:enuminlineread onlyBlur:WindowEvent<() ‑> Void> = "blur"

The blur event.

@:value(cast "capturepagedone")@:impl@:enuminlineread onlyCapturePageDone:WindowEvent<() ‑> Void> = "capturepagedone"

Deprecated: "This feature is deprecated since 0.13.0."

The capturepagedone event.

@:value(cast "close")@:impl@:enuminlineread onlyClose:WindowEvent<() ‑> Void> = "close"

The close event.

@:value(cast "closed")@:impl@:enuminlineread onlyClosed:WindowEvent<() ‑> Void> = "closed"

The closed event.

@:value(cast "devtools-closed")@:impl@:enuminlineread onlyDevToolsClosed:WindowEvent<() ‑> Void> = "devtools-closed"

The devtools-closed event.

@:value(cast "devtools-opened")@:impl@:enuminlineread onlyDevToolsOpened:WindowEvent<String ‑> Void> = "devtools-opened"

Deprecated: "This feature is deprecated since 0.13.0."

The devtools-opened event.

@:value(cast "document-end")@:impl@:enuminlineread onlyDocumentEnd:WindowEvent<Null<IFrameElement> ‑> Void> = "document-end"

The document-end event.

@:value(cast "document-start")@:impl@:enuminlineread onlyDocumentStart:WindowEvent<Null<IFrameElement> ‑> Void> = "document-start"

The document-start event.

@:value(cast "enter-fullscreen")@:impl@:enuminlineread onlyEnterFullscreen:WindowEvent<() ‑> Void> = "enter-fullscreen"

The enter-fullscreen event.

@:value(cast "focus")@:impl@:enuminlineread onlyFocus:WindowEvent<() ‑> Void> = "focus"

The focus event.

@:value(cast "leave-fullscreen")@:impl@:enuminlineread onlyLeaveFullscreen:WindowEvent<() ‑> Void> = "leave-fullscreen"

Deprecated: "This feature is deprecated since 0.13.0."

The leave-fullscreen event.

@:value(cast "loaded")@:impl@:enuminlineread onlyLoaded:WindowEvent<() ‑> Void> = "loaded"

The loaded event.

@:value(cast "loading")@:impl@:enuminlineread onlyLoading:WindowEvent<() ‑> Void> = "loading"

The loading event.

@:value(cast "maximize")@:impl@:enuminlineread onlyMaximize:WindowEvent<() ‑> Void> = "maximize"

The maximize event.

@:value(cast "minimize")@:impl@:enuminlineread onlyMinimize:WindowEvent<() ‑> Void> = "minimize"

The minimize event.

@:value(cast "move")@:impl@:enuminlineread onlyMove:WindowEvent<(Int, Int) ‑> Void> = "move"

The move event.

@:value(cast "navigation")@:impl@:enuminlineread onlyNavigation:WindowEvent<(Null<IFrameElement>, String, WindowPolicy) ‑> Void> = "navigation"

The navigation event.

@:value(cast "new-win-policy")@:impl@:enuminlineread onlyNewWinPolicy:WindowEvent<(Null<IFrameElement>, String, WindowPolicy) ‑> Void> = "new-win-policy"

The new-win-policy event.

@:value(cast "resize")@:impl@:enuminlineread onlyResize:WindowEvent<(Int, Int) ‑> Void> = "resize"

The resize event.

@:value(cast "restore")@:impl@:enuminlineread onlyRestore:WindowEvent<() ‑> Void> = "restore"

The restore event.

@:value(cast "zoom")@:impl@:enuminlineread onlyZoom:WindowEvent<Float ‑> Void> = "zoom"

The zoom event.

\ No newline at end of file diff --git a/docs/api/js/nw/WindowManifest.html b/docs/api/js/nw/WindowManifest.html index c602d75..2baae7e 100644 --- a/docs/api/js/nw/WindowManifest.html +++ b/docs/api/js/nw/WindowManifest.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef WindowManifest

package js.nw

import js.nw.Window

Defines the manifest of a Window instance.

Fields

@:optionaloptionalwidth:Null<Int>

The initial inner width of the main window.

@:optionaloptionalvisible_on_all_workspaces:Null<Bool>

Value indicating whether the window should be visible on all workspaces simultaneously.

@:optionaloptionaltransparent:Null<Bool>

Value indicating whether to turn on transparency.

@:optionaloptionaltitle:Null<String>

The default title of windows.

@:optionaloptionalshow_in_taskbar:Null<Bool>

Value indicating whether the window is shown in the taskbar or dock.

@:optionaloptionalshow:Null<Bool>

Value indicating whether to show the window on startup.

@:optionaloptionalresizable:Null<Bool>

Value indicating whether the window is resizable.

@:optionaloptionalposition:Null<WindowPosition>

Value indicating where the window will be positioned.

@:optionaloptionalmin_width:Null<Bool>

The minimum inner width of the window.

@:optionaloptionalmin_height:Null<Bool>

The minimum inner height of the window.

@:optionaloptionalmax_width:Null<Bool>

The maximum inner width of the window.

@:optionaloptionalmax_height:Null<Bool>

The maximum inner height of the window.

@:optionaloptionalkiosk:Null<Bool>

Value indicating whether to use the kiosk mode.

@:optionaloptionalid:Null<String>

The window identifier.

@:optionaloptionalicon:Null<String>

The path to the window's icon.

@:optionaloptionalheight:Null<Int>

The initial inner height of the main window.

@:optionaloptionalfullscreen:Null<Bool>

Value indicating whether the window is fullscreen.

@:optionaloptionalframe:Null<Bool>

Value indicating whether the window is frameless.

@:optionaloptionalas_desktop:Null<Bool>

Value indicating whether to show the window as desktop background window under X11 environment.

@:optionaloptionalalways_on_top:Null<Bool>

Value indicating whether the window should always stay on top of other windows.

\ No newline at end of file +
View source

typedef WindowManifest

package js.nw

import js.nw.Window

Defines the manifest of a Window instance.

Fields

@:optionaloptionalwidth:Null<Int>

The initial inner width of the main window.

@:optionaloptionalvisible_on_all_workspaces:Null<Bool>

Value indicating whether the window should be visible on all workspaces simultaneously.

@:optionaloptionaltransparent:Null<Bool>

Value indicating whether to turn on transparency.

@:optionaloptionaltitle:Null<String>

The default title of windows.

@:optionaloptionalshow_in_taskbar:Null<Bool>

Value indicating whether the window is shown in the taskbar or dock.

@:optionaloptionalshow:Null<Bool>

Value indicating whether to show the window on startup.

@:optionaloptionalresizable:Null<Bool>

Value indicating whether the window is resizable.

@:optionaloptionalposition:Null<WindowPosition>

Value indicating where the window will be positioned.

@:optionaloptionalmin_width:Null<Bool>

The minimum inner width of the window.

@:optionaloptionalmin_height:Null<Bool>

The minimum inner height of the window.

@:optionaloptionalmax_width:Null<Bool>

The maximum inner width of the window.

@:optionaloptionalmax_height:Null<Bool>

The maximum inner height of the window.

@:optionaloptionalkiosk:Null<Bool>

Value indicating whether to use the kiosk mode.

@:optionaloptionalid:Null<String>

The window identifier.

@:optionaloptionalicon:Null<String>

The path to the window's icon.

@:optionaloptionalheight:Null<Int>

The initial inner height of the main window.

@:optionaloptionalfullscreen:Null<Bool>

Value indicating whether the window is fullscreen.

@:optionaloptionalframe:Null<Bool>

Value indicating whether the window is frameless.

@:optionaloptionalas_desktop:Null<Bool>

Value indicating whether to show the window as desktop background window under X11 environment.

@:optionaloptionalalways_on_top:Null<Bool>

Value indicating whether the window should always stay on top of other windows.

\ No newline at end of file diff --git a/docs/api/js/nw/WindowOpenOptions.html b/docs/api/js/nw/WindowOpenOptions.html index 68e2db7..1a49ffc 100644 --- a/docs/api/js/nw/WindowOpenOptions.html +++ b/docs/api/js/nw/WindowOpenOptions.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef WindowOpenOptions

package js.nw

import js.nw.Window

Defines the options of the Window.open() method.

Fields

@:optionaloptionalwidth:Null<Int>

The initial inner width of the main window.

@:optionaloptionalvisible_on_all_workspaces:Null<Bool>

Value indicating whether the window should be visible on all workspaces simultaneously.

@:optionaloptionaltransparent:Null<Bool>

Value indicating whether to turn on transparency.

@:optionaloptionaltitle:Null<String>

The default title of windows.

@:optionaloptionalshow_in_taskbar:Null<Bool>

Value indicating whether the window is shown in the taskbar or dock.

@:optionaloptionalshow:Null<Bool>

Value indicating whether to show the window on startup.

@:optionaloptionalresizable:Null<Bool>

Value indicating whether the window is resizable.

@:optionaloptionalposition:Null<WindowPosition>

Value indicating where the window will be positioned.

@:optionaloptionalnew_instance:Null<Bool>

Value indicating whether to open the new window in a separate render process.

@:optionaloptionalmixed_context:Null<Bool>

Value indicating whether the Node.js and DOM contexts are merged in the new window's process.

@:optionaloptionalmin_width:Null<Bool>

The minimum inner width of the window.

@:optionaloptionalmin_height:Null<Bool>

The minimum inner height of the window.

@:optionaloptionalmax_width:Null<Bool>

The maximum inner width of the window.

@:optionaloptionalmax_height:Null<Bool>

The maximum inner height of the window.

@:optionaloptionalkiosk:Null<Bool>

Value indicating whether to use the kiosk mode.

@:optionaloptionalinject_js_start:Null<String>

The script to be injected before any DOM is constructed and any script is run.

@:optionaloptionalinject_js_end:Null<String>

The script to be injected after the DOM is loaded, before the onload event is fired.

@:optionaloptionalid:Null<String>

The window identifier.

@:optionaloptionalicon:Null<String>

The path to the window's icon.

@:optionaloptionalheight:Null<Int>

The initial inner height of the main window.

@:optionaloptionalfullscreen:Null<Bool>

Value indicating whether the window is fullscreen.

@:optionaloptionalframe:Null<Bool>

Value indicating whether the window is frameless.

@:optionaloptionalas_desktop:Null<Bool>

Value indicating whether to show the window as desktop background window under X11 environment.

@:optionaloptionalalways_on_top:Null<Bool>

Value indicating whether the window should always stay on top of other windows.

\ No newline at end of file +
View source

typedef WindowOpenOptions

package js.nw

import js.nw.Window

Defines the options of the Window.open() method.

Fields

@:optionaloptionalwidth:Null<Int>

The initial inner width of the main window.

@:optionaloptionalvisible_on_all_workspaces:Null<Bool>

Value indicating whether the window should be visible on all workspaces simultaneously.

@:optionaloptionaltransparent:Null<Bool>

Value indicating whether to turn on transparency.

@:optionaloptionaltitle:Null<String>

The default title of windows.

@:optionaloptionalshow_in_taskbar:Null<Bool>

Value indicating whether the window is shown in the taskbar or dock.

@:optionaloptionalshow:Null<Bool>

Value indicating whether to show the window on startup.

@:optionaloptionalresizable:Null<Bool>

Value indicating whether the window is resizable.

@:optionaloptionalposition:Null<WindowPosition>

Value indicating where the window will be positioned.

@:optionaloptionalnew_instance:Null<Bool>

Value indicating whether to open the new window in a separate render process.

@:optionaloptionalmixed_context:Null<Bool>

Value indicating whether the Node.js and DOM contexts are merged in the new window's process.

@:optionaloptionalmin_width:Null<Bool>

The minimum inner width of the window.

@:optionaloptionalmin_height:Null<Bool>

The minimum inner height of the window.

@:optionaloptionalmax_width:Null<Bool>

The maximum inner width of the window.

@:optionaloptionalmax_height:Null<Bool>

The maximum inner height of the window.

@:optionaloptionalkiosk:Null<Bool>

Value indicating whether to use the kiosk mode.

@:optionaloptionalinject_js_start:Null<String>

The script to be injected before any DOM is constructed and any script is run.

@:optionaloptionalinject_js_end:Null<String>

The script to be injected after the DOM is loaded, before the onload event is fired.

@:optionaloptionalid:Null<String>

The window identifier.

@:optionaloptionalicon:Null<String>

The path to the window's icon.

@:optionaloptionalheight:Null<Int>

The initial inner height of the main window.

@:optionaloptionalfullscreen:Null<Bool>

Value indicating whether the window is fullscreen.

@:optionaloptionalframe:Null<Bool>

Value indicating whether the window is frameless.

@:optionaloptionalas_desktop:Null<Bool>

Value indicating whether to show the window as desktop background window under X11 environment.

@:optionaloptionalalways_on_top:Null<Bool>

Value indicating whether the window should always stay on top of other windows.

\ No newline at end of file diff --git a/docs/api/js/nw/WindowPolicy.html b/docs/api/js/nw/WindowPolicy.html index f9bdac2..d0e0438 100644 --- a/docs/api/js/nw/WindowPolicy.html +++ b/docs/api/js/nw/WindowPolicy.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

typedef WindowPolicy

package js.nw

import js.nw.Window

Defines the policy of a Window instance.

Fields

@:optionaloptionalsetNewWindowManifest:Null<WindowManifest ‑> Void>

Controls the options for the new popup window.

ignore:() ‑> Void

Ignores the request.

@:optionaloptionalforceNewWindow:Null<() ‑> Void>

Forces the link to be opened in a new window.

@:optionaloptionalforceNewPopup:Null<() ‑> Void>

Forces the link to be opened in a new popup window.

@:optionaloptionalforceDownload:Null<() ‑> Void>

Forces the link to be downloaded or opened by an external program.

@:optionaloptionalforceCurrent:Null<() ‑> Void>

Forces the link to be opened in the same frame.

\ No newline at end of file +
View source

typedef WindowPolicy

package js.nw

import js.nw.Window

Defines the policy of a Window instance.

Fields

@:optionaloptionalsetNewWindowManifest:Null<WindowManifest ‑> Void>

Controls the options for the new popup window.

ignore:() ‑> Void

Ignores the request.

@:optionaloptionalforceNewWindow:Null<() ‑> Void>

Forces the link to be opened in a new window.

@:optionaloptionalforceNewPopup:Null<() ‑> Void>

Forces the link to be opened in a new popup window.

@:optionaloptionalforceDownload:Null<() ‑> Void>

Forces the link to be downloaded or opened by an external program.

@:optionaloptionalforceCurrent:Null<() ‑> Void>

Forces the link to be opened in the same frame.

\ No newline at end of file diff --git a/docs/api/js/nw/WindowPosition.html b/docs/api/js/nw/WindowPosition.html index e3bde7f..ebd5a5d 100644 --- a/docs/api/js/nw/WindowPosition.html +++ b/docs/api/js/nw/WindowPosition.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -
View source

enum abstract WindowPosition(String)

package js.nw

to String

import js.nw.Window

@:enum

Defines the position of a Window instance.

Variables

@:value(cast "center")@:impl@:enuminlineread onlyCenter:WindowPosition = "center"

The window is positioned in the center of the screen.

@:value(cast "mouse")@:impl@:enuminlineread onlyMouse:WindowPosition = "mouse"

The window is positioned under the mouse cursor.

@:value(cast "null")@:impl@:enuminlineread onlyNull:WindowPosition = "null"

The window is positioned by the desktop environment.

\ No newline at end of file +
View source

enum abstract WindowPosition(String)

package js.nw

from String to String

import js.nw.Window

@:enum

Defines the position of a Window instance.

Variables

@:value(cast "center")@:impl@:enuminlineread onlyCenter:WindowPosition = "center"

The window is positioned in the center of the screen.

@:value(cast "mouse")@:impl@:enuminlineread onlyMouse:WindowPosition = "mouse"

The window is positioned under the mouse cursor.

@:value(cast "null")@:impl@:enuminlineread onlyNull:WindowPosition = "null"

The window is positioned by the desktop environment.

\ No newline at end of file diff --git a/docs/api/js/nw/index.html b/docs/api/js/nw/index.html index 392e8ec..4fa3193 100644 --- a/docs/api/js/nw/index.html +++ b/docs/api/js/nw/index.html @@ -7,4 +7,4 @@ float: none; text-shadow: 0 0 0 transparent; } -

js.nw

Type definitions for using NW.js with Haxe.

..
App

Represents the application.

AppComponent

Defines the components of an App instance.

AppEvent

Defines the events of an App instance.

CaptureDataType

Defines the data type of a captured image.

CaptureImageFormat

Defines the format of a captured image.

CapturePageOptions

Defines the options of the Window.capturePage() method.

CaptureScreenshotOptions

Defines the options of the Window.captureScreenshot() method.

Clipboard

An abstraction of the clipboard.

ClipboardData

Defines the options of clipboard data.

ClipboardDataType

Defines the type of clipboard data.

Cookie

Represents information about an HTTP cookie.

CookieChange

Provides information about a cookie's change.

Cookies

A collection of the available cookies.

DesktopCaptureMonitor

Monitors the changes of screens and windows on the desktop.

DesktopCaptureMonitorEvent

Defines the events of a DesktopCaptureMonitor instance.

DesktopMediaSource

Defines the desktop media sources used in Screen.chooseDesktopMedia() method.

Menu

Represents a menubar or a context menu.

MenuItem

Represents an item in a menu.

MenuItemEvent

Defines the events of a MenuItem instance.

MenuItemOptions

Defines the options of a MenuItem instance.

MenuItemType

Defines the type of a menu item.

MenuType

Defines the type of a menu.

OnChangedCause

Defines the underlying reason behind a cookie change.

PrintCustomMargins

Represents the settings of custom margins.

PrintMarginsType

Defines the type of print margins.

PrintMediaSize

Represents a paper size specification.

PrintOptions

Defines the options of the Window.print() method.

Printer

Represents a printer.

PrinterOptions

Defines the options of a Printer instance.

SameSiteStatus

Defines the state of a cookie's SameSite attribute.

Screen

A collection of APIs to query the screens connected to the computer.

ScreenDefinition

Defines the structure of a screen.

ScreenEvent

Defines the events of a Screen instance.

Shell

A collection of APIs that do desktop related jobs.

Shortcut

Represents a global keyboard shortcut, also known as system-wide hotkey.

ShortcutEvent

Defines the events of a Shortcut instance.

ShortcutOptions

Defines the options of a Shortcut instance.

Tray

An abstraction of different controls on different platforms, usually it's a small icon shown on the OS's notification area.

TrayEvent

Defines the events of a Tray instance.

TrayOptions

Defines the options of a Tray instance.

Window

A wrapper of the DOM's topmost window object.

WindowEvent

Defines the events of a Window instance.

WindowManifest

Defines the manifest of a Window instance.

WindowOpenOptions

Defines the options of the Window.open() method.

WindowPolicy

Defines the policy of a Window instance.

WindowPosition

Defines the position of a Window instance.

\ No newline at end of file +

js.nw

Type definitions for using NW.js with Haxe.

..
App

Represents the application.

AppComponent

Defines the components of an App instance.

AppEvent

Defines the events of an App instance.

CaptureDataType

Defines the data type of a captured image.

CaptureImageFormat

Defines the format of a captured image.

CapturePageOptions

Defines the options of the Window.capturePage() method.

CaptureScreenshotOptions

Defines the options of the Window.captureScreenshot() method.

Clipboard

An abstraction of the clipboard.

ClipboardData

Represents data from the clipboard.

ClipboardDataType

Defines the type of clipboard data.

ClipboardOptions

Defines the options of the Clipboard.get() method.

Cookie

Represents information about an HTTP cookie.

CookieChange

Provides information about a cookie's change.

Cookies

A collection of the available cookies.

DesktopCaptureMonitor

Monitors the changes of screens and windows on the desktop.

DesktopCaptureMonitorEvent

Defines the events of a DesktopCaptureMonitor instance.

DesktopMediaSource

Defines the desktop media sources used in Screen.chooseDesktopMedia() method.

Menu

Represents a menubar or a context menu.

MenuItem

Represents an item in a menu.

MenuItemEvent

Defines the events of a MenuItem instance.

MenuItemOptions

Defines the options of a MenuItem instance.

MenuItemType

Defines the type of a menu item.

MenuType

Defines the type of a menu.

OnChangedCause

Defines the underlying reason behind a cookie change.

PrintCustomMargins

Represents the settings of custom margins.

PrintMarginsType

Defines the type of print margins.

PrintMediaSize

Represents a paper size specification.

PrintOptions

Defines the options of the Window.print() method.

Printer

Represents a printer.

PrinterOptions

Defines the options of a Printer instance.

SameSiteStatus

Defines the state of a cookie's SameSite attribute.

Screen

A collection of APIs to query the screens connected to the computer.

ScreenDefinition

Defines the structure of a screen.

ScreenEvent

Defines the events of a Screen instance.

Shell

A collection of APIs that do desktop related jobs.

Shortcut

Represents a global keyboard shortcut, also known as system-wide hotkey.

ShortcutEvent

Defines the events of a Shortcut instance.

ShortcutOptions

Defines the options of a Shortcut instance.

Tray

An abstraction of different controls on different platforms, usually it's a small icon shown on the OS's notification area.

TrayEvent

Defines the events of a Tray instance.

TrayOptions

Defines the options of a Tray instance.

Window

A wrapper of the DOM's topmost window object.

WindowEvent

Defines the events of a Window instance.

WindowManifest

Defines the manifest of a Window instance.

WindowOpenOptions

Defines the options of the Window.open() method.

WindowPolicy

Defines the policy of a Window instance.

WindowPosition

Defines the position of a Window instance.

\ No newline at end of file diff --git a/docs/api/nav.js b/docs/api/nav.js index bd258fd..a519f9a 100644 --- a/docs/api/nav.js +++ b/docs/api/nav.js @@ -1 +1 @@ -var navContent=''; \ No newline at end of file +var navContent=''; \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md index 41deba1..49be021 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,5 +1,8 @@ # Changelog +## Version [1.4.1](https://github.com/cedx/nwjs.hx/compare/v1.4.0...v1.4.1) +- Fixed the typings of the `Clipboard` class. + ## Version [1.4.0](https://github.com/cedx/nwjs.hx/compare/v1.3.0...v1.4.0) - Marked the deprecated methods with `@:deprecated` metadata. - Replaced `@:overload` metadata by the `overload` keyword.