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 --- .../pl.treksoft.kvision.modal/-dialog/-init-.html | 31 +++ .../-dialog/get-result.html | 15 ++ .../pl.treksoft.kvision.modal/-dialog/hide.html | 18 ++ .../pl.treksoft.kvision.modal/-dialog/index.html | 212 +++++++++++++++++++++ .../-dialog/set-result.html | 15 ++ 5 files changed, 291 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.modal/-dialog/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-dialog/get-result.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-dialog/hide.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-dialog/index.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-dialog/set-result.html (limited to 'api/kvision/pl.treksoft.kvision.modal/-dialog') diff --git a/api/kvision/pl.treksoft.kvision.modal/-dialog/-init-.html b/api/kvision/pl.treksoft.kvision.modal/-dialog/-init-.html new file mode 100644 index 00000000..e7ae6cae --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-dialog/-init-.html @@ -0,0 +1,31 @@ + + + +Dialog.<init> - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / <init>
+
+

<init>

+ +

Dialog(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: Dialog<R>.() -> 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/api/kvision/pl.treksoft.kvision.modal/-dialog/get-result.html b/api/kvision/pl.treksoft.kvision.modal/-dialog/get-result.html new file mode 100644 index 00000000..0c28a36f --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-dialog/get-result.html @@ -0,0 +1,15 @@ + + + +Dialog.getResult - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / getResult
+
+

getResult

+ +suspend fun getResult(): R? +

A suspending function returning result value.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-dialog/hide.html b/api/kvision/pl.treksoft.kvision.modal/-dialog/hide.html new file mode 100644 index 00000000..1fe643eb --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-dialog/hide.html @@ -0,0 +1,18 @@ + + + +Dialog.hide - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / hide
+
+

hide

+ +open fun hide(): Widget +

Overrides Modal.hide

Makes current widget invisible.

Return
+current widget

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-dialog/index.html b/api/kvision/pl.treksoft.kvision.modal/-dialog/index.html new file mode 100644 index 00000000..0799f65e --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-dialog/index.html @@ -0,0 +1,212 @@ + + + +Dialog - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog
+
+

Dialog

+open class Dialog<R> : Modal +

Modal window with a result.

Constructors

+ + + + + + + +

<init>

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

Inherited 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

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

+ getResult +	+`suspend fun getResult(): R?` + A suspending function returning result value. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ setResult +	+`open fun setResult(result: R?): Unit` + A function to be called with a result value. +

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

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-dialog/set-result.html b/api/kvision/pl.treksoft.kvision.modal/-dialog/set-result.html new file mode 100644 index 00000000..d7d7f9b4 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-dialog/set-result.html @@ -0,0 +1,15 @@ + + + +Dialog.setResult - kvision + + + +kvision / pl.treksoft.kvision.modal / Dialog / setResult
+
+

setResult

+ +open fun setResult(result: R?): Unit +

A function to be called with a result value.

+ + -- cgit