From eb930482e9972a21d39f2aea8b813acf58ff5b64 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Mon, 22 Oct 2018 00:01:39 +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 insertions(+) create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/-init-.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/align.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/animated.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/content.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/index.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/max.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/min.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/progress.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/rich.html create mode 100644 api/pl.treksoft.kvision.progress/-progress-bar/striped.html create 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 new file mode 100644 index 00000000..fc764b35 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/-init-.html @@ -0,0 +1,39 @@ + + + +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 new file mode 100644 index 00000000..08682713 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/align.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..84691635 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/animated.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..e56d0cf4 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/content.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..c7f47e86 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/index.html @@ -0,0 +1,203 @@ + + + +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 new file mode 100644 index 00000000..c78e8ded --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/max.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..33cd21b3 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/min.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..ba20eb10 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/progress-bar.html @@ -0,0 +1,16 @@ + + + +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 new file mode 100644 index 00000000..a1f32452 --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/progress.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..820555fe --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/rich.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..07a224ef --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/striped.html @@ -0,0 +1,15 @@ + + + +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 new file mode 100644 index 00000000..fa1bb89c --- /dev/null +++ b/api/pl.treksoft.kvision.progress/-progress-bar/style.html @@ -0,0 +1,15 @@ + + + +ProgressBar.style - kvision + + + +kvision / pl.treksoft.kvision.progress / ProgressBar / style
+
+

style

+ +var style: ProgressBarStyle? +

The style of the progress bar.

+ + -- cgit