From 61545b3f1fb1844af350d187edd26285e98f0466 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 26 Feb 2018 14:21:46 +0100 Subject: API documentation update --- .../pl.treksoft.kvision.modal/-modal/-init-.html | 4 +- .../-modal/animation.html | 6 +++ .../pl.treksoft.kvision.modal/-modal/caption.html | 2 +- .../-modal/get-children.html | 18 +++++++ .../pl.treksoft.kvision.modal/-modal/index.html | 60 +++++++++++----------- .../-modal/remove-all.html | 18 +++++++ .../pl.treksoft.kvision.modal/-modal/remove.html | 21 ++++++++ .../api/pl.treksoft.kvision.modal/-modal/size.html | 2 +- 8 files changed, 97 insertions(+), 34 deletions(-) create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/get-children.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html create mode 100644 docs/api/pl.treksoft.kvision.modal/-modal/remove.html (limited to 'docs/api/pl.treksoft.kvision.modal/-modal') diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html b/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html index 72c60464..0d729ed8 100644 --- a/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html +++ b/docs/api/pl.treksoft.kvision.modal/-modal/-init-.html @@ -8,8 +8,8 @@ kvision / pl.treksoft.kvision.modal / Modal / <init>

<init>

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

Parameters

caption - window title

diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/animation.html b/docs/api/pl.treksoft.kvision.modal/-modal/animation.html index adb207fc..d61b11b7 100644 --- a/docs/api/pl.treksoft.kvision.modal/-modal/animation.html +++ b/docs/api/pl.treksoft.kvision.modal/-modal/animation.html @@ -11,5 +11,11 @@ var animation: Boolean

Determines if animations are used.

+

Getter
+

Determines if animations are used.

+

+

Setter
+

Determines if animations are used.

+

diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/caption.html b/docs/api/pl.treksoft.kvision.modal/-modal/caption.html index 33afaf3d..cca2f4cc 100644 --- a/docs/api/pl.treksoft.kvision.modal/-modal/caption.html +++ b/docs/api/pl.treksoft.kvision.modal/-modal/caption.html @@ -10,6 +10,6 @@

caption

var caption: String? -

Window content text.

+

Window caption text.

diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html b/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html new file mode 100644 index 00000000..52431771 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/get-children.html @@ -0,0 +1,18 @@ + + + +Modal.getChildren - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / getChildren
+
+

getChildren

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

Overrides SimplePanel.getChildren

+

Returns a list of children of the current container.

+

Return
+list of children

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/index.html b/docs/api/pl.treksoft.kvision.modal/-modal/index.html index fe2c3fcb..4645b38f 100644 --- a/docs/api/pl.treksoft.kvision.modal/-modal/index.html +++ b/docs/api/pl.treksoft.kvision.modal/-modal/index.html @@ -18,7 +18,7 @@

<init>

-Modal(caption: String? = null, closeButton: Boolean = true, size: MODALSIZE? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: Modal.() -> Unit = null) +Modal(caption: String? = null, closeButton: Boolean = true, size: ModalSize? = null, animation: Boolean = true, escape: Boolean = true, classes: Set<String> = setOf(), init: Modal.() -> Unit = null) @@ -40,7 +40,7 @@ var caption: String? -

Window content text.

+

Window caption text.

@@ -57,7 +57,7 @@

size

-var size: MODALSIZE? +var size: ModalSize?

Window size.

@@ -104,6 +104,15 @@ +

getChildren

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

Returns a list of children of the current container.

+ + + +

getSnAttrs

@@ -131,6 +140,24 @@ +

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

@@ -181,33 +208,6 @@ -

getChildren

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

Returns a list of children of the current container.

- - - - -

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.

- - - -

render

diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html new file mode 100644 index 00000000..456f46c8 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/remove-all.html @@ -0,0 +1,18 @@ + + + +Modal.removeAll - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / removeAll
+
+

removeAll

+ +open fun removeAll(): SimplePanel +

Overrides SimplePanel.removeAll

+

Removes all children from the current container.

+

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/remove.html b/docs/api/pl.treksoft.kvision.modal/-modal/remove.html new file mode 100644 index 00000000..d3023386 --- /dev/null +++ b/docs/api/pl.treksoft.kvision.modal/-modal/remove.html @@ -0,0 +1,21 @@ + + + +Modal.remove - kvision + + + +kvision / pl.treksoft.kvision.modal / Modal / remove
+
+

remove

+ +open fun remove(child: Component): SimplePanel +

Overrides SimplePanel.remove

+

Removes given component from the current container.

+

Parameters

+

+child - child component

+

Return
+current container

+ + diff --git a/docs/api/pl.treksoft.kvision.modal/-modal/size.html b/docs/api/pl.treksoft.kvision.modal/-modal/size.html index d357c3dc..6b129cb5 100644 --- a/docs/api/pl.treksoft.kvision.modal/-modal/size.html +++ b/docs/api/pl.treksoft.kvision.modal/-modal/size.html @@ -9,7 +9,7 @@

size

-var size: MODALSIZE? +var size: ModalSize?

Window size.

-- cgit