From a70acf853de62d0754ca95aa4103712b82afdef8 Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Wed, 17 Oct 2018 18:40:15 +0200 Subject: API Documentation for KVision 0.0.18 --- api/index-outline.html | 839 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 637 insertions(+), 202 deletions(-) (limited to 'api/index-outline.html') diff --git a/api/index-outline.html b/api/index-outline.html index bdf5943a..123e2475 100644 --- a/api/index-outline.html +++ b/api/index-outline.html @@ -418,6 +418,7 @@ PRIMARY
SUCCESS
WARNING
+val className: String
@@ -461,8 +462,8 @@ CallAgent()
-fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
-fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
+fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
+fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
@@ -954,7 +955,8 @@ -open class DateTime : SimplePanel, KDateFormControl
+object DateConverter
+interface DateFormControl : FormControl
+object DateSerializer : KSerializer<Date>
+ +open class DateTime : SimplePanel, DateFormControl
+ +class DefaultI18nManager : I18nManager
+ open class Dialog<R> : Modal
+enum class HttpMethod
+ enum class HttpType
-object I18n
+object I18n : I18nManager
+interface I18nManager
+ @@ -1891,6 +1969,20 @@ +object JSON
+ external class Jed
-open actual class JoobyServer
+data class JsonRpcRequest
+ +data class JsonRpcResponse
-interface KDateFormControl : FormControl
+data class KFile
@@ -1945,10 +2059,24 @@ -open fun getValue(): List<KFile>?
+open fun getValue(): List<KFile>?
open fun getValueAsString(): String?
open fun setValue(v: Any?): Unit
-abstract var value: List<KFile>?
+abstract var value: List<KFile>?
+ + + +open expect class KVServer
+ @@ -2280,34 +2408,6 @@ -data actual class Profile
- open class ProgressBar : SimplePanel
-actual interface Request
+expect interface Request
typealias ResString = String
enum class Resize
+enum class RpcHttpMethod
+ enum class Sandbox
-open actual class ServiceManager<out T>
+open expect class ServiceManager<out T>
@@ -2811,6 +2936,21 @@ +class SimpleI18nManager : I18nManager
+ open class SimplePanel : Widget, Container
@@ -3539,7 +3710,9 @@ var dropZoneEnabled: Boolean
var explorerTheme: Boolean
open fun focus(): Unit
-fun getNativeFile(kFile: KFile): File?
+suspend fun <K : Any> Form<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile
+suspend fun <K : Any> FormPanel<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile
+fun getNativeFile(kFile: KFile): File?
protected open fun getSnAttrs(): List<StringPair>
protected open fun getSnClass(): List<StringBoolPair>
fun getValueAsString(): String?
@@ -3562,7 +3735,7 @@ var uploadExtraData: (String, Int) -> dynamic
fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: UploadInput.() -> Unit = null): UploadInput
var uploadUrl: String?
-var value: List<KFile>?
+var value: List<KFile>?
@@ -3638,7 +3811,9 @@ protected open fun afterInsert(node: VNode): Unit
protected open fun afterPostpatch(node: VNode): Unit
open fun clearDragDropData(): Unit
+protected open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
var draggable: Boolean?
+var eventTarget: Widget?
open fun getElement(): Node?
open fun getElementJQuery(): JQuery?
open fun getElementJQueryD(): dynamic
@@ -3665,6 +3840,7 @@ open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget
open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget
open fun show(): Widget
+protected var surroundingSpan: Boolean
var title: String?
open fun toggleVisible(): Widget
protected fun translate(text: String): String
@@ -3733,6 +3909,19 @@ +java.util.Date
+ kotlin.Int
-kotlin.String
+kotlin.String
@@ -3799,7 +3988,7 @@ -kotlin.js.Date
+kotlin.js.Date
@@ -4388,6 +4577,35 @@ StyledComponent()
+protected inner class RefreshDelegate<T>
+ +protected inner class RefreshDelegateProvider<T>
+ open var background: Background?
open var border: Border?
open var borderBottom: Border?
@@ -4428,6 +4646,8 @@ open var paddingRight: CssSize?
open var paddingTop: CssSize?
open var position: Position?
+protected fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>
+protected fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): RefreshDelegateProvider<T>
open var resize: Resize?
open var right: CssSize?
open var textAlign: TextAlign?
@@ -4670,7 +4890,9 @@ protected open fun afterInsert(node: VNode): Unit
protected open fun afterPostpatch(node: VNode): Unit
open fun clearDragDropData(): Unit
+protected open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?
var draggable: Boolean?
+var eventTarget: Widget?
open fun getElement(): Node?
open fun getElementJQuery(): JQuery?
open fun getElementJQueryD(): dynamic
@@ -4697,6 +4919,7 @@ open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget
open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget
open fun show(): Widget
+protected var surroundingSpan: Boolean
var title: String?
open fun toggleVisible(): Widget
protected fun translate(text: String): String
@@ -4841,6 +5064,7 @@ open fun addAll(children: List<Component>): SimplePanel
protected open fun afterInsert(node: VNode): Unit
var block: Boolean
+fun buttonId(): String?
var disabled: Boolean
fun Container.dropDown(text: String, elements: List<StringPair>? = null, icon: String? = null, style: ButtonStyle = ButtonStyle.DEFAULT, disabled: Boolean = false, forNavbar: Boolean = false, withCaret: Boolean = true, classes: Set<String> = setOf(), init: DropDown.() -> Unit = null): DropDown
var dropup: Boolean
@@ -4918,6 +5142,22 @@ +interface DateFormControl : FormControl
+ open class FieldLabel : Tag
-interface KDateFormControl : FormControl
- interface KFilesFormControl : FormControl
@@ -5955,7 +6177,7 @@ -open class DateTime : SimplePanel, KDateFormControl
+open class DateTime : SimplePanel, DateFormControl
@@ -6122,7 +6344,9 @@ var dropZoneEnabled: Boolean
var explorerTheme: Boolean
open fun focus(): Unit
-fun getNativeFile(kFile: KFile): File?
+suspend fun <K : Any> Form<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile
+suspend fun <K : Any> FormPanel<K>.getContent(key: KProperty1<K, List<KFile>?>, kFile: KFile): KFile
+fun getNativeFile(kFile: KFile): File?
protected open fun getSnAttrs(): List<StringPair>
protected open fun getSnClass(): List<StringBoolPair>
fun getValueAsString(): String?
@@ -6145,7 +6369,7 @@ var uploadExtraData: (String, Int) -> dynamic
fun Container.uploadInput(uploadUrl: String? = null, multiple: Boolean = false, classes: Set<String> = setOf(), init: UploadInput.() -> Unit = null): UploadInput
var uploadUrl: String?
-var value: List<KFile>?
+var value: List<KFile>?
@@ -6293,6 +6517,7 @@ PRIMARY
SUCCESS
WARNING
+val className: String
@@ -6621,7 +6846,22 @@ -object I18n
+class DefaultI18nManager : I18nManager
+ +object I18n : I18nManager
+interface I18nManager
+ @@ -6657,6 +6911,21 @@ +class SimpleI18nManager : I18nManager
+ @@ -7355,11 +7624,14 @@ 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)
+var align: Align?
var animated: Boolean
+var content: String?
var max: Int
var min: Int
var progress: Int
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
+var rich: Boolean
var striped: Boolean
var style: ProgressBarStyle?
@@ -7403,8 +7675,8 @@ CallAgent()
-fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
-fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
+fun jsonRpcCall(url: String, data: List<String?> = listOf(), method: RpcHttpMethod = RpcHttpMethod.POST): Promise<String>
+fun remoteCall(url: String, data: dynamic = null, method: HttpMethod = HttpMethod.GET, contentType: String = "application/json", beforeSend: (JQueryXHR, JQueryAjaxSettings) -> Boolean = null): Promise<dynamic>
@@ -7424,7 +7696,42 @@ const val HTTP_UNAUTHORIZED: Int
-open actual class JoobyServer
+enum class HttpMethod
+ +data class JsonRpcRequest
+ +data class JsonRpcResponse
+open expect class KVServer
+ @@ -7452,7 +7777,16 @@ -data actual class Profile
+Profile
+ @@ -7490,24 +7828,40 @@ RemoteAgent(serviceManager: ServiceManager<T>)
-inline fun <reified RET : Any, T> call(noinline function: T.(Request?) -> Deferred<RET>): Deferred<RET>
-inline fun <reified RET : Any, T> call(noinline function: T.(Request?) -> Deferred<List<RET>>): Deferred<List<RET>>
-inline fun <reified PAR, reified RET : Any, T> call(noinline function: T.(PAR, Request?) -> Deferred<RET>, p: PAR, serializer: KSerializer<PAR>? = null): Deferred<RET>
-inline fun <reified PAR, reified RET : Any, T> call(noinline function: T.(PAR, Request?) -> Deferred<List<RET>>, p: PAR, serializer: KSerializer<PAR>? = null): Deferred<List<RET>>
-inline fun <reified PAR1, reified PAR2, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null): Deferred<RET>
-inline fun <reified PAR1, reified PAR2, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null): Deferred<List<RET>>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null): Deferred<RET>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null): Deferred<List<RET>>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null, serializer4: KSerializer<PAR4>? = null): Deferred<RET>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null, serializer4: KSerializer<PAR4>? = null): Deferred<List<RET>>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, p5: PAR5, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null, serializer4: KSerializer<PAR4>? = null, serializer5: KSerializer<PAR5>? = null): Deferred<RET>
-inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, p5: PAR5, serializer1: KSerializer<PAR1>? = null, serializer2: KSerializer<PAR2>? = null, serializer3: KSerializer<PAR3>? = null, serializer4: KSerializer<PAR4>? = null, serializer5: KSerializer<PAR5>? = null): Deferred<List<RET>>
+inline fun <reified RET : Any, T> call(noinline function: T.(Request?) -> Deferred<RET>): Deferred<RET>
+inline fun <reified RET : Any, T> call(noinline function: T.(Request?) -> Deferred<List<RET>>): Deferred<List<RET>>
+inline fun <reified PAR, reified RET : Any, T> call(noinline function: T.(PAR, Request?) -> Deferred<RET>, p: PAR): Deferred<RET>
+inline fun <reified PAR, reified RET : Any, T> call(noinline function: T.(PAR, Request?) -> Deferred<List<RET>>, p: PAR): Deferred<List<RET>>
+inline fun <reified PAR1, reified PAR2, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2): Deferred<RET>
+inline fun <reified PAR1, reified PAR2, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2): Deferred<List<RET>>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3): Deferred<RET>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3): Deferred<List<RET>>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4): Deferred<RET>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4): Deferred<List<RET>>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<RET>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, p5: PAR5): Deferred<RET>
+inline fun <reified PAR1, reified PAR2, reified PAR3, reified PAR4, reified PAR5, reified RET : Any, T> call(noinline function: T.(PAR1, PAR2, PAR3, PAR4, PAR5, Request?) -> Deferred<List<RET>>, p1: PAR1, p2: PAR2, p3: PAR3, p4: PAR4, p5: PAR5): Deferred<List<RET>>
val callAgent: CallAgent
val serviceManager: ServiceManager<T>
-actual interface Request
+expect interface Request
+enum class RpcHttpMethod
+ class SecurityException : Exception
-open actual class ServiceManager<out T>
+open expect class ServiceManager<out T>
+fun <RESP> Request?.async(block: (Request) -> RESP): Deferred<RESP>
+fun <RESP> Request?.async(block: (Request, <ERROR CLASS>) -> RESP): Deferred<RESP>
+fun <RESP> Request?.async(block: (Request, <ERROR CLASS>, Profile) -> RESP): Deferred<RESP>
@@ -7772,8 +8135,92 @@ -actual val KDATE_FORMAT: String
-fun KDate.toJS(): Date
+Date
+ +object DateConverter
+object DateSerializer : KSerializer<Date>
+ +data class KFile
+ +java.util.Date
+ +kotlin.String
+ +kotlin.js.Date
+ +val kvTableConfig: <ERROR CLASS>
@@ -7788,6 +8235,20 @@ const val ENTER_KEY: Int
const val ESC_KEY: Int
+object JSON
+ class KvEvent : CustomEvent
-kotlin.String
- -kotlin.js.Date
- val normal: CssSize
fun obj(init: dynamic.() -> Unit): dynamic
org.w3c.files.File
-- cgit