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/-confirm/-init-.html | 41 ++++ .../pl.treksoft.kvision.modal/-confirm/align.html | 15 ++ .../-confirm/cancel-title.html | 15 ++ .../-confirm/cancel-visible.html | 21 ++ .../pl.treksoft.kvision.modal/-confirm/index.html | 271 +++++++++++++++++++++ .../-confirm/no-title.html | 15 ++ .../pl.treksoft.kvision.modal/-confirm/rich.html | 15 ++ .../pl.treksoft.kvision.modal/-confirm/show.html | 34 +++ .../pl.treksoft.kvision.modal/-confirm/text.html | 15 ++ .../-confirm/yes-title.html | 15 ++ 10 files changed, 457 insertions(+) create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/-init-.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/align.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-title.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-visible.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/index.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/no-title.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/rich.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/show.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/text.html create mode 100644 api/kvision/pl.treksoft.kvision.modal/-confirm/yes-title.html (limited to 'api/kvision/pl.treksoft.kvision.modal/-confirm') diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/-init-.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/-init-.html new file mode 100644 index 00000000..7bf6f68f --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/-init-.html @@ -0,0 +1,41 @@ + + + +Confirm.<init> - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / <init>
+
+

<init>

+ +

Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> 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

+cancelVisible - determines if Cancel button is visible

+yesTitle - yes button text

+noTitle - no button text

+cancelTitle - cancel button text

+noCallback - a function called after closing window with No button

+yesCallback - a function called after closing window with Yes button

Constructor
+

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

align

+ +var align: Align? +

Text align.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-title.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-title.html new file mode 100644 index 00000000..b010823b --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-title.html @@ -0,0 +1,15 @@ + + + +Confirm.cancelTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / cancelTitle
+
+

cancelTitle

+ +var cancelTitle: String +

Cancel button text.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-visible.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-visible.html new file mode 100644 index 00000000..9260eafa --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/cancel-visible.html @@ -0,0 +1,21 @@ + + + +Confirm.cancelVisible - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / cancelVisible
+
+

cancelVisible

+ +var cancelVisible: Boolean +

Determines if Cancel button is visible.

Getter
+

Determines if Cancel button is visible.

Setter
+

Determines if Cancel button is visible.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/index.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/index.html new file mode 100644 index 00000000..2d4ecbbb --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/index.html @@ -0,0 +1,271 @@ + + + +Confirm - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm
+
+

Confirm

+open class Confirm : Modal +

Confirm window based on Bootstrap modal.

Constructors

+ + + + + + + +

<init>

Confirm(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> Unit = null)

Properties

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

+ align +	+`var align: Align?` + Text align. +
+ cancelTitle +	+`var cancelTitle: String` + Cancel button text. +
+ cancelVisible +	+`var cancelVisible: Boolean` + Determines if Cancel button is visible. +
+ noTitle +	+`var noTitle: String` + No button text. +
+ rich +	+`var rich: Boolean` + Determines if text can contain HTML code. +
+ text +	+`var text: String?` + Window content text. +
+ yesTitle +	+`var yesTitle: String` + Yes button 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. +

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

Companion Object Functions

+ + + + + + + +

show

fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> Unit = null): Unit

Helper function for opening Confirm window.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/no-title.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/no-title.html new file mode 100644 index 00000000..93a01de5 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/no-title.html @@ -0,0 +1,15 @@ + + + +Confirm.noTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / noTitle
+
+

noTitle

+ +var noTitle: String +

No button text.

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

rich

+ +var rich: Boolean +

Determines if text can contain HTML code.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/show.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/show.html new file mode 100644 index 00000000..be7a4c93 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/show.html @@ -0,0 +1,34 @@ + + + +Confirm.show - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / show
+
+

show

+ +

fun show(caption: String? = null, text: String? = null, rich: Boolean = false, align: Align? = null, size: ModalSize? = null, animation: Boolean = true, cancelVisible: Boolean = false, yesTitle: String = "Yes", noTitle: String = "No", cancelTitle: String = "Cancel", noCallback: () -> Unit = null, yesCallback: () -> Unit = null): Unit

Helper function for opening Confirm 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

+cancelVisible - determines if Cancel button is visible

+noCallback - a function called after closing window with No button

+yesCallback - a function called after closing window with Yes button

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

text

+ +var text: String? +

Window content text.

+ + diff --git a/api/kvision/pl.treksoft.kvision.modal/-confirm/yes-title.html b/api/kvision/pl.treksoft.kvision.modal/-confirm/yes-title.html new file mode 100644 index 00000000..05a653f7 --- /dev/null +++ b/api/kvision/pl.treksoft.kvision.modal/-confirm/yes-title.html @@ -0,0 +1,15 @@ + + + +Confirm.yesTitle - kvision + + + +kvision / pl.treksoft.kvision.modal / Confirm / yesTitle
+
+

yesTitle

+ +var yesTitle: String +

Yes button text.

+ + -- cgit