Contents

CheckBox

CheckBox is a component with two states, checked or unchecked. It can be used to set boolean options. The behavior is the same as Switch, the only difference is the graphical style. More...

Import Statement: import Ubuntu.Components 0.1
Inherits:

AbstractButton

Inherited By:

Switch.

Properties

Signals

Methods

Detailed Description

See also the Design Guidelines on Toggles.

This component is under heavy development.

Example:

Item {
    CheckBox {
        checked: true
    }
}

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.


checked : bool

This QML property is under development and is subject to change.

Specifies whether the checkbox is checked or not. By default the property is set to false.


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.


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.