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 --- .../-context-menu/-init-.html | 19 -- .../-context-menu/context-menu.html | 16 -- .../-context-menu/index.html | 118 ---------- .../-context-menu/position-menu.html | 20 -- .../-d-d/-d-i-s-a-b-l-e-d.html | 26 --- .../-d-d/-h-e-a-d-e-r.html | 26 --- .../-d-d/-s-e-p-a-r-a-t-o-r.html | 26 --- api/pl.treksoft.kvision.dropdown/-d-d/index.html | 52 ----- api/pl.treksoft.kvision.dropdown/-d-d/option.html | 14 -- .../-drop-down/-init-.html | 33 --- .../-drop-down/add-all.html | 21 -- .../-drop-down/add.html | 21 -- .../-drop-down/after-insert.html | 16 -- .../-drop-down/block.html | 15 -- .../-drop-down/button-id.html | 14 -- .../-drop-down/disabled.html | 15 -- .../-drop-down/drop-down.html | 16 -- .../-drop-down/dropup.html | 21 -- .../-drop-down/for-navbar.html | 15 -- .../-drop-down/get-children.html | 18 -- .../-drop-down/get-sn-class.html | 18 -- .../-drop-down/icon.html | 15 -- .../-drop-down/image.html | 15 -- .../-drop-down/index.html | 251 --------------------- .../-drop-down/remove-all.html | 18 -- .../-drop-down/remove.html | 21 -- .../-drop-down/render.html | 18 -- .../-drop-down/size.html | 15 -- .../-drop-down/style.html | 15 -- .../-drop-down/text.html | 15 -- .../-drop-down/toggle.html | 15 -- .../-drop-down/width.html | 16 -- .../-header/-init-.html | 21 -- .../-header/header.html | 18 -- .../-header/index.html | 123 ---------- .../-separator/-init-.html | 19 -- .../-separator/index.html | 123 ---------- .../-separator/separator.html | 18 -- api/pl.treksoft.kvision.dropdown/index.html | 63 ------ 39 files changed, 1339 deletions(-) delete mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/index.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-d-d/index.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-d-d/option.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/add.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/block.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/icon.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/image.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/index.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/remove-all.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/remove.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/render.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/size.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/style.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/text.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/toggle.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-drop-down/width.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-header/-init-.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-header/header.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-header/index.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-separator/-init-.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-separator/index.html delete mode 100644 api/pl.treksoft.kvision.dropdown/-separator/separator.html delete mode 100644 api/pl.treksoft.kvision.dropdown/index.html (limited to 'api/pl.treksoft.kvision.dropdown') diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html b/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html deleted file mode 100644 index 7a456e63..00000000 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/-init-.html +++ /dev/null @@ -1,19 +0,0 @@ - - - -ContextMenu.<init> - kvision - - - -kvision / pl.treksoft.kvision.dropdown / ContextMenu / <init>
-
-

<init>

- -ContextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null) -

Parameters

-

-classes - a set of CSS class names

-

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html b/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html deleted file mode 100644 index 8b896973..00000000 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/context-menu.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -ContextMenu.contextMenu - kvision - - - -kvision / pl.treksoft.kvision.dropdown / ContextMenu / contextMenu
-
-

contextMenu

- -fun Widget.contextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null): ContextMenu -

DSL builder extension function.

-

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

- - diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/index.html b/api/pl.treksoft.kvision.dropdown/-context-menu/index.html deleted file mode 100644 index 2c9823f1..00000000 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/index.html +++ /dev/null @@ -1,118 +0,0 @@ - - - -ContextMenu - kvision - - - -kvision / pl.treksoft.kvision.dropdown / ContextMenu
-
-

ContextMenu

-open class ContextMenu : ListTag -

Context menu component.

-

Constructors

- - - - - - - -
-

<init>

-		 -ContextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null)
-

Inherited Properties

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

elements

-		 -var elements: List<String>? -

List of elements.

-
-

rich

-		 -var rich: Boolean -

Determines if elements can contain HTML code.

-
-

type

-		 -var type: ListType -

List type.

-
-

Functions

- - - - - - - -
-

positionMenu

-		 -open fun positionMenu(mouseEvent: MouseEvent): ContextMenu -

Positions and shows a context menu based on a mouse event.

-
-

Inherited Functions

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

childrenVNodes

-		 -open fun childrenVNodes(): Array<VNode> -

Returns the array of the children Snabbdom vnodes.

-
-

getSnClass

-		 -open fun getSnClass(): List<StringBoolPair> -

Returns list of CSS class names for current widget in the form of a List.

-
-

render

-		 -open fun render(): VNode -

Renders current component as a Snabbdom vnode.

-
-

Companion Object Functions

- - - - - - - -
-

contextMenu

-		 -fun Widget.contextMenu(classes: Set<String> = setOf(), init: ContextMenu.() -> Unit = null): ContextMenu -

DSL builder extension function.

-
- - diff --git a/api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html b/api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html deleted file mode 100644 index ded70c2c..00000000 --- a/api/pl.treksoft.kvision.dropdown/-context-menu/position-menu.html +++ /dev/null @@ -1,20 +0,0 @@ - - - -ContextMenu.positionMenu - kvision - - - -kvision / pl.treksoft.kvision.dropdown / ContextMenu / positionMenu
-
-

positionMenu

- -open fun positionMenu(mouseEvent: MouseEvent): ContextMenu -

Positions and shows a context menu based on a mouse event.

-

Parameters

-

-mouseEvent - mouse event

-

Return
-current context menu

- - diff --git a/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html b/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html deleted file mode 100644 index c5172948..00000000 --- a/api/pl.treksoft.kvision.dropdown/-d-d/-d-i-s-a-b-l-e-d.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -DD.DISABLED - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DD / DISABLED
-
-

DISABLED

- -DISABLED -

Inherited Properties

- - - - - - - -
-

option

-		 -val option: String
- - diff --git a/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html b/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html deleted file mode 100644 index c0521931..00000000 --- a/api/pl.treksoft.kvision.dropdown/-d-d/-h-e-a-d-e-r.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -DD.HEADER - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DD / HEADER
-
-

HEADER

- -HEADER -

Inherited Properties

- - - - - - - -
-

option

-		 -val option: String
- - diff --git a/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html b/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html deleted file mode 100644 index d518de3c..00000000 --- a/api/pl.treksoft.kvision.dropdown/-d-d/-s-e-p-a-r-a-t-o-r.html +++ /dev/null @@ -1,26 +0,0 @@ - - - -DD.SEPARATOR - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DD / SEPARATOR
-
-

SEPARATOR

- -SEPARATOR -

Inherited Properties

- - - - - - - -
-

option

-		 -val option: String
- - diff --git a/api/pl.treksoft.kvision.dropdown/-d-d/index.html b/api/pl.treksoft.kvision.dropdown/-d-d/index.html deleted file mode 100644 index 544e8952..00000000 --- a/api/pl.treksoft.kvision.dropdown/-d-d/index.html +++ /dev/null @@ -1,52 +0,0 @@ - - - -DD - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DD
-
-

DD

-enum class DD -

Useful options for use in DropDown's elements parameter.

-

Enum Values

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

HEADER

-		 -
-

DISABLED

-		 -
-

SEPARATOR

-		 -
-

Properties

- - - - - - - -
-

option

-		 -val option: String
- - diff --git a/api/pl.treksoft.kvision.dropdown/-d-d/option.html b/api/pl.treksoft.kvision.dropdown/-d-d/option.html deleted file mode 100644 index 518c5aed..00000000 --- a/api/pl.treksoft.kvision.dropdown/-d-d/option.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -DD.option - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DD / option
-
-

option

- -val option: String - - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html b/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html deleted file mode 100644 index 67e3cdef..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/-init-.html +++ /dev/null @@ -1,33 +0,0 @@ - - - -DropDown.<init> - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / <init>
-
-

<init>

- -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()) -

Parameters

-

-text - the label of the dropdown button

-

-elements - an optional list of link elements (special options from DD enum class can be used as values)

-

-icon - the icon of the dropdown button

-

-style - the style of the dropdown button

-

-disabled - determines if the component is disabled on start

-

-forNavbar - determines if the component will be used in a navbar

-

-withCaret - determines if the dropdown button renders caret

-

-classes - a set of CSS class names

-

Constructor
-

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html deleted file mode 100644 index 464a2fea..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/add-all.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -DropDown.addAll - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / addAll
-
-

addAll

- -open fun addAll(children: List<Component>): SimplePanel -

Overrides SimplePanel.addAll

-

Adds a list of components to the current container.

-

Parameters

-

-children - list of child components

-

Return
-current container

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/add.html b/api/pl.treksoft.kvision.dropdown/-drop-down/add.html deleted file mode 100644 index 85081d14..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/add.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -DropDown.add - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / add
-
-

add

- -open fun add(child: Component): SimplePanel -

Overrides SimplePanel.add

-

Adds given component to the current container.

-

Parameters

-

-child - child component

-

Return
-current container

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html b/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html deleted file mode 100644 index 1b4bb89d..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/after-insert.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DropDown.afterInsert - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / afterInsert
-
-

afterInsert

- -protected open fun afterInsert(node: VNode): Unit -

Overrides Widget.afterInsert

-

Method called after inserting Snabbdom vnode into the DOM.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/block.html b/api/pl.treksoft.kvision.dropdown/-drop-down/block.html deleted file mode 100644 index 446d4803..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/block.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DropDown.block - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / block
-
-

block

- -var block: Boolean -

Determines if the dropdown button takes all the space horizontally.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html b/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html deleted file mode 100644 index abac1ea0..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/button-id.html +++ /dev/null @@ -1,14 +0,0 @@ - - - -DropDown.buttonId - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / buttonId
-
-

buttonId

- -fun buttonId(): String? - - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html b/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html deleted file mode 100644 index 9c25d116..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/disabled.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DropDown.disabled - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / disabled
-
-

disabled

- -var disabled: Boolean -

Determines if the dropdown is disabled.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html b/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html deleted file mode 100644 index 0c1af12f..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/drop-down.html +++ /dev/null @@ -1,16 +0,0 @@ - - - -DropDown.dropDown - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / dropDown
-
-

dropDown

- -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 -

DSL builder extension function.

-

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

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html b/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html deleted file mode 100644 index 40a56d7b..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/dropup.html +++ /dev/null @@ -1,21 +0,0 @@ - - - -DropDown.dropup - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / dropup
-
-

dropup

- -var dropup: Boolean -

Determines if the dropdown is showing upwards.

-

Getter
-

Determines if the dropdown is showing upwards.

-

-

Setter
-

Determines if the dropdown is showing upwards.

-

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html b/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html deleted file mode 100644 index 33497640..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/for-navbar.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DropDown.forNavbar - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / forNavbar
-
-

forNavbar

- -val forNavbar: Boolean -

determines if the component will be used in a navbar

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html deleted file mode 100644 index 749b4086..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/get-children.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -DropDown.getChildren - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / getChildren
-
-

getChildren

- -open fun getChildren(): List<Component> -

Overrides SimplePanel.getChildren

-

Returns a list of children of the current container.

-

Return
-list of children

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html b/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html deleted file mode 100644 index c9d8031d..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/get-sn-class.html +++ /dev/null @@ -1,18 +0,0 @@ - - - -DropDown.getSnClass - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / getSnClass
-
-

getSnClass

- -protected open fun getSnClass(): List<StringBoolPair> -

Overrides Widget.getSnClass

-

Returns list of CSS class names for current widget in the form of a List.

-

Return
-list of CSS class names

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html b/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html deleted file mode 100644 index 33c4950b..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/icon.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DropDown.icon - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / icon
-
-

icon

- -var icon: String? -

The icon of the dropdown button.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/image.html b/api/pl.treksoft.kvision.dropdown/-drop-down/image.html deleted file mode 100644 index 56755e67..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/image.html +++ /dev/null @@ -1,15 +0,0 @@ - - - -DropDown.image - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown / image
-
-

image

- -var image: ResString? -

The image on the dropdown button.

- - diff --git a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html b/api/pl.treksoft.kvision.dropdown/-drop-down/index.html deleted file mode 100644 index a15ebb28..00000000 --- a/api/pl.treksoft.kvision.dropdown/-drop-down/index.html +++ /dev/null @@ -1,251 +0,0 @@ - - - -DropDown - kvision - - - -kvision / pl.treksoft.kvision.dropdown / DropDown
-
-

DropDown

-open class DropDown : SimplePanel -

Bootstrap dropdown component.

-

Constructors

- - - - - - - -
-

<init>

-		 -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())
-

Properties

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

block

-		 -var block: Boolean -

Determines if the dropdown button takes all the space horizontally.

-
-

disabled

-		 -var disabled: Boolean -

Determines if the dropdown is disabled.

-
-

dropup

-		 -var dropup: Boolean -

Determines if the dropdown is showing upwards.

-
-

forNavbar

-		 -val forNavbar: Boolean -

determines if the component will be used in a navbar

-
-

icon

-