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.core/-style/-init-.html | 2 +- .../-style/-refresh-delegate-provider/-init-.html | 4 +- .../-style/-refresh-delegate-provider/index.html | 12 +- .../provide-delegate.html | 4 +- .../-style/-refresh-delegate/-init-.html | 4 +- .../-style/-refresh-delegate/get-value.html | 4 +- .../-style/-refresh-delegate/index.html | 17 +- .../-style/-refresh-delegate/set-value.html | 4 +- .../-style/class-name.html | 2 +- api/pl.treksoft.kvision.core/-style/index.html | 596 +-------------------- .../-style/refresh-on-update.html | 6 +- 11 files changed, 49 insertions(+), 606 deletions(-) (limited to 'api/pl.treksoft.kvision.core/-style') diff --git a/api/pl.treksoft.kvision.core/-style/-init-.html b/api/pl.treksoft.kvision.core/-style/-init-.html index b0fa21bd..86cc4aec 100644 --- a/api/pl.treksoft.kvision.core/-style/-init-.html +++ b/api/pl.treksoft.kvision.core/-style/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / <init>

<init>

- +(js) Style(className: String? = null, parentStyle: Style? = null, init: (Style.() -> Unit)? = null)

Parameters

diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/-init-.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/-init-.html index 54ba6ded..ca5c28cc 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/-init-.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegateProvider / <init>

<init>

- -RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit) +(js) +RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit) diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/index.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/index.html index dd75b668..caa12157 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/index.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/index.html @@ -8,16 +8,17 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegateProvider

RefreshDelegateProvider

-protected inner class RefreshDelegateProvider<T> +(js) protected inner class RefreshDelegateProvider<T>

Constructors

+RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit)
-

<init>

+(js) +

<init>

 -RefreshDelegateProvider(initialValue: T?, refreshFunction: (T) -> Unit)
@@ -26,10 +27,11 @@ -

provideDelegate

+(js) +

provideDelegate

-operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): Style.RefreshDelegate<T> +operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): RefreshDelegate<T> diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/provide-delegate.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/provide-delegate.html index 25e8902a..95447515 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/provide-delegate.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate-provider/provide-delegate.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegateProvider / provideDelegate

provideDelegate

- -operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): Style.RefreshDelegate<T> +(js) +operator fun provideDelegate(thisRef: Any?, prop: KProperty<*>): RefreshDelegate<T> diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/-init-.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/-init-.html index c154bab1..3f6ca448 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/-init-.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/-init-.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegate / <init>

<init>

- -RefreshDelegate(refreshFunction: (T) -> Unit) +(js) +RefreshDelegate(refreshFunction: (T) -> Unit) diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/get-value.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/get-value.html index eb3fdf83..4156cf82 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/get-value.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/get-value.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegate / getValue

getValue

- -operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T +(js) +operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/index.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/index.html index be2743d6..214d523e 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/index.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/index.html @@ -8,16 +8,17 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegate

RefreshDelegate

-protected inner class RefreshDelegate<T> +(js) protected inner class RefreshDelegate<T>

Constructors

+RefreshDelegate(refreshFunction: (T) -> Unit)
-

<init>

+(js) +

<init>

 -RefreshDelegate(refreshFunction: (T) -> Unit)
@@ -26,17 +27,19 @@ -

getValue

+(js) +

getValue

-operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T +operator fun getValue(thisRef: StyledComponent, property: KProperty<*>): T -

setValue

+(js) +

setValue

-operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit +operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit diff --git a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/set-value.html b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/set-value.html index 4681541b..5dfa2078 100644 --- a/api/pl.treksoft.kvision.core/-style/-refresh-delegate/set-value.html +++ b/api/pl.treksoft.kvision.core/-style/-refresh-delegate/set-value.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / RefreshDelegate / setValue

setValue

- -operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit +(js) +operator fun setValue(thisRef: StyledComponent, property: KProperty<*>, value: T): Unit diff --git a/api/pl.treksoft.kvision.core/-style/class-name.html b/api/pl.treksoft.kvision.core/-style/class-name.html index b2bf419b..88c2f33f 100644 --- a/api/pl.treksoft.kvision.core/-style/class-name.html +++ b/api/pl.treksoft.kvision.core/-style/class-name.html @@ -8,7 +8,7 @@ kvision / pl.treksoft.kvision.core / Style / className

className

- +(js) var className: String

The name of the CSS class.

Getter
diff --git a/api/pl.treksoft.kvision.core/-style/index.html b/api/pl.treksoft.kvision.core/-style/index.html index 141a234b..3edf84d0 100644 --- a/api/pl.treksoft.kvision.core/-style/index.html +++ b/api/pl.treksoft.kvision.core/-style/index.html @@ -8,21 +8,23 @@ kvision / pl.treksoft.kvision.core / Style

Style

-open class Style : StyledComponent +(js) open class Style : StyledComponent

CSS style object.

Types

@@ -34,7 +36,8 @@ @@ -46,548 +49,12 @@ - - -
-

RefreshDelegate

+(js) +

RefreshDelegate

 inner class RefreshDelegate<T>
-

RefreshDelegateProvider

+(js) +

RefreshDelegateProvider

 inner class RefreshDelegateProvider<T>
-

<init>

+(js) +

<init>

 Style(className: String? = null, parentStyle: Style? = null, init: (Style.() -> Unit)? = null)
-

className

+(js) +

className

 -var className: String

The name of the CSS class.

-
-

Inherited Properties

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +var className: String
-

background

-		 -open var background: Background? -

Background of the current component.

-
-

border

-		 -open var border: Border? -

Border of the current component.

-
-

borderBottom

-		 -open var borderBottom: Border? -

Bottom border of the current component.

-
-

borderLeft

-		 -open var borderLeft: Border? -

Left border of the current component.

-
-

borderRight

-		 -open var borderRight: Border? -

Right border of the current component.

-
-

borderTop

-		 -open var borderTop: Border? -

Top border of the current component.

-
-

bottom

-		 -open var bottom: CssSize? -

Bottom edge of the current component.

-
-

clear

-		 -open var clear: Clear? -

CSS clear float of the current component.

-
-

color

-		 -open var color: Color? -

Text color for the current component.

-
-

colorHex

-		 -open var colorHex: Int? -

Text color for the current component given in hex format (write only).

-
-

colorName

-		 -open var colorName: Col? -

Text color for the current component given with named constant (write only).

-
-

cursor

-		 -open var cursor: Cursor? -

CSS cursor shape over the current component.

-
-

display

-		 -open var display: Display? -

CSS display of the current component.

-
-

float

-		 -open var float: PosFloat? -

CSS position float of the current component.

-
-

fontFamily

-		 -open var fontFamily: String? -

CSS font family of the current component.

-
-

fontSize

-		 -open var fontSize: CssSize? -

CSS font size of the current component.

-
-

fontStyle

-		 -open var fontStyle: FontStyle? -

CSS font style of the current component.

-
-

fontVariant

-		 -open var fontVariant: FontVariant? -

CSS font variant of the current component.

-
-

fontWeight

-		 -open var fontWeight: FontWeight? -

CSS font weight of the current component.

-
-

height

-		 -open var height: CssSize? -

Height of the current component.

-
-

left

-		 -open var left: CssSize? -

Left edge of the current component.

-
-

letterSpacing

-		 -open var letterSpacing: CssSize? -

CSS Text letter spacing of the current component.

-
-

lineBreak

-		 -open var lineBreak: LineBreak? -

CSS line break of the current component.

-
-

lineHeight

-		 -open var lineHeight: CssSize? -

CSS Text line height of the current component.

-
-

margin

-		 -open var margin: CssSize? -

Margin of the current component.

-
-

marginBottom

-		 -open var marginBottom: CssSize? -

Bottom margin of the current component.

-
-

marginLeft

-		 -open var marginLeft: CssSize? -

Left margin of the current component.

-
-

marginRight

-		 -open var marginRight: CssSize? -

Right margin of the current component.

-
-

marginTop

-		 -open var marginTop: CssSize? -

Top margin of the current component.

-
-

maxHeight

-		 -open var maxHeight: CssSize? -

Maximal height of the current component.

-
-

maxWidth

-		 -open var maxWidth: CssSize? -

Maximal width of the current component.

-
-

minHeight

-		 -open var minHeight: CssSize? -

Minimal height of the current component.

-
-

minWidth

-		 -open var minWidth: CssSize? -

Minimal width of the current component.

-
-

opacity

-		 -open var opacity: Double? -

Opacity of the current component.

-
-

overflow

-		 -open var overflow: Overflow? -

CSS overflow of the current component.

-
-

overflowWrap

-		 -open var overflowWrap: OverflowWrap? -

CSS overflow-wrap of the current component.

-
-

padding

-		 -open var padding: CssSize? -

Padding of the current component.

-
-

paddingBottom

-		 -open var paddingBottom: CssSize? -

Bottom padding of the current component.

-
-

paddingLeft

-		 -open var paddingLeft: CssSize? -

Left padding of the current component.

-
-

paddingRight

-		 -open var paddingRight: CssSize? -

Right padding of the current component.

-
-

paddingTop

-		 -open var paddingTop: CssSize? -

Top padding of the current component.

-
-

position

-		 -open var position: Position? -

CSS position of the current component.

-
-

resize

-		 -open var resize: Resize? -

CSS resize of the current component.

-
-

right

-		 -open var right: CssSize? -

Right edge of the current component.

-
-

textAlign

-		 -open var textAlign: TextAlign? -

CSS Text align of the current component.

-
-

textDecoration

-		 -open var textDecoration: TextDecoration? -

CSS Text decoration of the current component.

-
-

textDirection

-		 -open var textDirection: Direction? -

CSS Text direction of the current component.

-
-

textIndent

-		 -open var textIndent: CssSize? -

CSS Text indent of the current component.

-
-

textOverflow

-		 -open var textOverflow: TextOverflow? -

CSS Text overflow of the current component.

-
-

textShadow

-		 -open var textShadow: TextShadow? -

CSS Text shadow of the current component.

-
-

textTransform

-		 -open var textTransform: TextTransform? -

CSS Text transform of the current component.

-
-

top

-		 -open var top: CssSize? -

Top edge of the current component.

-
-

unicodeBidi

-		 -open var unicodeBidi: UnicodeBidi? -

CSS Text unicode-bidi of the current component.

-
-

verticalAlign

-		 -open var verticalAlign: VerticalAlign? -

CSS Text vertical align of the current component.

-
-

whiteSpace

-		 -open var whiteSpace: WhiteSpace? -

CSS Text white space of the current component.

-
-

width

-		 -open var width: CssSize? -

Width of the current component.

-
-

wordBreak

-		 -open var wordBreak: WordBreak? -

CSS word break of the current component.

-
-

wordSpacing

-		 -open var wordSpacing: CssSize? -

CSS Text word spacing of the current component.

-
-

zIndex

-		 -open var zIndex: Int? -

Z-index of the current component.

-
@@ -596,32 +63,12 @@ -

refreshOnUpdate

+(js) +

refreshOnUpdate

-fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T>
-fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T> - - - -

Inherited Functions

- - - - - - - - - +fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>
+fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>
-

getCacheKey

-		 -open fun getCacheKey(): String
-

getSnStyle

-		 -open fun getSnStyle(): List<StringPair> -

Returns the list of String pairs defining CSS style attributes and their values.

-
@@ -630,21 +77,12 @@ -

createInstance

+(js) +

style

-fun <T> Any?.createInstance(vararg args: dynamic): T -

Helper function for creating JavaScript objects from dynamic constructors.

- - - - -

style

- - -fun Style.style(className: String? = null, init: (Style.() -> Unit)? = null): Style

DSL builder extension function for cascading styles.

- +fun Style.style(className: String? = null, init: (Style.() -> Unit)? = null): Style diff --git a/api/pl.treksoft.kvision.core/-style/refresh-on-update.html b/api/pl.treksoft.kvision.core/-style/refresh-on-update.html index 434919d2..ebb5c419 100644 --- a/api/pl.treksoft.kvision.core/-style/refresh-on-update.html +++ b/api/pl.treksoft.kvision.core/-style/refresh-on-update.html @@ -8,9 +8,9 @@ kvision / pl.treksoft.kvision.core / Style / refreshOnUpdate

refreshOnUpdate

- -protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T>
+(js) +protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>
-protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Style.RefreshDelegateProvider<T> +protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T> -- cgit