Package straightway.odo.api.v0.ui

Types

Button

interface Button : TextHolder

A user interface push button.

CloseAction

enum CloseAction : Enum<CloseAction>

Enumeration of ways to close a window.

ContactChooser

interface ContactChooser

UI element which lets the user choose one of the contacts, which are accessible to the app.

Dialog

interface Dialog<T> : UiElementContainer

A dialog window which is displayed to the user.

FixedString

data class FixedString(currentValue: String) : UiString

A fixed UI string with the given value.

Font

interface Font

A font definition.

Grid

interface Grid : UiElementContainer, UiElement

A grid UI element.

HorizontalAlignment

enum HorizontalAlignment : Enum<HorizontalAlignment>

Horizontal alignments.

ListUi

interface ListUi<T> : UiElement

A list UI displaying a number of items.

SizePolicy

enum SizePolicy : Enum<SizePolicy>

A size policy for UI layout.

Spacer

interface Spacer : UiElement

Use spare space in the UI displaying nothing.

TextHolder

interface TextHolder : UiElement

Base interface for all UI elements having a text as their dominating element (e.g.

TextInput

interface TextInput : UiElement

A UI element accepting a text input from the user.

TextLabel

interface TextLabel : UiElement

A text label within a UI.

interface Ui

User interface API.

UiComponentBase

abstract class UiComponentBase(api: APIv0)

Base class for UI components, with convenience access to the ODO API and the main view.

UiElement

interface UiElement

Base interface for all UI elements.

UiElementContainer

interface UiElementContainer

Base interface for items containing UI elements.

UiString

interface UiString

A string within a user interface.

Functions

horizontalSpace

fun UiElementContainer.Initializer.horizontalSpace(): Spacer

Add a new spacer which dominates the width of the parent ui element.

orientationHorizontal

fun Grid.Initializer.orientationHorizontal(isLeftToRight: Boolean = true)

Set the item step of a grid so that new items are always positioned in the next column (respecting isLeftToRight argument).

orientationVertical

fun Grid.Initializer.orientationVertical(isTopToBottom: Boolean = true)

Set the item step of a grid so that new items are always positioned in the next row (respecting isTopToBottom argument).

verticalSpace

fun UiElementContainer.Initializer.verticalSpace(): Spacer

Add a new spacer which dominates the height of the parent ui element.

Properties

fixedText

var TextHolder.Initializer.fixedText: String

Set a fixed UI text for a text holder.