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/-alert/-init-.html | 31 +++ .../pl.treksoft.kvision.modal/-alert/align.html | 15 ++ .../pl.treksoft.kvision.modal/-alert/hide.html | 18 ++ .../pl.treksoft.kvision.modal/-alert/index.html | 240 +++++++++++++++++++++ .../pl.treksoft.kvision.modal/-alert/rich.html | 15 ++ .../pl.treksoft.kvision.modal/-alert/show.html | 30 +++ .../pl.treksoft.kvision.modal/-alert/text.html | 15 ++ 7 files changed, 364 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/align.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/hide.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/index.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/rich.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/show.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-alert/text.html (limited to 'api/kvision/pl.treksoft.kvision.modal/-alert') diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/-init-.html b/api/kvision/pl.treksoft.kvision.modal/-alert/-init-.html new file mode 100644 index 00000000..ac6a287a --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/-init-.html @@ -0,0 +1,31 @@ + + + +Alert.<init> - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / <init>
+
+

<init>

+ +

Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: () -> Unit = null)

Parameters

+caption - window title

+text - window content text.

+rich - determines if text can contain HTML code

+align - text align

+size - modal window size

+animation - determines if animations are used

+callback - a function called after closing window with OK button

Constructor
+

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/align.html b/api/kvision/pl.treksoft.kvision.modal/-alert/align.html new file mode 100644 index 00000000..e3d0bf4d --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/align.html @@ -0,0 +1,15 @@ + + + +Alert.align - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / align
+
+

align

+ +var align: Align? +

Text align.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/hide.html b/api/kvision/pl.treksoft.kvision.modal/-alert/hide.html new file mode 100644 index 00000000..f165c34f --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/hide.html @@ -0,0 +1,18 @@ + + + +Alert.hide - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / 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/-alert/index.html b/api/kvision/pl.treksoft.kvision.modal/-alert/index.html new file mode 100644 index 00000000..4a5a7428 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/index.html @@ -0,0 +1,240 @@ + + + +Alert - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert
+
+

Alert

+open class Alert : Modal +

Alert window based on Bootstrap modal.

Constructors

+ + + + + + + +

<init>

Alert(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: () -> Unit = null)

Properties

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

+ align +	+`var align: Align?` + Text align. +
+ rich +	+`var rich: Boolean` + Determines if text can contain HTML code. +
+ text +	+`var text: String?` + Window content text. +

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

+ + + + + + + +

hide

+open fun hide(): Widget +

Makes current widget invisible.

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

Companion Object Functions

+ + + + + + + +

show

fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: () -> Unit = null): Unit

Helper function for opening Alert window.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/rich.html b/api/kvision/pl.treksoft.kvision.modal/-alert/rich.html new file mode 100644 index 00000000..68f4b08a --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/rich.html @@ -0,0 +1,15 @@ + + + +Alert.rich - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / rich
+
+

rich

+ +var rich: Boolean +

Determines if text can contain HTML code.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/show.html b/api/kvision/pl.treksoft.kvision.modal/-alert/show.html new file mode 100644 index 00000000..80c160e4 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/show.html @@ -0,0 +1,30 @@ + + + +Alert.show - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / show
+
+

show

+ +

fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, callback: () -> Unit = null): Unit

Helper function for opening Alert window.

Parameters

+caption - window title

+text - window content text.

+rich - determines if text can contain HTML code

+align - text align

+size - modal window size

+animation - determines if animations are used

+callback - a function called after closing window with OK button

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-alert/text.html b/api/kvision/pl.treksoft.kvision.modal/-alert/text.html new file mode 100644 index 00000000..9f6f4e31 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-alert/text.html @@ -0,0 +1,15 @@ + + + +Alert.text - kvision + + + +kvision / pl.treksoft.kvision.modal / Alert / text
+
+

text

+ +var text: String? +

Window content text.

+ + -- cgit