From a1331da2233a7198af89a9db2ec743a430b89362 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 3 Apr 2018 17:33:29 +0200 Subject: Documentation update for KVision 0.0.12 --- api/index-outline.html | 24 +++++++++++++--------- .../-drop-down/-init-.html | 6 ++++-- .../-drop-down/drop-down.html | 4 ++-- .../-drop-down/index.html | 4 ++-- .../-iframe/get-iframe-window.html | 17 +++++++++++++++ api/pl.treksoft.kvision.html/-iframe/index.html | 9 ++++++++ api/pl.treksoft.kvision.html/-link/index.html | 9 ++++++++ api/pl.treksoft.kvision.html/-link/on-click.html | 15 ++++++++++++++ api/pl.treksoft.kvision.navbar/-navbar/-init-.html | 2 +- api/pl.treksoft.kvision.navbar/-navbar/index.html | 8 ++++---- api/pl.treksoft.kvision.navbar/-navbar/label.html | 2 +- .../-navbar/navbar-panel.html | 16 --------------- api/pl.treksoft.kvision.navbar/-navbar/navbar.html | 16 +++++++++++++++ 13 files changed, 94 insertions(+), 38 deletions(-) create mode 100644 api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html create mode 100644 api/pl.treksoft.kvision.html/-link/on-click.html delete mode 100644 api/pl.treksoft.kvision.navbar/-navbar/navbar-panel.html create mode 100644 api/pl.treksoft.kvision.navbar/-navbar/navbar.html diff --git a/api/index-outline.html b/api/index-outline.html index 00272fc4..9b692f3a 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -1106,13 +1106,13 @@ -DropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Set<String> = setOf())
+DropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Boolean = true, : Set<String> = setOf())
open fun add(: Component): SimplePanel
open fun addAll(: List<Component>): SimplePanel
protected open fun afterInsert(: VNode): Unit
var block: Boolean
var disabled: Boolean
-fun Container.dropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Set<String> = setOf(), : DropDown.() -> Unit = null): DropDown
+fun Container.dropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Boolean = true, : Set<String> = setOf(), : DropDown.() -> Unit = null): DropDown
var dropup: Boolean
val forNavbar: Boolean
open fun getChildren(): List<Component>
@@ -1764,6 +1764,7 @@ Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())
+open fun getIframeWindow(): Window
protected open fun getSnAttrs(): List<StringPair>
fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: Iframe.() -> Unit = null): Iframe
var iframeHeight: Int?
@@ -1874,6 +1875,7 @@ fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link
fun ListTag.linkDisabled(: String, : String? = null, : ResString? = null, : Set<String> = setOf(), : Link.() -> Unit = null): Link
fun DropDown.linkDisabled(: String, : String? = null, : ResString? = null, : Set<String> = setOf(), : Link.() -> Unit = null): Link
+open fun onClick(handler: Link.(MouseEvent) -> Unit): Link
protected open fun render(): VNode
var url: String?
@@ -2016,14 +2018,14 @@ -Navbar(: String = "", : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null)
+Navbar(: String? = null, : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null)
open fun add(: Component): Navbar
open fun addAll(: List<Component>): Navbar
open fun getChildren(): List<Component>
protected open fun getSnClass(): List<StringBoolPair>
var inverted: Boolean
-var label: String
-fun Container.navbarPanel(: String = "", : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null): Navbar
+var label: String?
+fun Container.navbar(: String? = null, : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null): Navbar
open fun remove(: Component): Navbar
open fun removeAll(): Navbar
protected open fun render(): VNode
@@ -4569,13 +4571,13 @@ -DropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Set<String> = setOf())
+DropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Boolean = true, : Set<String> = setOf())
open fun add(: Component): SimplePanel
open fun addAll(: List<Component>): SimplePanel
protected open fun afterInsert(: VNode): Unit
var block: Boolean
var disabled: Boolean
-fun Container.dropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Set<String> = setOf(), : DropDown.() -> Unit = null): DropDown
+fun Container.dropDown(: String, : List<StringPair>? = null, : String? = null, : ButtonStyle = ButtonStyle.DEFAULT, : Boolean = false, : Boolean = false, : Boolean = true, : Set<String> = setOf(), : DropDown.() -> Unit = null): DropDown
var dropup: Boolean
val forNavbar: Boolean
open fun getChildren(): List<Component>
@@ -6082,6 +6084,7 @@ Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())
+open fun getIframeWindow(): Window
protected open fun getSnAttrs(): List<StringPair>
fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: Iframe.() -> Unit = null): Iframe
var iframeHeight: Int?
@@ -6163,6 +6166,7 @@ fun Container.link(label: String, url: String? = null, icon: String? = null, image: ResString? = null, classes: Set<String> = setOf(), init: Link.() -> Unit = null): Link
fun ListTag.linkDisabled(: String, : String? = null, : ResString? = null, : Set<String> = setOf(), : Link.() -> Unit = null): Link
fun DropDown.linkDisabled(: String, : String? = null, : ResString? = null, : Set<String> = setOf(), : Link.() -> Unit = null): Link
+open fun onClick(handler: Link.(MouseEvent) -> Unit): Link
protected open fun render(): VNode
var url: String?
@@ -6478,14 +6482,14 @@ -Navbar(: String = "", : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null)
+Navbar(: String? = null, : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null)
open fun add(: Component): Navbar
open fun addAll(: List<Component>): Navbar
open fun getChildren(): List<Component>
protected open fun getSnClass(): List<StringBoolPair>
var inverted: Boolean
-var label: String
-fun Container.navbarPanel(: String = "", : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null): Navbar
+var label: String?
+fun Container.navbar(: String? = null, : NavbarType? = null, : Boolean = false, : Set<String> = setOf(), : Navbar.() -> Unit = null): Navbar
open fun remove(: Component): Navbar
open fun removeAll(): Navbar
protected open fun render(): VNode
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html index ccb09c31..67e3cdef 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / <init>

<init>

- -

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf())

+ +

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

Parameters

text - the label of the dropdown button

@@ -23,6 +23,8 @@ disabled - determines if the component is disabled on start

forNavbar - determines if the component will be used in a navbar

+withCaret - determines if the dropdown button renders caret

classes - a set of CSS class names

Constructor
diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html index 84df9354..0c1af12f 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.dropdown / DropDown / dropDown

dropDown

- -

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

+ +

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html index 6dbac1d8..8fef07e2 100644 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html +++ b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html @@ -18,7 +18,7 @@

<init>

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf())

DropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf())

@@ -234,7 +234,7 @@

dropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html b/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html new file mode 100644 index 00000000..41620da2 --- /dev/null +++ b/api/pl.treksoft.kvision.html/-iframe/get-iframe-window.html @@ -0,0 +1,17 @@ + + + +Iframe.getIframeWindow - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / getIframeWindow
+
+

getIframeWindow

+ +open fun getIframeWindow(): Window +

Returns content window object of the iframe.

Return
+content window object

+ + diff --git a/api/pl.treksoft.kvision.html/-iframe/index.html b/api/pl.treksoft.kvision.html/-iframe/index.html index a4d11c66..93b4523d 100644 --- a/api/pl.treksoft.kvision.html/-iframe/index.html +++ b/api/pl.treksoft.kvision.html/-iframe/index.html @@ -154,6 +154,15 @@ +

getIframeWindow

+ + +open fun getIframeWindow(): Window +

Returns content window object of the iframe.

+ + + +

getSnAttrs

diff --git a/api/pl.treksoft.kvision.html/-link/index.html b/api/pl.treksoft.kvision.html/-link/index.html index 15cb0ec2..267823d6 100644 --- a/api/pl.treksoft.kvision.html/-link/index.html +++ b/api/pl.treksoft.kvision.html/-link/index.html @@ -77,6 +77,15 @@ +

onClick

+ + +open fun onClick(handler: Link.(MouseEvent) -> Unit): Link +

A convenient helper for easy setting onClick event handler.

+ + + +

render

diff --git a/api/pl.treksoft.kvision.html/-link/on-click.html b/api/pl.treksoft.kvision.html/-link/on-click.html new file mode 100644 index 00000000..ca274fbf --- /dev/null +++ b/api/pl.treksoft.kvision.html/-link/on-click.html @@ -0,0 +1,15 @@ + + + +Link.onClick - kvision + + + +kvision / pl.treksoft.kvision.html / Link / onClick
+
+

onClick

+ +open fun onClick(handler: Link.(MouseEvent) -> Unit): Link +

A convenient helper for easy setting onClick event handler.

+ + diff --git a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html index 16fea1e0..34af742b 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/-init-.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/-init-.html @@ -9,7 +9,7 @@

<init>

Navbar(label: String = "", type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

Parameters

label - the navbar label

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/index.html b/api/pl.treksoft.kvision.navbar/-navbar/index.html index 075815e2..cf11a1e6 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/index.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/index.html @@ -18,7 +18,7 @@

<init>

Navbar(label: String = "", type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

Navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null)

@@ -39,7 +39,7 @@

label

-var label: String +var label: String?

The navbar header label.

@@ -150,10 +150,10 @@ -

navbarPanel

navbar

fun Container.navbarPanel(text: String = "", type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

fun Container.navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

DSL builder extension function.

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/label.html b/api/pl.treksoft.kvision.navbar/-navbar/label.html index fd5dfbef..4b2fc0b9 100644 --- a/api/pl.treksoft.kvision.navbar/-navbar/label.html +++ b/api/pl.treksoft.kvision.navbar/-navbar/label.html @@ -9,7 +9,7 @@

label

-var label: String +var label: String?

The navbar header label.

diff --git a/api/pl.treksoft.kvision.navbar/-navbar/navbar-panel.html b/api/pl.treksoft.kvision.navbar/-navbar/navbar-panel.html deleted file mode 100644 index 5ff845e4..00000000 --- a/api/pl.treksoft.kvision.navbar/-navbar/navbar-panel.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Navbar.navbarPanel - kvision - - - -kvision / pl.treksoft.kvision.navbar / Navbar / navbarPanel
-
-

navbarPanel

- -

fun Container.navbarPanel(text: String = "", type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

- - diff --git a/api/pl.treksoft.kvision.navbar/-navbar/navbar.html b/api/pl.treksoft.kvision.navbar/-navbar/navbar.html new file mode 100644 index 00000000..8754bdd0 --- /dev/null +++ b/api/pl.treksoft.kvision.navbar/-navbar/navbar.html @@ -0,0 +1,16 @@ + + + +Navbar.navbar - kvision + + + +kvision / pl.treksoft.kvision.navbar / Navbar / navbar
+
+

navbar

+ +

fun Container.navbar(label: String? = null, type: NavbarType? = null, inverted: Boolean = false, classes: Set<String> = setOf(), init: Navbar.() -> Unit = null): Navbar

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

+ + -- cgit