From 7c2850063697f94a0d8b8d8f8588136dd4b3d05e Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sun, 21 Oct 2018 23:59:34 +0200 Subject: API documentation for KVision 0.0.19 --- api/pl.treksoft.kvision.window/-window/-init-.html | 33 --- .../-window/add-all.html | 21 -- api/pl.treksoft.kvision.window/-window/add.html | 21 -- .../-window/after-create.html | 16 -- .../-window/after-destroy.html | 16 -- .../-window/caption.html | 15 -- .../-window/close-button.html | 15 -- .../-window/content-height.html | 15 -- .../-window/content-overflow.html | 15 -- .../-window/content-width.html | 15 -- api/pl.treksoft.kvision.window/-window/focus.html | 15 -- .../-window/get-children.html | 18 -- api/pl.treksoft.kvision.window/-window/index.html | 226 --------------------- .../-window/is-draggable.html | 21 -- .../-window/is-resizable.html | 21 -- .../-window/remove-all.html | 18 -- api/pl.treksoft.kvision.window/-window/remove.html | 21 -- .../-window/to-front.html | 15 -- api/pl.treksoft.kvision.window/-window/window.html | 16 -- api/pl.treksoft.kvision.window/index.html | 27 --- 20 files changed, 580 deletions(-) delete mode 100644 api/pl.treksoft.kvision.window/-window/-init-.html delete mode 100644 api/pl.treksoft.kvision.window/-window/add-all.html delete mode 100644 api/pl.treksoft.kvision.window/-window/add.html delete mode 100644 api/pl.treksoft.kvision.window/-window/after-create.html delete mode 100644 api/pl.treksoft.kvision.window/-window/after-destroy.html delete mode 100644 api/pl.treksoft.kvision.window/-window/caption.html delete mode 100644 api/pl.treksoft.kvision.window/-window/close-button.html delete mode 100644 api/pl.treksoft.kvision.window/-window/content-height.html delete mode 100644 api/pl.treksoft.kvision.window/-window/content-overflow.html delete mode 100644 api/pl.treksoft.kvision.window/-window/content-width.html delete mode 100644 api/pl.treksoft.kvision.window/-window/focus.html delete mode 100644 api/pl.treksoft.kvision.window/-window/get-children.html delete mode 100644 api/pl.treksoft.kvision.window/-window/index.html delete mode 100644 api/pl.treksoft.kvision.window/-window/is-draggable.html delete mode 100644 api/pl.treksoft.kvision.window/-window/is-resizable.html delete mode 100644 api/pl.treksoft.kvision.window/-window/remove-all.html delete mode 100644 api/pl.treksoft.kvision.window/-window/remove.html delete mode 100644 api/pl.treksoft.kvision.window/-window/to-front.html delete mode 100644 api/pl.treksoft.kvision.window/-window/window.html delete mode 100644 api/pl.treksoft.kvision.window/index.html (limited to 'api/pl.treksoft.kvision.window') diff --git a/api/pl.treksoft.kvision.window/-window/-init-.html b/api/pl.treksoft.kvision.window/-window/-init-.html deleted file mode 100644 index f5bfd9a3..00000000 --- a/api/pl.treksoft.kvision.window/-window/-init-.html +++ /dev/null @@ -1,33 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/add-all.html b/api/pl.treksoft.kvision.window/-window/add-all.html deleted file mode 100644 index bd2fb310..00000000 --- a/api/pl.treksoft.kvision.window/-window/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/add.html b/api/pl.treksoft.kvision.window/-window/add.html deleted file mode 100644 index ad688a2c..00000000 --- a/api/pl.treksoft.kvision.window/-window/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/after-create.html b/api/pl.treksoft.kvision.window/-window/after-create.html deleted file mode 100644 index 53d6b602..00000000 --- a/api/pl.treksoft.kvision.window/-window/after-create.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/after-destroy.html b/api/pl.treksoft.kvision.window/-window/after-destroy.html deleted file mode 100644 index 21da8481..00000000 --- a/api/pl.treksoft.kvision.window/-window/after-destroy.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/caption.html b/api/pl.treksoft.kvision.window/-window/caption.html deleted file mode 100644 index 69fd1862..00000000 --- a/api/pl.treksoft.kvision.window/-window/caption.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Window.caption - kvision - - - -kvision / pl.treksoft.kvision.window / Window / caption
-
-

caption

- -var caption: String? -

Window caption text.

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

closeButton

- -var closeButton: Boolean -

Determines if Close button is visible.

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

contentHeight

- -var contentHeight: CssSize? -

Window content height.

- - diff --git a/api/pl.treksoft.kvision.window/-window/content-overflow.html b/api/pl.treksoft.kvision.window/-window/content-overflow.html deleted file mode 100644 index d1478b00..00000000 --- a/api/pl.treksoft.kvision.window/-window/content-overflow.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Window.contentOverflow - kvision - - - -kvision / pl.treksoft.kvision.window / Window / contentOverflow
-
-

contentOverflow

- -var contentOverflow: Overflow? -

Window content height.

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

contentWidth

- -var contentWidth: CssSize? -

Window content width.

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

focus

- -open fun focus(): Unit -

Makes the current window focused.

- - diff --git a/api/pl.treksoft.kvision.window/-window/get-children.html b/api/pl.treksoft.kvision.window/-window/get-children.html deleted file mode 100644 index 68cb762f..00000000 --- a/api/pl.treksoft.kvision.window/-window/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/index.html b/api/pl.treksoft.kvision.window/-window/index.html deleted file mode 100644 index f9c9c6a3..00000000 --- a/api/pl.treksoft.kvision.window/-window/index.html +++ /dev/null @@ -1,226 +0,0 @@ - - - -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. -
- contentOverflow -	-`var contentOverflow: Overflow?` - 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. -
- afterDestroy -	-`open fun afterDestroy(): Unit` - Method called after destroying Snabbdom vnode. -
- focus -	-`open fun focus(): Unit` - Makes the current window focused. -
- 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. -
- toFront -	-`open fun toFront(): Unit` - Moves the current window to the front. -

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, 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/api/pl.treksoft.kvision.window/-window/is-draggable.html b/api/pl.treksoft.kvision.window/-window/is-draggable.html deleted file mode 100644 index 6432d5fb..00000000 --- a/api/pl.treksoft.kvision.window/-window/is-draggable.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/is-resizable.html b/api/pl.treksoft.kvision.window/-window/is-resizable.html deleted file mode 100644 index 3aa1e97a..00000000 --- a/api/pl.treksoft.kvision.window/-window/is-resizable.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/remove-all.html b/api/pl.treksoft.kvision.window/-window/remove-all.html deleted file mode 100644 index ad12c1d6..00000000 --- a/api/pl.treksoft.kvision.window/-window/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/remove.html b/api/pl.treksoft.kvision.window/-window/remove.html deleted file mode 100644 index aa47c2e0..00000000 --- a/api/pl.treksoft.kvision.window/-window/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/to-front.html b/api/pl.treksoft.kvision.window/-window/to-front.html deleted file mode 100644 index 73b48625..00000000 --- a/api/pl.treksoft.kvision.window/-window/to-front.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -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/api/pl.treksoft.kvision.window/-window/window.html b/api/pl.treksoft.kvision.window/-window/window.html deleted file mode 100644 index 452d2636..00000000 --- a/api/pl.treksoft.kvision.window/-window/window.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Window.window - kvision - - - -kvision / pl.treksoft.kvision.window / Window / window
-
-

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.

- - diff --git a/api/pl.treksoft.kvision.window/index.html b/api/pl.treksoft.kvision.window/index.html deleted file mode 100644 index 95c0f201..00000000 --- a/api/pl.treksoft.kvision.window/index.html +++ /dev/null @@ -1,27 +0,0 @@ - - - -pl.treksoft.kvision.window - kvision - - - -kvision / pl.treksoft.kvision.window
-
-

Package pl.treksoft.kvision.window

Floating, resizable window component.

Types

- - - - - - - -

Window

-open class Window : SimplePanel -

Floating window container.

- - -- cgit