Contents

AbstractButton QML Type

The AbstractButton class defines the behavior of the button. More...

Import Statement: import Lomiri.Components 1.3
Inherits:

ActionItem

Inherited By:

Button, CheckBox, ComboButton, Empty, and PickerDelegate

Properties

Signals

Detailed Description

This class defines the behavior of the button: it defines the MouseArea and the states. All components deriving from this class support haptic feedback out of the box.

Property Documentation

hovered : bool

True if the mouse cursor hovers over the button's mouse area.


pressed : bool

True if the user presses a mouse button in the button's mouse area.


sensingMargins group

sensingMargins.all : real

sensingMargins.bottom : real

sensingMargins.left : real

sensingMargins.right : real

sensingMargins.top : real

The property group specifies the margins extending the visual area where the touch events are sensed. Positive values mean the area will be extended on the specified direction outside of the visual area, negative values mean the sensing will fall under the component's visual border. All values default to 0. This does not affect mouse sensing area, which only covers the visual area of the component.

Note: If the visual area and the sensing margins are not reaching the 4x4 grid units limit, the component will fall back to these minimum limits. For example, extending a 2x2 grid unit visual component into 5x4 grid units sensing area would look as follows:

AbstractButton {
    width: units.gu(2)
    height: units.gu(2)
    Icon {
        name: "settings"
    }
    sensingArea {
        // no need to set the vertical direction as the minimum of
        // 4 grid units will be taken automatically
        leftMargin: units.gu(1)
        // we only have to add 2 grid units as the width + left margin
        // already gives us 3 grid units out of 5
        rightMargin: units.gu(2)
    }
}

Signal Documentation

clicked()

This handler is called when there is a mouse click on the button and the button is not disabled. If action is defined, the action will be triggered.

Note: The corresponding handler is onClicked.


clicked()

This handler is called when there is a mouse click on the button and the button is not disabled. If action is defined, the action will be triggered.

Note: The corresponding handler is onClicked.


pressAndHold()

This handler is called when there is a long press.

Note: The corresponding handler is onPressAndHold.


pressAndHold()

This handler is called when there is a long press.

Note: The corresponding handler is onPressAndHold.