core/io.nacular.doodle.core

Package-level declarations

Types

A Behavior can be used by Views and Themes to allow delegation of the View.render call and other characteristics of the View. This way, a View can support pluggable visual style and behavior.

Camera

data class Camera(val position: Point, val distance: Double)

Defines the perspective a viewer has if they are assumed to be looking directly at the screen. A camera placed farther from a View will create a stronger perspective projection of that View. This will result in the View looking more 3-dimensional when it is transformed "into" the screen in some way. Whether using the z-axis or because of rotations around the x and/or y-axis.

ChildObserver

typealias ChildObserver<S> = (source: S, diffs: Differences<View>) -> Unit

Observes changes to the children of a parent, S

Container

open class Container : View, PositionableContainer, Iterable<View>

Represents a View that can have children and Layout.

ContainerBuilder

class ContainerBuilder : Container

Class to enable container { ... } DSL.

ContentDirection

enum ContentDirection : Enum<ContentDirection>

Created by Nicholas Eddy on 8/12/20.

Display

interface Display : Iterable<View>

The top-level surface for presenting Views. An item must be added to the Display (either directly, or as a descendant of the Display) before it can be rendered or interact with the user.

Icon

interface Icon<in T : Any>

Represents graphical data associated with an item. An example is the icon used by a button to indicate its function.

Internal

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR])

annotation class Internal

Indicates internal Doodle APIs that should only be accessed from other Doodle libraries.

Layout

interface Layout

Layouts control the positioning of a PositionableContainer's children. They are also responsible for reporting the ideal size for a view given it's contents.

LookupResult

sealed class LookupResult

The result of Layout.child.

Positionable

interface Positionable

Represents an item within a PositionableContainer that a Layout can position.

PositionableContainer

interface PositionableContainer

Represents an item whose children (Positionables) are being manipulated by a Layout.

View

abstract class View(accessibilityRole: AccessibilityRole? = null) : Renderable, Positionable

The smallest unit of displayable, interactive content within doodle. Views are the visual entities used to display components for an application. User input events are sent to all Views that are configured to receive them. This allows them to response to user interaction or convey such events to other parts of an application.

ViewBuilder

class ViewBuilder : View

Class to enable panel { ... } DSL.

Properties

center

val Display.center: Point

The Display's center point in its coordinate system.

val View.center: Point

The View's center point in its parent's coordinate system.

height

val Display.height: Double

The height of the Display

width

val Display.width: Double

The width of the Display

Functions

behavior

fun <T : View, B : Behavior<T>> behavior(beforeChange: (old: B?, new: B?) -> Unit = { _,_ -> }): ReadWriteProperty<T, B?>

Delegate that manages installation and uninstallation of a Behavior and calls beforeChange before applying changes.

fun <T : View, B : Behavior<T>> behavior(beforeChange: (old: B?, new: B?) -> Unit = { _,_ -> }, afterChange: (old: B?, new: B?) -> Unit = { _,_ -> }): ReadWriteProperty<T, B?>

centered