K4 Base Library   K4 Rule Objects
Copyright © 2021 by K4.org
  (v.0.48.124)

UIButtonMixin (d.1.0)

Mixins: UIControlMixin

Provides common 'button' behavior. This is mixed into all buttons.

Index

Rules

Rules

buttonStyle

buttonStyle: String

One of 'primary', 'secondary', 'accent1', 'accent2', 'accent3', 'accent4', 'accent5'.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "primary"

caption

caption: String

The text which appears on the button.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

controlType

controlType: String

Internal Use Only.

Flags : Cached (Note this is uncached)

Expression : "Button"

doUpdate

doUpdate: Boolean

If true, a root update is executed after the button operation takes place.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : true

hotKeys

hotKeys: Array

The keyboard hotkeys for activating the undo button. Single hotkey must be in format '[+<modifier2]+', for example 'Alt+S'. Supported modifiers are 'Ctrl', 'Alt', 'Shift', 'Option' and 'Command'. The key must be upper case.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : []

image

image: Boolean

Indicates that an image should be shown. If true, imageUrl should be supplied.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : false

imageAlignment

imageAlignment: String

One of 'top', 'left' (the default), 'right', or 'bottom', indicating the image position relative to the caption, if any.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : "left"

imageUrl

imageUrl: String

The URL for the image data, if any.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""

tooltip

tooltip: String

The text which appears when the cursor hovers over the button.

Flags : Cached, Parameter, Spec (Note this is uncached)

Expression : ""