Module button

Structs

AUTO_CLICK_INTERVAL_PROPERTY

Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message. While the user holds the button down, the button keeps sending the Button: Click message at the time interval set by this property. To disable the behavior, set to 0.

ButtonConcept

CANCEL

Occurs when a user lifts their finger outside of a Button that they previously pressed.

CLICK

Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires.

CanceledMessageArguments

ClickedMessageArguments

DOWN

Occurs when the user presses down the Button.

ENTER

Button: Enter trigger is set off:

INDEX_IN_GROUP_PROPERTY

Sets the index of the Toggle Button in the Toggle Button Group to which that Toggle Button is registered. If a Toggle Button does not have a local value for this property, it is not registered to the ancestor Toggle Button Group. When set to -1, the Toggle Button Group assigns an index for the Toggle Button.

IS_PRESSED_PROPERTY

Indicates whether the button is pressed and in the down state.

LEAVE

Button: Leave trigger is set off:

LONG_PRESS

Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button.

LONG_PRESS_INTERVAL_PROPERTY

Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture. To disable the long-press gesture, set to 0.

LongPressMessageArguments

PRESS_ON_HOVER_PROPERTY

Whether holding a finger on the device screen and moving it over the button transitions the button to the down state.

PointerEnteredMessageArguments

PointerLeftMessageArguments

PressedMessageArguments

TOGGLED_OFF

Occurs when a Toggle Button is toggled off.

TOGGLED_ON

Occurs when a Toggle Button is toggled on.

TOGGLE_STATE

Occurs when the toggle state of a Toggle Button changes.

TOGGLE_STATE_COUNT_PROPERTY

Sets the number of toggle states of a Toggle Button.

TOGGLE_STATE_PROPERTY

Sets the toggle state of a Toggle Button. To update this property with a binding, use a to-source or two-way binding.

ToggleStateChangedMessageArguments

ToggledOffMessageArguments

ToggledOnMessageArguments

Traits

IButtonConcept

Button nodes provide an area that receives key and touch input which Kanzi translates to state events. In addition to the area that receives input, the Toggle Button nodes provide a toggled state.