From 0365722f8549ee93918be99da1b9f901cf0b2c8d Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Fri, 13 Mar 2020 01:05:20 +0100 Subject: API documentation for KVision 3.5.2 --- api/pl.treksoft.kvision.modal/-dialog/-init-.html | 4 +- .../-dialog/get-result.html | 4 +- api/pl.treksoft.kvision.modal/-dialog/hide.html | 3 +- api/pl.treksoft.kvision.modal/-dialog/index.html | 780 ++++++++------------- .../-dialog/set-result.html | 4 +- 5 files changed, 313 insertions(+), 482 deletions(-) (limited to 'api/pl.treksoft.kvision.modal/-dialog') diff --git a/api/pl.treksoft.kvision.modal/-dialog/-init-.html b/api/pl.treksoft.kvision.modal/-dialog/-init-.html index 15d17565..5fd84f10 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/-init-.html +++ b/api/pl.treksoft.kvision.modal/-dialog/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Dialog / <init>

<init>

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

Parameters

caption - window title

diff --git a/api/pl.treksoft.kvision.modal/-dialog/get-result.html b/api/pl.treksoft.kvision.modal/-dialog/get-result.html index 0c28a36f..680a5591 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/get-result.html +++ b/api/pl.treksoft.kvision.modal/-dialog/get-result.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Dialog / getResult

getResult

- -suspend fun getResult(): R? +(js) +suspend fun getResult(): R?

A suspending function returning result value.

diff --git a/api/pl.treksoft.kvision.modal/-dialog/hide.html b/api/pl.treksoft.kvision.modal/-dialog/hide.html index 1fe643eb..44fd8a0b 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/hide.html +++ b/api/pl.treksoft.kvision.modal/-dialog/hide.html @@ -8,9 +8,8 @@ kvision / pl.treksoft.kvision.modal / Dialog / hide

hide

- +(js) open fun hide(): Widget -

Overrides Modal.hide

Makes current widget invisible.

Return
current widget

diff --git a/api/pl.treksoft.kvision.modal/-dialog/index.html b/api/pl.treksoft.kvision.modal/-dialog/index.html index 08f902e3..87a8f26b 100644 --- a/api/pl.treksoft.kvision.modal/-dialog/index.html +++ b/api/pl.treksoft.kvision.modal/-dialog/index.html @@ -8,74 +8,18 @@ kvision / pl.treksoft.kvision.modal / Dialog

Dialog

-open class Dialog<R> : Modal +(js) open class Dialog<R> : Modal

Modal window with a result.

Constructors

- - -
-

<init>

+(js) +

<init>

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

Inherited Properties

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

animation

-		 -var animation: Boolean -

Determines if animations are used.

-
-

caption

-		 -var caption: String? -

Window caption text.

-
-

centered

-		 -var centered: Boolean -

Determines if modal dialog is vertically centered.

-
-

closeButton

-		 -var closeButton: Boolean -

Determines if Close button is visible.

-
-

parent

-		 -open var parent: Container?
-

size

-		 -var size: ModalSize? -

Window size.

-
@@ -84,148 +28,30 @@ -

getResult

+(js) +

getResult

-suspend fun getResult(): R?

A suspending function returning result value.

- +suspend fun getResult(): R? -

hide

+(js) +

hide

-open fun hide(): Widget

Makes current widget invisible.

- +open fun hide(): Widget -

setResult

+(js) +

setResult

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

A function to be called with a result value.

- - - - -

Inherited Functions

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

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.

-
-

clearParent

-		 -open fun clearParent(): Widget
-

getChildren

-		 -open fun getChildren(): List<Component> -

Returns a list of children of the current container.

-
-

getRoot

-		 -open fun getRoot(): Root?
-

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.

-
@@ -234,24 +60,27 @@ -

changeFlow

+(js) +

changeFlow

-val <T : Widget> T.changeFlow: <ERROR CLASS><T> +val <T : Widget> T.changeFlow: Flow<T> -

clickFlow

+(js) +

clickFlow

-val <T : Widget> T.clickFlow: <ERROR CLASS><T> +val <T : Widget> T.clickFlow: Flow<T> -

inputFlow

+(js) +

inputFlow

-val <T : Widget> T.inputFlow: <ERROR CLASS><T> +val <T : Widget> T.inputFlow: Flow<T> @@ -260,867 +89,870 @@ -

addBsBgColor

+(js) +

addBsBgColor

fun Component.addBsBgColor(bsBgColor: BsBgColor): Unit -

addBsBorder

+(js) +

addBsBorder

fun Component.addBsBorder(vararg bsBorder: BsBorder): Unit -

addBsClearfix

+(js) +

addBsClearfix

fun Component.addBsClearfix(): Unit -

addBsColor

+(js) +

addBsColor

fun Component.addBsColor(bsColor: BsColor): Unit -

addBsRounded

+(js) +

addBsRounded

fun Component.addBsRounded(vararg bsRounded: BsRounded): Unit -

bold

+(js) +

bold

-fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold

DSL builder extension function.

- +fun Container.bold(content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: (Bold.() -> Unit)? = null): Bold -

button

+(js) +

button

-fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: Boolean = false, classes: Set<String> = setOf(), init: (Button.() -> Unit)? = null): Button

DSL builder extension function.

- +fun Container.button(text: String, icon: String? = null, style: ButtonStyle = ButtonStyle.PRIMARY, type: ButtonType = ButtonType.BUTTON, disabled: