From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- .../-status-bar/add-tap-listener.html | 15 +++ .../-status-bar/hide.html | 15 +++ .../-status-bar/index.html | 132 +++++++++++++++++++++ .../-status-bar/is-visible.html | 15 +++ .../-status-bar/overlays-web-view.html | 18 +++ .../set-background-color-by-hex-string.html | 15 +++ .../-status-bar/set-background-color.html | 15 +++ .../-status-bar/show.html | 15 +++ .../-status-bar/style-black-opaque.html | 15 +++ .../-status-bar/style-black-translucent.html | 15 +++ .../-status-bar/style-default.html | 15 +++ .../-status-bar/style-light-content.html | 15 +++ 12 files changed, 300 insertions(+) create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/add-tap-listener.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/hide.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/index.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/is-visible.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/overlays-web-view.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color-by-hex-string.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/show.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/style-black-opaque.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/style-black-translucent.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/style-default.html create mode 100644 api1/pl.treksoft.kvision.cordova/-status-bar/style-light-content.html (limited to 'api1/pl.treksoft.kvision.cordova/-status-bar') diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/add-tap-listener.html b/api1/pl.treksoft.kvision.cordova/-status-bar/add-tap-listener.html new file mode 100644 index 00000000..61895739 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/add-tap-listener.html @@ -0,0 +1,15 @@ + + + +StatusBar.addTapListener - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / addTapListener
+
+

addTapListener

+ +fun addTapListener(listener: () -> Unit): Unit +

Add listeners for the status bar tap event.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/hide.html b/api1/pl.treksoft.kvision.cordova/-status-bar/hide.html new file mode 100644 index 00000000..95fc2a90 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/hide.html @@ -0,0 +1,15 @@ + + + +StatusBar.hide - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / hide
+
+

hide

+ +fun hide(): Unit +

Hide status bar.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/index.html b/api1/pl.treksoft.kvision.cordova/-status-bar/index.html new file mode 100644 index 00000000..96f7f260 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/index.html @@ -0,0 +1,132 @@ + + + +StatusBar - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar
+
+

StatusBar

+object StatusBar +

Main object for Cordova status bar.

Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ addTapListener +	+`fun addTapListener(listener: () -> Unit): Unit` + Add listeners for the status bar tap event. +
+ hide +	+`fun hide(): Unit` + Hide status bar. +
+ isVisible +	+`suspend fun isVisible(): Boolean` + Returns if the status bar is visible. +
+ overlaysWebView +	+`fun overlaysWebView(overlays: Boolean): Unit` + Set overlay. +
+ setBackgroundColor +	+`fun setBackgroundColor(color: Int): Unit` + Sets the background color of the status bar by a hexadecimal Int. +
+ setBackgroundColorByHexString +	+`fun setBackgroundColorByHexString(color: String): Unit` + Sets the background color of the status bar by a hex string. +
+ show +	+`fun show(): Unit` + Show status bar. +
+ styleBlackOpaque +	+`fun styleBlackOpaque(): Unit` + Use the blackOpaque status bar (light text, for dark backgrounds). +
+ styleBlackTranslucent +	+`fun styleBlackTranslucent(): Unit` + Use the blackTranslucent status bar (light text, for dark backgrounds). +
+ styleDefault +	+`fun styleDefault(): Unit` + Use the default status bar (dark text, for light backgrounds). +
+ styleLightContent +	+`fun styleLightContent(): Unit` + Use the lightContent status bar (light text, for dark backgrounds). +

Extension Functions

+ + + + + + + +

createInstance

+fun <T> Any?.createInstance(vararg args: dynamic): T +

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/is-visible.html b/api1/pl.treksoft.kvision.cordova/-status-bar/is-visible.html new file mode 100644 index 00000000..d123cf31c --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/is-visible.html @@ -0,0 +1,15 @@ + + + +StatusBar.isVisible - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / isVisible
+
+

isVisible

+ +suspend fun isVisible(): Boolean +

Returns if the status bar is visible.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/overlays-web-view.html b/api1/pl.treksoft.kvision.cordova/-status-bar/overlays-web-view.html new file mode 100644 index 00000000..16f66d23 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/overlays-web-view.html @@ -0,0 +1,18 @@ + + + +StatusBar.overlaysWebView - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / overlaysWebView
+
+

overlaysWebView

+ +fun overlaysWebView(overlays: Boolean): Unit +

Set overlay.

Parameters

+overlays - determines if the status bar overlays the web view

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color-by-hex-string.html b/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color-by-hex-string.html new file mode 100644 index 00000000..1af22ad6 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color-by-hex-string.html @@ -0,0 +1,15 @@ + + + +StatusBar.setBackgroundColorByHexString - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / setBackgroundColorByHexString
+
+

setBackgroundColorByHexString

+ +fun setBackgroundColorByHexString(color: String): Unit +

Sets the background color of the status bar by a hex string.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color.html b/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color.html new file mode 100644 index 00000000..e7bf3c9f --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/set-background-color.html @@ -0,0 +1,15 @@ + + + +StatusBar.setBackgroundColor - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / setBackgroundColor
+
+

setBackgroundColor

+ +fun setBackgroundColor(color: Int): Unit +

Sets the background color of the status bar by a hexadecimal Int.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/show.html b/api1/pl.treksoft.kvision.cordova/-status-bar/show.html new file mode 100644 index 00000000..02b14e53 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/show.html @@ -0,0 +1,15 @@ + + + +StatusBar.show - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / show
+
+

show

+ +fun show(): Unit +

Show status bar.

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-opaque.html b/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-opaque.html new file mode 100644 index 00000000..f775506b --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-opaque.html @@ -0,0 +1,15 @@ + + + +StatusBar.styleBlackOpaque - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / styleBlackOpaque
+
+

styleBlackOpaque

+ +fun styleBlackOpaque(): Unit +

Use the blackOpaque status bar (light text, for dark backgrounds).

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-translucent.html b/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-translucent.html new file mode 100644 index 00000000..d0cf7d4a --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/style-black-translucent.html @@ -0,0 +1,15 @@ + + + +StatusBar.styleBlackTranslucent - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / styleBlackTranslucent
+
+

styleBlackTranslucent

+ +fun styleBlackTranslucent(): Unit +

Use the blackTranslucent status bar (light text, for dark backgrounds).

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/style-default.html b/api1/pl.treksoft.kvision.cordova/-status-bar/style-default.html new file mode 100644 index 00000000..c5a6e6c1 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/style-default.html @@ -0,0 +1,15 @@ + + + +StatusBar.styleDefault - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / styleDefault
+
+

styleDefault

+ +fun styleDefault(): Unit +

Use the default status bar (dark text, for light backgrounds).

+ + diff --git a/api1/pl.treksoft.kvision.cordova/-status-bar/style-light-content.html b/api1/pl.treksoft.kvision.cordova/-status-bar/style-light-content.html new file mode 100644 index 00000000..5f0d06c0 --- /dev/null +++ b/api1/pl.treksoft.kvision.cordova/-status-bar/style-light-content.html @@ -0,0 +1,15 @@ + + + +StatusBar.styleLightContent - kvision + + + +kvision / pl.treksoft.kvision.cordova / StatusBar / styleLightContent
+
+

styleLightContent

+ +fun styleLightContent(): Unit +

Use the lightContent status bar (light text, for dark backgrounds).

+ + -- cgit