From fb7ff5b8bf2073a8d7b78011b9edffc830dc63cb Mon Sep 17 00:00:00 2001 From: Robert Jaros Date: Sat, 26 Oct 2019 00:17:24 +0200 Subject: API documentation for KVision 2.0.0 --- api1/pl.treksoft.kvision.html/-iframe/-init-.html | 31 ++ .../-iframe/get-iframe-window.html | 17 + .../-iframe/get-sn-attrs.html | 18 + .../-iframe/iframe-height.html | 21 + .../-iframe/iframe-width.html | 21 + api1/pl.treksoft.kvision.html/-iframe/iframe.html | 16 + api1/pl.treksoft.kvision.html/-iframe/index.html | 616 +++++++++++++++++++++ .../pl.treksoft.kvision.html/-iframe/location.html | 15 + api1/pl.treksoft.kvision.html/-iframe/name.html | 21 + api1/pl.treksoft.kvision.html/-iframe/render.html | 18 + api1/pl.treksoft.kvision.html/-iframe/sandbox.html | 21 + api1/pl.treksoft.kvision.html/-iframe/src.html | 21 + api1/pl.treksoft.kvision.html/-iframe/srcdoc.html | 21 + 13 files changed, 857 insertions(+) create mode 100644 api1/pl.treksoft.kvision.html/-iframe/-init-.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/get-iframe-window.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/iframe-height.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/iframe-width.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/iframe.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/index.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/location.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/name.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/render.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/sandbox.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/src.html create mode 100644 api1/pl.treksoft.kvision.html/-iframe/srcdoc.html (limited to 'api1/pl.treksoft.kvision.html/-iframe') diff --git a/api1/pl.treksoft.kvision.html/-iframe/-init-.html b/api1/pl.treksoft.kvision.html/-iframe/-init-.html new file mode 100644 index 00000000..3823d817 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/-init-.html @@ -0,0 +1,31 @@ + + + +Iframe.<init> - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / <init>
+
+

<init>

+ +

Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Parameters

+src - the iframe document address

+srcdoc - the HTML content of the iframe

+name - the name of the iframe

+iframeWidth - the width of the iframe

+iframeHeight - the height of the iframe

+sandbox - a set of Sandbox options

+classes - a set of CSS class names

Constructor
+

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/get-iframe-window.html b/api1/pl.treksoft.kvision.html/-iframe/get-iframe-window.html new file mode 100644 index 00000000..41620da2 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/get-iframe-window.html @@ -0,0 +1,17 @@ + + + +Iframe.getIframeWindow - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / getIframeWindow
+
+

getIframeWindow

+ +open fun getIframeWindow(): Window +

Returns content window object of the iframe.

Return
+content window object

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html b/api1/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html new file mode 100644 index 00000000..069b02a2 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/get-sn-attrs.html @@ -0,0 +1,18 @@ + + + +Iframe.getSnAttrs - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / getSnAttrs
+
+

getSnAttrs

+ +protected open fun getSnAttrs(): List<StringPair> +

Overrides Widget.getSnAttrs

Returns list of element attributes in the form of a List.

Return
+list of element attributes

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/iframe-height.html b/api1/pl.treksoft.kvision.html/-iframe/iframe-height.html new file mode 100644 index 00000000..a3f72945 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/iframe-height.html @@ -0,0 +1,21 @@ + + + +Iframe.iframeHeight - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / iframeHeight
+
+

iframeHeight

+ +var iframeHeight: Int? +

The height of the iframe.

Getter
+

The height of the iframe.

Setter
+

The height of the iframe.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/iframe-width.html b/api1/pl.treksoft.kvision.html/-iframe/iframe-width.html new file mode 100644 index 00000000..046d9634 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/iframe-width.html @@ -0,0 +1,21 @@ + + + +Iframe.iframeWidth - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / iframeWidth
+
+

iframeWidth

+ +var iframeWidth: Int? +

The width of the iframe.

Getter
+

The width of the iframe.

Setter
+

The width of the iframe.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/iframe.html b/api1/pl.treksoft.kvision.html/-iframe/iframe.html new file mode 100644 index 00000000..80df42e3 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/iframe.html @@ -0,0 +1,16 @@ + + + +Iframe.iframe - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / iframe
+
+

iframe

+ +

fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: (Iframe.() -> Unit)? = null): Iframe

DSL builder extension function.

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

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/index.html b/api1/pl.treksoft.kvision.html/-iframe/index.html new file mode 100644 index 00000000..90f518dc --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/index.html @@ -0,0 +1,616 @@ + + + +Iframe - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe
+
+

Iframe

+open class Iframe : Widget +

Iframe component.

Constructors

+ + + + + + + +

<init>

Iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf())

Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ iframeHeight +	+`var iframeHeight: Int?` + The height of the iframe. +
+ iframeWidth +	+`var iframeWidth: Int?` + The width of the iframe. +
+ location +	+`var location: String?` + A current location URL of the iframe. +
+ name +	+`var name: String?` + The name of the iframe. +
+ sandbox +	+`var sandbox: Set<Sandbox>?` + A set of Sandbox options. +
+ src +	+`var src: String?` + The iframe document address. +
+ srcdoc +	+`var srcdoc: String?` + The HTML content of the iframe. +

Inherited Properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ draggable +	+`var draggable: Boolean?` + Determines if the current widget is draggable. +
+ eventTarget +	+`var eventTarget: Widget?`
+ id +	+`var id: String?` + An ID attribute of generated HTML element. +
+ lastLanguage +	+`var lastLanguage: String?`
+ parent +	+`open var parent: Container?` + Parent of the current component. +
+ popoverOptions +	+`var popoverOptions: PopoverOptions?`
+ role +	+`var role: String?` + A role attribute of generated HTML element. +
+ surroundingSpan +	+`var surroundingSpan: Boolean`
+ title +	+`var title: String?` + A title attribute of generated HTML element. +
+ tooltipOptions +	+`var tooltipOptions: TooltipOptions?`
+ visible +	+`open var visible: Boolean` + Visibility state of the current component. +
+ vnode +	+`var vnode: VNode?`

Functions

+ + + + + + + + + + + + + + + +

+ getIframeWindow +	+`open fun getIframeWindow(): Window` + Returns content window object of the iframe. +
+ getSnAttrs +	+`open fun getSnAttrs(): List<StringPair>` + Returns list of element attributes in the form of a List. +
+ render +	+`open fun render(): VNode` + Renders current component as a Snabbdom vnode. +

Inherited Functions

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ addCssClass +	+`open fun addCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of current component. +`open fun addCssClass(css: Style): Widget` + Adds given style object to the set of CSS classes generated in html code of current component. +
+ addSurroundingCssClass +	+`open fun addSurroundingCssClass(css: String): Widget` + Adds given value to the set of CSS classes generated in html code of parent component. +`open fun addSurroundingCssClass(css: Style): Widget` + Adds given style object to the set of CSS classes generated in html code of parent component. +
+ afterCreate +	+`open fun afterCreate(node: VNode): Unit` + Method called after creating Snabbdom vnode. +
+ afterDestroy +	+`open fun afterDestroy(): Unit` + Method called after destroying Snabbdom vnode. +
+ afterInsert +	+`open fun afterInsert(node: VNode): Unit` + Method called after inserting Snabbdom vnode into the DOM. +
+ clearDragDropData +	+`open fun clearDragDropData(): Unit` + Clears D&D data for the current widget. It also makes it not draggable. +
+ disablePopover +	+`open fun disablePopover(): Widget` + Disables popover for the current widget. +
+ disableTooltip +	+`open fun disableTooltip(): Widget` + Disables tooltip for the current widget. +
+ dispatchEvent +	+`open fun dispatchEvent(type: String, eventInitDict: CustomEventInit): Boolean?`
+ enablePopover +	+`open fun enablePopover(options: PopoverOptions = PopoverOptions()): Widget` + Enables popover for the current widget. +
+ enableTooltip +	+`open fun enableTooltip(options: TooltipOptions = TooltipOptions()): Widget` + Enables tooltip for the current widget. +
+ getAttribute +	+`open fun getAttribute(name: String): String?` + Returns the value of an additional attribute. +
+ getElement +	+`open fun getElement(): Node?` + Returns DOM element bound to the current component. +
+ getElementJQuery +	+`open fun getElementJQuery(): JQuery?` + Returns JQuery element bound to the current component. +
+ getElementJQueryD +	+`open fun getElementJQueryD(): dynamic` + Returns JQuery element bound to the current component as a dynamic type. +
+ getSnClass +	+`open fun getSnClass(): List<StringBoolPair>` + Returns list of CSS class names for current widget in the form of a List. +
+ getSnHooks +	+`open fun getSnHooks(): Hooks?` + Returns list of hooks in the form of a Snabbdom Hooks object. +
+ getSnOn +	+`open fun getSnOn(): On?` + Returns list of event handlers in the form of a Snabbdom On object. +
+ hide +	+`open fun hide(): Widget` + Makes current widget invisible. +
+ hidePopover +	+`open fun hidePopover(): Widget` + Hides popover for the current widget. +
+ hideTooltip +	+`open fun hideTooltip(): Widget` + Hides tooltip for the current widget. +
+ refreshOnUpdate +	+`fun <T> refreshOnUpdate(refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>` +`fun <T> refreshOnUpdate(initialValue: T, refreshFunction: (T) -> Unit = { this.refresh() }): Widget.RefreshDelegateProvider<T>`
+ removeAttribute +	+`open fun removeAttribute(name: String): Widget` + Removes the value of additional attribute. +
+ removeCssClass +	+`open fun removeCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of current component. +`open fun removeCssClass(css: Style): Widget` + Removes given style object from the set of CSS classes generated in html code of current component. +
+ removeEventListeners +	+`open fun removeEventListeners(): Widget` + Removes all event listeners from current widget. +
+ removeSurroundingCssClass +	+`open fun removeSurroundingCssClass(css: String): Widget` + Removes given value from the set of CSS classes generated in html code of parent component. +`open fun removeSurroundingCssClass(css: Style): Widget` + Removes given style object from the set of CSS classes generated in html code of parent component. +
+ render +	+`open fun render(elementName: String): VNode` +`open fun render(elementName: String, children: Array<dynamic>): VNode` + Renders current component as a Snabbdom vnode. +
+ setAttribute +	+`open fun setAttribute(name: String, value: String): Widget` + Sets the value of additional attribute. +
+ setContextMenu +	+`open fun setContextMenu(contextMenu: ContextMenu): Widget` + Sets context menu for the current widget. +
+ setDragDropData +	+`open fun setDragDropData(format: String, data: String): Unit` + Sets D&D data for the current widget. It also makes it draggable. +
+ setDropTarget +	+`open fun setDropTarget(format: String, callback: (DragEvent) -> Unit): Unit` +`open fun setDropTarget(formats: Set<String>? = null, callback: (DragEvent) -> Unit): Unit` + Sets the current widget as a D&D drop target. +
+ setDropTargetData +	+`open fun setDropTargetData(format: String, callback: (String?) -> Unit): Unit` + Sets the current widget as a D&D drop target with helper callback accepting String data. +
+ setEventListener +	+`open fun <T : Widget> setEventListener(block: SnOn<T>.() -> Unit): Widget` + Sets an event listener for current widget, keeping the actual type of component. +`open fun setEventListener(block: SnOn<Widget>.() -> Unit): Widget` + Sets an event listener for current widget. +
+ show +	+`open fun show(): Widget` + Makes current widget visible. +
+ showPopover +	+`open fun showPopover(): Widget` + Shows popover for the current widget. +
+ showTooltip +	+`open fun showTooltip(): Widget` + Shows tooltip for the current widget. +
+ singleRender +	+`fun <T> singleRender(block: () -> T): T`
+ toggleVisible +	+`open fun toggleVisible(): Widget` + Toggles visibility of current widget. +
+ translate +	+`fun translate(text: String?): String?`

Companion Object Functions

+ + + + + + + +

iframe

fun Container.iframe(src: String? = null, srcdoc: String? = null, name: String? = null, iframeWidth: Int? = null, iframeHeight: Int? = null, sandbox: Set<Sandbox>? = null, classes: Set<String> = setOf(), init: (Iframe.() -> Unit)? = null): Iframe

DSL builder extension function.

Extension Functions

+ + + + + + + +

createInstance

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

Helper function for creating JavaScript objects from dynamic constructors.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/location.html b/api1/pl.treksoft.kvision.html/-iframe/location.html new file mode 100644 index 00000000..55b5a55b --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/location.html @@ -0,0 +1,15 @@ + + + +Iframe.location - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / location
+
+

location

+ +var location: String? +

A current location URL of the iframe.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/name.html b/api1/pl.treksoft.kvision.html/-iframe/name.html new file mode 100644 index 00000000..94ee6d36 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/name.html @@ -0,0 +1,21 @@ + + + +Iframe.name - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / name
+
+

name

+ +var name: String? +

The name of the iframe.

Getter
+

The name of the iframe.

Setter
+

The name of the iframe.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/render.html b/api1/pl.treksoft.kvision.html/-iframe/render.html new file mode 100644 index 00000000..0228603e --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/render.html @@ -0,0 +1,18 @@ + + + +Iframe.render - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / render
+
+

render

+ +protected open fun render(): VNode +

Overrides Widget.render

Renders current component as a Snabbdom vnode.

Return
+Snabbdom vnode

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/sandbox.html b/api1/pl.treksoft.kvision.html/-iframe/sandbox.html new file mode 100644 index 00000000..2072d0cd --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/sandbox.html @@ -0,0 +1,21 @@ + + + +Iframe.sandbox - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / sandbox
+
+

sandbox

+ +var sandbox: Set<Sandbox>? +

A set of Sandbox options.

Getter
+

A set of Sandbox options.

Setter
+

A set of Sandbox options.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/src.html b/api1/pl.treksoft.kvision.html/-iframe/src.html new file mode 100644 index 00000000..a55ef1b9 --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/src.html @@ -0,0 +1,21 @@ + + + +Iframe.src - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / src
+
+

src

+ +var src: String? +

The iframe document address.

Getter
+

The iframe document address.

Setter
+

The iframe document address.

+ + diff --git a/api1/pl.treksoft.kvision.html/-iframe/srcdoc.html b/api1/pl.treksoft.kvision.html/-iframe/srcdoc.html new file mode 100644 index 00000000..a762a02a --- /dev/null +++ b/api1/pl.treksoft.kvision.html/-iframe/srcdoc.html @@ -0,0 +1,21 @@ + + + +Iframe.srcdoc - kvision + + + +kvision / pl.treksoft.kvision.html / Iframe / srcdoc
+
+

srcdoc

+ +var srcdoc: String? +

The HTML content of the iframe.

Getter
+

The HTML content of the iframe.

Setter
+

The HTML content of the iframe.

+ + -- cgit