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 --- .../-progress-bar/-init-.html | 39 ---- .../-progress-bar/align.html | 15 -- .../-progress-bar/animated.html | 15 -- .../-progress-bar/content.html | 15 -- .../-progress-bar/index.html | 203 --------------------- .../-progress-bar/max.html | 15 -- .../-progress-bar/min.html | 15 -- .../-progress-bar/progress-bar.html | 16 -- .../-progress-bar/progress.html | 15 -- .../-progress-bar/rich.html | 15 -- .../-progress-bar/striped.html | 15 -- .../-progress-bar/style.html | 15 -- 12 files changed, 393 deletions(-) delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/-init-.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/align.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/animated.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/content.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/index.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/max.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/min.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/progress.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/rich.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/striped.html delete mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/style.html (limited to 'api/pl.treksoft.kvision.progress/-progress-bar') diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/-init-.html b/api/pl.treksoft.kvision.progress/-progress-bar/-init-.html deleted file mode 100644 index fc764b35..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/-init-.html +++ /dev/null @@ -1,39 +0,0 @@ - - - -ProgressBar.<init> - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / <init>
-
-

<init>

- -

ProgressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: ProgressBar.() -> Unit = null)

Parameters

-progress - the current progress

-min - the minimal progress

-max - the maximal progress

-style - the style of the progress bar

-striped - determines if the progress bar is striped

-animated - determines if the progress bar is animated

-content - element text

-rich - determines if content can contain HTML code

-align - content align

-classes - a set of CSS class names

-init - an initializer extension function

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/align.html b/api/pl.treksoft.kvision.progress/-progress-bar/align.html deleted file mode 100644 index 08682713..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/align.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.align - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / align
-
-

align

- -var align: Align? -

Text align of the progress bar.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/animated.html b/api/pl.treksoft.kvision.progress/-progress-bar/animated.html deleted file mode 100644 index 84691635..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/animated.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.animated - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / animated
-
-

animated

- -var animated: Boolean -

Determines if the progress bar is animated.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/content.html b/api/pl.treksoft.kvision.progress/-progress-bar/content.html deleted file mode 100644 index e56d0cf4..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/content.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.content - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / content
-
-

content

- -var content: String? -

Text content of the progress bar.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/index.html b/api/pl.treksoft.kvision.progress/-progress-bar/index.html deleted file mode 100644 index c7f47e86..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/index.html +++ /dev/null @@ -1,203 +0,0 @@ - - - -ProgressBar - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar
-
-

ProgressBar

-open class ProgressBar : SimplePanel -

The Bootstrap progress bar.

Constructors

- - - - - - - -

<init>

ProgressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: ProgressBar.() -> Unit = null)

Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- align -	-`var align: Align?` - Text align of the progress bar. -
- animated -	-`var animated: Boolean` - Determines if the progress bar is animated. -
- content -	-`var content: String?` - Text content of the progress bar. -
- max -	-`var max: Int` - The maximal progress. -
- min -	-`var min: Int` - The minimal progress. -
- progress -	-`var progress: Int` - The current progress. -
- rich -	-`var rich: Boolean` - Determines if content can contain HTML code. -
- striped -	-`var striped: Boolean` - Determines if the progress bar is striped. -
- style -	-`var style: ProgressBarStyle?` - The style of the progress bar. -

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. -
- addInternal -	-`fun addInternal(child: Component): SimplePanel` - Protected and final method to add given component to the current container. -
- childrenVNodes -	-`open fun childrenVNodes(): Array<VNode>` - Returns the array of the children Snabbdom vnodes. -
- 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 -	-`open fun render(): VNode` - Renders current component as a Snabbdom vnode. -

Companion Object Functions

- - - - - - - -

progressBar

fun Container.progressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: ProgressBar.() -> Unit = null): ProgressBar

DSL builder extension function.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/max.html b/api/pl.treksoft.kvision.progress/-progress-bar/max.html deleted file mode 100644 index c78e8ded..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/max.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.max - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / max
-
-

max

- -var max: Int -

The maximal progress.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/min.html b/api/pl.treksoft.kvision.progress/-progress-bar/min.html deleted file mode 100644 index 33cd21b3..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/min.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.min - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / min
-
-

min

- -var min: Int -

The minimal progress.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html b/api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html deleted file mode 100644 index ba20eb10..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -ProgressBar.progressBar - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / progressBar
-
-

progressBar

- -

fun Container.progressBar(progress: Int, min: Int = DEFAULT_MIN, max: Int = DEFAULT_MAX, style: ProgressBarStyle? = null, striped: Boolean = false, animated: Boolean = false, content: String? = null, rich: Boolean = false, align: Align? = null, classes: Set<String> = setOf(), init: ProgressBar.() -> Unit = null): ProgressBar

DSL builder extension function.

It takes the same parameters as the constructor of the built component.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/progress.html b/api/pl.treksoft.kvision.progress/-progress-bar/progress.html deleted file mode 100644 index a1f32452..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/progress.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.progress - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / progress
-
-

progress

- -var progress: Int -

The current progress.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/rich.html b/api/pl.treksoft.kvision.progress/-progress-bar/rich.html deleted file mode 100644 index 820555fe..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/rich.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.rich - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / rich
-
-

rich

- -var rich: Boolean -

Determines if content can contain HTML code.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/striped.html b/api/pl.treksoft.kvision.progress/-progress-bar/striped.html deleted file mode 100644 index 07a224ef..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/striped.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.striped - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / striped
-
-

striped

- -var striped: Boolean -

Determines if the progress bar is striped.

- - diff --git a/api/pl.treksoft.kvision.progress/-progress-bar/style.html b/api/pl.treksoft.kvision.progress/-progress-bar/style.html deleted file mode 100644 index fa1bb89c..00000000 --- a/api/pl.treksoft.kvision.progress/-progress-bar/style.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -ProgressBar.style - kvision - - - -kvision / pl.treksoft.kvision.progress / ProgressBar / style
-
-

style

- -var style: ProgressBarStyle? -

The style of the progress bar.

- - -- cgit