RemoteIconToggleButtonShapes

class RemoteIconToggleButtonShapes


Represents the shapes used for RemoteIconToggleButton in the checked and unchecked states, and while pressed.

When the checked state of RemoteIconToggleButton is not a constant, a change of shape between uncheckedShape and checkedShape is only supported when both are RemoteRoundedCornerShapes; otherwise uncheckedShape is used.

When the pressed shapes differ from the resting shapes, RemoteIconToggleButton animates to uncheckedPressedShape or checkedPressedShape while it is pressed. The press animation requires all the shapes to be RemoteRoundedCornerShapes and the toggle button to be enabled with a constant value.

Summary

Public constructors

RemoteIconToggleButtonShapes(
    uncheckedShape: RemoteShape,
    checkedShape: RemoteShape,
    uncheckedPressedShape: RemoteShape,
    checkedPressedShape: RemoteShape
)

Public functions

RemoteIconToggleButtonShapes
copy(
    uncheckedShape: RemoteShape,
    checkedShape: RemoteShape,
    uncheckedPressedShape: RemoteShape,
    checkedPressedShape: RemoteShape
)

Returns a copy of this RemoteIconToggleButtonShapes optionally overriding some of the values.

open operator Boolean
equals(other: Any?)
open Int

Public properties

RemoteShape

The shape of the toggle button when checked and pressed.

RemoteShape

The shape of the toggle button when checked.

RemoteShape

The shape of the toggle button when unchecked and pressed.

RemoteShape

The shape of the toggle button when unchecked.

Public constructors

RemoteIconToggleButtonShapes

Added in 1.0.0-alpha16
RemoteIconToggleButtonShapes(
    uncheckedShape: RemoteShape,
    checkedShape: RemoteShape = uncheckedShape,
    uncheckedPressedShape: RemoteShape = uncheckedShape,
    checkedPressedShape: RemoteShape = checkedShape
)
Parameters
uncheckedShape: RemoteShape

The shape of the toggle button when unchecked.

checkedShape: RemoteShape = uncheckedShape

The shape of the toggle button when checked.

uncheckedPressedShape: RemoteShape = uncheckedShape

The shape of the toggle button when unchecked and pressed.

checkedPressedShape: RemoteShape = checkedShape

The shape of the toggle button when checked and pressed.

Public functions

copy

Added in 1.0.0-alpha16
fun copy(
    uncheckedShape: RemoteShape = this.uncheckedShape,
    checkedShape: RemoteShape = this.checkedShape,
    uncheckedPressedShape: RemoteShape = this.uncheckedPressedShape,
    checkedPressedShape: RemoteShape = this.checkedPressedShape
): RemoteIconToggleButtonShapes

Returns a copy of this RemoteIconToggleButtonShapes optionally overriding some of the values.

Parameters
uncheckedShape: RemoteShape = this.uncheckedShape

The shape of the toggle button when unchecked.

checkedShape: RemoteShape = this.checkedShape

The shape of the toggle button when checked.

uncheckedPressedShape: RemoteShape = this.uncheckedPressedShape

The shape of the toggle button when unchecked and pressed.

checkedPressedShape: RemoteShape = this.checkedPressedShape

The shape of the toggle button when checked and pressed.

Returns
RemoteIconToggleButtonShapes

a copy of this RemoteIconToggleButtonShapes with the specified values overridden

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

checkedPressedShape

Added in 1.0.0-alpha16
val checkedPressedShape: RemoteShape

The shape of the toggle button when checked and pressed.

checkedShape

Added in 1.0.0-alpha16
val checkedShape: RemoteShape

The shape of the toggle button when checked.

uncheckedPressedShape

Added in 1.0.0-alpha16
val uncheckedPressedShape: RemoteShape

The shape of the toggle button when unchecked and pressed.

uncheckedShape

Added in 1.0.0-alpha16
val uncheckedShape: RemoteShape

The shape of the toggle button when unchecked.