From d8cd67062b8de6e8398dc6dfd00d201200c82414 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 9 Feb 2018 13:40:35 +0100 Subject: API doc and readme --- .../pl.treksoft.kvision.modal/-alert/index.html | 213 +++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 docs/api/pl.treksoft.kvision.modal/-alert/index.html (limited to 'docs/api/pl.treksoft.kvision.modal/-alert/index.html') diff --git a/docs/api/pl.treksoft.kvision.modal/-alert/index.html b/docs/api/pl.treksoft.kvision.modal/-alert/index.html new file mode 100644 index 00000000..80b5facf --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-alert/index.html @@ -0,0 +1,213 @@ + + + +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 content 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. +
+ 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. +
+ 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.

+ + -- cgit