From f3c9d405382dd81d426c7eab1f6390ec8e6dad00 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 5 Mar 2018 08:45:25 +0100 Subject: Documentation update. --- .../pl.treksoft.kvision.modal/-modal/-init-.html | 31 --- .../pl.treksoft.kvision.modal/-modal/add-all.html | 21 -- .../-modal/add-button.html | 20 -- docs/api/pl.treksoft.kvision.modal/-modal/add.html | 21 -- .../-modal/after-insert.html | 16 -- .../-modal/animation.html | 21 -- .../pl.treksoft.kvision.modal/-modal/caption.html | 15 -- .../-modal/close-button.html | 15 -- .../-modal/get-children.html | 18 -- .../-modal/get-sn-attrs.html | 18 -- .../-modal/get-sn-class.html | 18 -- .../api/pl.treksoft.kvision.modal/-modal/hide.html | 18 -- .../pl.treksoft.kvision.modal/-modal/index.html | 244 --------------------- .../-modal/remove-all-buttons.html | 17 -- .../-modal/remove-all.html | 18 -- .../-modal/remove-button.html | 20 -- .../pl.treksoft.kvision.modal/-modal/remove.html | 21 -- .../api/pl.treksoft.kvision.modal/-modal/size.html | 15 -- .../pl.treksoft.kvision.modal/-modal/toggle.html | 15 -- 19 files changed, 582 deletions(-) delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/-init-.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add-all.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add-button.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/add.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/animation.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/caption.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/close-button.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-children.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/hide.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/index.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/size.html delete mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/toggle.html (limited to 'docs/api/pl.treksoft.kvision.modal/-modal') diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html b/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html deleted file mode 100644 index 0d729ed8..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html +++ /dev/null @@ -1,31 +0,0 @@ - - - -Modal.<init> - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / <init>
-
-

<init>

- -

Modal(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: Modal.() -> Unit = null)

Parameters

-caption - window title

-closeButton - determines if Close button is visible

-size - modal window size

-animation - determines if animations are used

-escape - determines if dialog can be closed with Esc key

-classes - a set of CSS class names

-init - an initializer extension function

Constructor
-

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/add-all.html b/docs/api/pl.treksoft.kvision.modal/-modal/add-all.html deleted file mode 100644 index 041fba75..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Modal.addAll - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/add-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/add-button.html deleted file mode 100644 index e5390b90..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/add-button.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -Modal.addButton - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / addButton
-
-

addButton

- -open fun addButton(button: Button): Modal -

Adds given button to the bottom section of dialog window.

Parameters

-button - a Button component

Return
-this modal

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/add.html b/docs/api/pl.treksoft.kvision.modal/-modal/add.html deleted file mode 100644 index 0bc14a86..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Modal.add - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/after-insert.html b/docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html deleted file mode 100644 index b69374d3..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/after-insert.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -Modal.afterInsert - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / afterInsert
-
-

afterInsert

- -protected open fun afterInsert(node: VNode): Unit -

Overrides Widget.afterInsert

Method called after inserting Snabbdom vnode into the DOM.

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/animation.html b/docs/api/pl.treksoft.kvision.modal/-modal/animation.html deleted file mode 100644 index d61b11b7..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/animation.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Modal.animation - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / animation
-
-

animation

- -var animation: Boolean -

Determines if animations are used.

Getter
-

Determines if animations are used.

Setter
-

Determines if animations are used.

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/caption.html b/docs/api/pl.treksoft.kvision.modal/-modal/caption.html deleted file mode 100644 index cca2f4cc..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/caption.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Modal.caption - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / caption
-
-

caption

- -var caption: String? -

Window caption text.

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/close-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/close-button.html deleted file mode 100644 index 4810bdbb..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/close-button.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Modal.closeButton - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / closeButton
-
-

closeButton

- -var closeButton: Boolean -

Determines if Close button is visible.

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html deleted file mode 100644 index 52431771..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Modal.getChildren - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/get-sn-attrs.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html deleted file mode 100644 index e10a5b85..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-attrs.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Modal.getSnAttrs - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / getSnAttrs
-
-

getSnAttrs

- -protected open fun getSnAttrs(): List<StringPair> -

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
-list of element attributes

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html deleted file mode 100644 index 150af720..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Modal.getSnClass - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / getSnClass
-
-

getSnClass

- -protected open fun getSnClass(): List<StringBoolPair> -

Overrides Widget.getSnClass

Returns list of CSS class names for current widget in the form of a List.

Return
-list of CSS class names

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/hide.html b/docs/api/pl.treksoft.kvision.modal/-modal/hide.html deleted file mode 100644 index 28a61d3f..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/hide.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Modal.hide - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / hide
-
-

hide

- -open fun hide(): Widget -

Overrides Widget.hide

Makes current widget invisible.

Return
-current widget

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/index.html b/docs/api/pl.treksoft.kvision.modal/-modal/index.html deleted file mode 100644 index 4645b38f..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/index.html +++ /dev/null @@ -1,244 +0,0 @@ - - - -Modal - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal
-
-

Modal

-open class Modal : SimplePanel -

Configurable modal window based on Bootstrap modal.

Constructors

- - - - - - - -

<init>

Modal(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: Modal.() -> Unit = null)

Properties

- - - - - - - - - - - - - - - - - - - -

- animation -	-`var animation: Boolean` - Determines if animations are used. -
- caption -	-`var caption: String?` - Window caption text. -
- closeButton -	-`var closeButton: Boolean` - Determines if Close button is visible. -
- size -	-`var size: ModalSize?` - Window size. -

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. -
- addButton -	-`open fun addButton(button: Button): Modal` - Adds given button to the bottom section of dialog window. -
- afterInsert -	-`open fun afterInsert(node: VNode): Unit` - Method called after inserting Snabbdom vnode into the DOM. -
- getChildren -	-`open fun getChildren(): List<Component>` - Returns a list of children of the current container. -
- getSnAttrs -	-`open fun getSnAttrs(): List<StringPair>` - Returns list of element attributes in the form of a List. -
- getSnClass -	-`open fun getSnClass(): List<StringBoolPair>` - Returns list of CSS class names for current widget in the form of a List. -
- hide -	-`open fun hide(): Widget` - Makes current widget invisible. -
- 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. -
- removeAllButtons -	-`open fun removeAllButtons(): Modal` - Removes all buttons from the bottom section of dialog window. -
- removeButton -	-`open fun removeButton(button: Button): Modal` - Removes given button from the bottom section of dialog window. -
- toggle -	-`open fun toggle(): Unit` - Toggle modal window visibility. -

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. -

Inheritors

- - - - - - - - - - - -

- Alert -	-`open class Alert : Modal` - Alert window based on Bootstrap modal. -
- Confirm -	-`open class Confirm : Modal` - Confirm window based on Bootstrap modal. -

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html deleted file mode 100644 index f9e101b3..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all-buttons.html +++ /dev/null @@ -1,17 +0,0 @@ - - - -Modal.removeAllButtons - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / removeAllButtons
-
-

removeAllButtons

- -open fun removeAllButtons(): Modal -

Removes all buttons from the bottom section of dialog window.

Return
-this modal

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html deleted file mode 100644 index 456f46c8..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -Modal.removeAll - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/remove-button.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html deleted file mode 100644 index e9264cc4..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/remove-button.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -Modal.removeButton - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / removeButton
-
-

removeButton

- -open fun removeButton(button: Button): Modal -

Removes given button from the bottom section of dialog window.

Parameters

-button - a Button component

Return
-this modal

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove.html deleted file mode 100644 index d3023386..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/remove.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -Modal.remove - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / 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.modal/-modal/size.html b/docs/api/pl.treksoft.kvision.modal/-modal/size.html deleted file mode 100644 index 6b129cb5..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/size.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Modal.size - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / size
-
-

size

- -var size: ModalSize? -

Window size.

- - diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/toggle.html b/docs/api/pl.treksoft.kvision.modal/-modal/toggle.html deleted file mode 100644 index a4c26897..00000000 --- a/docs/api/pl.treksoft.kvision.modal/-modal/toggle.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -Modal.toggle - kvision - - - -kvision / pl.treksoft.kvision.modal / Modal / toggle
-
-

toggle

- -open fun toggle(): Unit -

Toggle modal window visibility.

- - -- cgit