From 61545b3f1fb1844af350d187edd26285e98f0466 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 26 Feb 2018 14:21:46 +0100 Subject: API documentation update --- .../pl.treksoft.kvision.window/-window/-init-.html | 33 ++++ .../-window/add-all.html | 21 +++ .../pl.treksoft.kvision.window/-window/add.html | 21 +++ .../-window/after-create.html | 16 ++ .../-window/caption.html | 15 ++ .../-window/close-button.html | 15 ++ .../-window/content-height.html | 15 ++ .../-window/content-width.html | 15 ++ .../-window/get-children.html | 18 ++ .../pl.treksoft.kvision.window/-window/index.html | 190 +++++++++++++++++++++ .../-window/is-draggable.html | 21 +++ .../-window/is-resizable.html | 21 +++ .../-window/remove-all.html | 18 ++ .../pl.treksoft.kvision.window/-window/remove.html | 21 +++ .../pl.treksoft.kvision.window/-window/window.html | 16 ++ 15 files changed, 456 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.window/-window/-init-.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/add-all.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/add.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/after-create.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/caption.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/close-button.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/content-height.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/content-width.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/get-children.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/index.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/is-draggable.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/is-resizable.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/remove-all.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/remove.html create mode 100644 docs/api/pl.treksoft.kvision.window/-window/window.html (limited to 'docs/api/pl.treksoft.kvision.window/-window') diff --git a/docs/api/pl.treksoft.kvision.window/-window/-init-.html b/docs/api/pl.treksoft.kvision.window/-window/-init-.html new file mode 100644 index 00000000..f5bfd9a3 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/-init-.html @@ -0,0 +1,33 @@ + + + +Window.<init> - kvision + + + +kvision / pl.treksoft.kvision.window / Window / <init>
+
+

<init>

+ +

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)

Parameters

+caption - window title

+contentWidth - window content width

+contentHeight - window content height

+isResizable - determines if the window is resizable

+isDraggable - determines if the window is draggable

+closeButton - determines if Close button is visible

+classes - a set of CSS class names

+init - an initializer extension function

Constructor
+

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/add-all.html b/docs/api/pl.treksoft.kvision.window/-window/add-all.html new file mode 100644 index 00000000..bd2fb310 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/add-all.html @@ -0,0 +1,21 @@ + + + +Window.addAll - kvision + + + +kvision / pl.treksoft.kvision.window / Window / addAll
+
+

addAll

+ +open fun addAll(children: List<Component>): SimplePanel +

Overrides SimplePanel.addAll

Adds a list of components to the current container.

Parameters

+children - list of child components

Return
+current container

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

add

+ +open fun add(child: Component): SimplePanel +

Overrides SimplePanel.add

Adds given component to the current container.

Parameters

+child - child component

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/after-create.html b/docs/api/pl.treksoft.kvision.window/-window/after-create.html new file mode 100644 index 00000000..53d6b602 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/after-create.html @@ -0,0 +1,16 @@ + + + +Window.afterCreate - kvision + + + +kvision / pl.treksoft.kvision.window / Window / afterCreate
+
+

afterCreate

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

Overrides Widget.afterCreate

Method called after creating Snabbdom vnode.

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

caption

+ +var caption: String? +

Window caption text.

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

closeButton

+ +var closeButton: Boolean +

Determines if Close button is visible.

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

contentHeight

+ +var contentHeight: CssSize? +

Window content height.

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

contentWidth

+ +var contentWidth: CssSize? +

Window content width.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/get-children.html b/docs/api/pl.treksoft.kvision.window/-window/get-children.html new file mode 100644 index 00000000..68cb762f --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/get-children.html @@ -0,0 +1,18 @@ + + + +Window.getChildren - kvision + + + +kvision / pl.treksoft.kvision.window / Window / getChildren
+
+

getChildren

+ +open fun getChildren(): List<Component> +

Overrides SimplePanel.getChildren

Returns a list of children of the current container.

Return
+list of children

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

Window

+open class Window : SimplePanel +

Floating window container.

Constructors

+ + + + + + + +

<init>

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)

Properties

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

+ caption +	+`var caption: String?` + Window caption text. +
+ closeButton +	+`var closeButton: Boolean` + Determines if Close button is visible. +
+ contentHeight +	+`var contentHeight: CssSize?` + Window content height. +
+ contentWidth +	+`var contentWidth: CssSize?` + Window content width. +
+ isDraggable +	+`var isDraggable: Boolean` + Determines if the window is draggable. +
+ isResizable +	+`var isResizable: Boolean` + Determines if the window is resizable. +

Functions

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

+ add +	+`open fun add(child: Component): SimplePanel` + Adds given component to the current container. +
+ addAll +	+`open fun addAll(children: List<Component>): SimplePanel` + Adds a list of components to the current container. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ getChildren +	+`open fun getChildren(): List<Component>` + Returns a list of children of the current container. +
+ remove +	+`open fun remove(child: Component): SimplePanel` + Removes given component from the current container. +
+ removeAll +	+`open fun removeAll(): SimplePanel` + Removes all children from the current container. +

Inherited Functions

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

+ addInternal +	+`fun addInternal(child: Component): SimplePanel` + Protected and final method to add given component to the current container. +
+ childrenVNodes +	+`open fun childrenVNodes(): Array<VNode>` + Returns the array of the children Snabbdom vnodes. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Companion Object Functions

+ + + + + + + +

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

DSL builder extension function.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/is-draggable.html b/docs/api/pl.treksoft.kvision.window/-window/is-draggable.html new file mode 100644 index 00000000..6432d5fb --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/is-draggable.html @@ -0,0 +1,21 @@ + + + +Window.isDraggable - kvision + + + +kvision / pl.treksoft.kvision.window / Window / isDraggable
+
+

isDraggable

+ +var isDraggable: Boolean +

Determines if the window is draggable.

Getter
+

Determines if the window is draggable.

Setter
+

Determines if the window is draggable.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/is-resizable.html b/docs/api/pl.treksoft.kvision.window/-window/is-resizable.html new file mode 100644 index 00000000..3aa1e97a --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/is-resizable.html @@ -0,0 +1,21 @@ + + + +Window.isResizable - kvision + + + +kvision / pl.treksoft.kvision.window / Window / isResizable
+
+

isResizable

+ +var isResizable: Boolean +

Determines if the window is resizable.

Getter
+

Determines if the window is resizable.

Setter
+

Determines if the window is resizable.

+ + diff --git a/docs/api/pl.treksoft.kvision.window/-window/remove-all.html b/docs/api/pl.treksoft.kvision.window/-window/remove-all.html new file mode 100644 index 00000000..ad12c1d6 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.window/-window/remove-all.html @@ -0,0 +1,18 @@ + + + +Window.removeAll - kvision + + + +kvision / pl.treksoft.kvision.window / Window / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

Removes all children from the current container.

Return
+current container

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

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

Removes given component from the current container.

Parameters

+child - child component

Return
+current container

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

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

DSL builder extension function.

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

+ + -- cgit