Button

Standard Ubuntu button. More...

Import Statement: import Ubuntu.Components 0.1
Inherits:

AbstractButton

Properties

Signals

Methods

Detailed Description

See also the Design Guidelines on Buttons.

Examples:

Column {
    Button {
        text: "Send"
        onClicked: print("clicked text-only Button")
    }
    Button {
        iconName: "compose"
        gradient: UbuntuColors.greyGradient
        onClicked: print("clicked icon-only Button")
    }
    Button {
        iconName: "compose"
        text: "Icon on left"
        iconPosition: "left"
        onClicked: print("clicked text and icon Button")
    }
}

An Action can be used to specify clicked, iconSource and text. Example:

 Item {
     Action {
         id: action1
         text: "Click me"
         onTriggered: print("action!")
         iconName: "compose"
     }
     Button {
         anchors.centerIn: parent
         action: action1
         color: UbuntuColors.warmGrey
     }
}

Property Documentation

action : Action

The Action associated with this ActionItem. If action is set, the values of the Action properties are copied to the values of the ActionItem properties.


color : color

The background color of the button.

See also gradient.


gradient : Gradient

The gradient used to fill the background of the button.

Standard Ubuntu gradients are defined in UbuntuColors.

If both a gradient and a color are specified, the gradient will be used.

See also color.


hovered : bool

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


iconName : string

The icon associated with the actionItem in the ubuntu-mobile icon theme. Default value: action.iconName.

If both iconSource and iconName are defined, iconName will be ignored.


iconPosition : string

The position of the icon relative to the text. Options are "left" and "right". The default value is "left".

If only text or only an icon is defined, this property is ignored and the text or icon is centered horizontally and vertically in the button.

Currently this is a string value. We are waiting for support for enums: https://bugreports.qt-project.org/browse/QTBUG-14861


iconSource : url

The image associated with the actionItem. Default value: action.iconSource.

If both iconSource and iconName are defined, iconName will be ignored.


pressed : bool

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


style : Component

Component instantiated immediately and placed below everything else.


text : string

The title of the actionItem. Default value: action.text


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.


pressAndHold()

This handler is called when there is a long press.


triggered(var value)

Called when the actionItem is triggered.


Method Documentation

trigger( value)

Trigger this action item if it is enabled.