From 4792e81070aa2bed027720875e3c2ea7462f282b Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Tue, 27 Feb 2018 10:07:02 +0100 Subject: Updated API documentantion. --- docs/api/index-outline.html | 12 +++++++-- .../-abstract-text-input/after-postpatch.html | 16 ++++++++++++ .../-abstract-text-input/index.html | 18 +++++++------- .../-rich-text-input/index.html | 9 +++++++ .../-text-area-input/index.html | 9 +++++++ .../-text-input/index.html | 9 +++++++ .../-window/after-destroy.html | 16 ++++++++++++ .../pl.treksoft.kvision.window/-window/focus.html | 15 +++++++++++ .../pl.treksoft.kvision.window/-window/index.html | 29 +++++++++++++++++++++- .../-window/to-front.html | 15 +++++++++++ .../pl.treksoft.kvision.window/-window/window.html | 2 +- 11 files changed, 137 insertions(+), 13 deletions(-) create mode 100644 docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/after-destroy.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/focus.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/to-front.html diff --git a/docs/api/index-outline.html b/docs/api/index-outline.html index 0c234812..5a2437ad 100644 --- a/docs/api/index-outline.html +++ b/docs/api/index-outline.html @@ -67,6 +67,7 @@ AbstractTextInput(value: String? = null, classes: Set<String> = setOf())
protected open fun afterInsert(node: VNode): Unit
+protected open fun afterPostpatch(node: VNode): Unit
var autofocus: Boolean?
open fun blur(): Unit
var disabled: Boolean
@@ -2508,16 +2509,19 @@ open fun add(child: Component): SimplePanel
open fun addAll(children: List<Component>): SimplePanel
protected open fun afterCreate(node: VNode): Unit
+protected open fun afterDestroy(): Unit
var caption: String?
var closeButton: Boolean
var contentHeight: CssSize?
var contentWidth: CssSize?
+open fun focus(): Unit
open fun getChildren(): List<Component>
var isDraggable: Boolean
var isResizable: Boolean
open fun remove(child: Component): SimplePanel
open fun removeAll(): SimplePanel
-fun Container.window(caption: String? = null, width: CssSize? = CssSize(0, UNIT.auto), height: CssSize? = CssSize(0, UNIT.auto), resizable: Boolean = true, draggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window
+open fun toFront(): Unit
+fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window
@@ -4055,6 +4059,7 @@ AbstractTextInput(value: String? = null, classes: Set<String> = setOf())
protected open fun afterInsert(node: VNode): Unit
+protected open fun afterPostpatch(node: VNode): Unit
var autofocus: Boolean?
open fun blur(): Unit
var disabled: Boolean
@@ -5376,16 +5381,19 @@ open fun add(child: Component): SimplePanel
open fun addAll(children: List<Component>): SimplePanel
protected open fun afterCreate(node: VNode): Unit
+protected open fun afterDestroy(): Unit
var caption: String?
var closeButton: Boolean
var contentHeight: CssSize?
var contentWidth: CssSize?
+open fun focus(): Unit
open fun getChildren(): List<Component>
var isDraggable: Boolean
var isResizable: Boolean
open fun remove(child: Component): SimplePanel
open fun removeAll(): SimplePanel
-fun Container.window(caption: String? = null, width: CssSize? = CssSize(0, UNIT.auto), height: CssSize? = CssSize(0, UNIT.auto), resizable: Boolean = true, draggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window
+open fun toFront(): Unit
+fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window
diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html new file mode 100644 index 00000000..eb1f1c60 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/after-postpatch.html @@ -0,0 +1,16 @@ + + + +AbstractTextInput.afterPostpatch - kvision + + + +kvision / pl.treksoft.kvision.form.text / AbstractTextInput / afterPostpatch
+
+

afterPostpatch

+ +protected open fun afterPostpatch(node: VNode): Unit +

Overrides Widget.afterPostpatch

Method called after updating Snabbdom vnode.

+ + diff --git a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html index 1323c61a..dc884549 100644 --- a/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html +++ b/docs/api/pl.treksoft.kvision.form.text/-abstract-text-input/index.html @@ -181,6 +181,15 @@ +

afterPostpatch

+ + +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+ + + +

blur

@@ -258,15 +267,6 @@ -

afterPostpatch

- - -open fun afterPostpatch(node: VNode): Unit -

Method called after updating Snabbdom vnode.

- - - -

clearDragDropData

diff --git a/docs/api/pl.treksoft.kvision.form.text/-rich-text-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-rich-text-input/index.html index c4c1a7f0..02d88253 100644 --- a/docs/api/pl.treksoft.kvision.form.text/-rich-text-input/index.html +++ b/docs/api/pl.treksoft.kvision.form.text/-rich-text-input/index.html @@ -154,6 +154,15 @@ +

afterPostpatch

+ + +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+ + + +

blur

diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-area-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-text-area-input/index.html index 3acb438b..f710cb54 100644 --- a/docs/api/pl.treksoft.kvision.form.text/-text-area-input/index.html +++ b/docs/api/pl.treksoft.kvision.form.text/-text-area-input/index.html @@ -177,6 +177,15 @@ +

afterPostpatch

+ + +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+ + + +

blur

diff --git a/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html b/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html index 98691051..676988c4 100644 --- a/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html +++ b/docs/api/pl.treksoft.kvision.form.text/-text-input/index.html @@ -168,6 +168,15 @@ +

afterPostpatch

+ + +open fun afterPostpatch(node: VNode): Unit +

Method called after updating Snabbdom vnode.

+ + + +

blur

diff --git a/docs/api/pl.treksoft.kvision.window/-window/after-destroy.html b/docs/api/pl.treksoft.kvision.window/-window/after-destroy.html new file mode 100644 index 00000000..21da8481 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/after-destroy.html @@ -0,0 +1,16 @@ + + + +Window.afterDestroy - kvision + + + +kvision / pl.treksoft.kvision.window / Window / afterDestroy
+
+

afterDestroy

+ +protected open fun afterDestroy(): Unit +

Overrides Widget.afterDestroy

Method called after destroying Snabbdom vnode.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/focus.html b/docs/api/pl.treksoft.kvision.window/-window/focus.html new file mode 100644 index 00000000..e765ceda --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/focus.html @@ -0,0 +1,15 @@ + + + +Window.focus - kvision + + + +kvision / pl.treksoft.kvision.window / Window / focus
+
+

focus

+ +open fun focus(): Unit +

Makes the current window focused.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/index.html b/docs/api/pl.treksoft.kvision.window/-window/index.html index 9e238bee..8a45ef9e 100644 --- a/docs/api/pl.treksoft.kvision.window/-window/index.html +++ b/docs/api/pl.treksoft.kvision.window/-window/index.html @@ -113,6 +113,24 @@ +

afterDestroy

+ + +open fun afterDestroy(): Unit +

Method called after destroying Snabbdom vnode.

+ + + + +

focus

+ + +open fun focus(): Unit +

Makes the current window focused.

+ + + +

getChildren

@@ -138,6 +156,15 @@

Removes all children from the current container.

+ + +

toFront

+ + +open fun toFront(): Unit +

Moves the current window to the front.

+ +

Inherited Functions

@@ -180,7 +207,7 @@

window

fun Container.window(caption: String? = null, width: CssSize? = CssSize(0, UNIT.auto), height: CssSize? = CssSize(0, UNIT.auto), resizable: Boolean = true, draggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window

fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window

DSL builder extension function.

diff --git a/docs/api/pl.treksoft.kvision.window/-window/to-front.html b/docs/api/pl.treksoft.kvision.window/-window/to-front.html new file mode 100644 index 00000000..73b48625 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/to-front.html @@ -0,0 +1,15 @@ + + + +Window.toFront - kvision + + + +kvision / pl.treksoft.kvision.window / Window / toFront
+
+

toFront

+ +open fun toFront(): Unit +

Moves the current window to the front.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/window.html b/docs/api/pl.treksoft.kvision.window/-window/window.html index 49b62856..452d2636 100644 --- a/docs/api/pl.treksoft.kvision.window/-window/window.html +++ b/docs/api/pl.treksoft.kvision.window/-window/window.html @@ -9,7 +9,7 @@

window

fun Container.window(caption: String? = null, width: CssSize? = CssSize(0, UNIT.auto), height: CssSize? = CssSize(0, UNIT.auto), resizable: Boolean = true, draggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window

fun Container.window(caption: String? = null, contentWidth: CssSize? = CssSize(0, UNIT.auto), contentHeight: CssSize? = CssSize(0, UNIT.auto), isResizable: Boolean = true, isDraggable: Boolean = true, closeButton: Boolean = false, classes: Set<String> = setOf(), init: Window.() -> Unit = null): Window

DSL builder extension function.

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

-- cgit