CheckBox

Ownership of the ActionSet object remains with the control.

The control takes ownership of the ActionSet object, since ActionSet objects should not typically be shared. If the ActionSet is 0 or it already belongs to the control, the action set is not added. Once completed, the actionSetAdded() signal is emitted.

For example usage, refer to documentation of bb::cascades::GestureHandler.

The Control will always take ownership as a key listener should never be shared. If the key listener already belongs to the Control or the key listener is 0, nothing will happen.

The Control will always take ownership as shortcuts should never be shared. If the shortcut already belongs to the Control or the shortcut is 0, nothing will happen. The order in which shortcuts are added will determine which shortcut will be triggered in case of an overlap.

Multiple behaviors can be added, they will get evaluated in parallel.

For example usage, refer to documentation of bb::cascades::TouchBehavior.

Shortcuts that are attached afterward will use the default enabled state.

The policy describes under which condtions the control will lose focus

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Important: Setting the visible value to false is not the same as setting opacity to 0.0f (transparent). While a transparent node is still laid out taking up room in the scene, a node that is not visible, will neither be rendered nor laid out inside the scene. It will behave as if it was removed from the scene without actually been unlinked from the scene graph. No touch events will be sent to the node if the visible value is false. This a convenient way of removing nodes to optimize the performance of the scene without is actually unlinking them. It is highly recommended to use this property to hide visual nodes whenever possible.

Ownership of the key listener remains with the Control.

Ownership of the LayoutProperties object remains unchanged.

If succeeded, the focusedChanged() signal is emitted with false as its parameter.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

If overlap touch policy is OverlapTouchPolicy::Deny, overlapped nodes will be excluded from touch propagation at an early stage during the processing of touch input. This means a scene with many layers of visual nodes with overlap touch policy set to OverlapTouchPolicy::Allow, may affect touch performance negatively.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

To check whether the preferred height is set for a control, call isPreferredHeightSet().

To check whether the preferred width is set for the control, call isPreferredWidthSet().

Once the ActionSet is removed, the control no longer references it, but it is still owned by the control. It is up to the application to either delete the removed ActionSet, transfer its ownership (by setting its parent) to another object or leave it as a child of the control (in which case it will be deleted with the control).

Once completed, the actionSetRemoved() signal is emitted.

Once completed, the actionSetRemoved() signal is emitted with 0 as its parameter.

All animations added to the visual node will be removed and deleted.

Once the animation is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed animation, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

for (int i = 0; i < animationCount(); ++i) {
    AbstractAnimation* animation = animationAt(i);
    removeAnimation(animation);
    delete animation;
}

Once the event handler is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed event handler, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Once the gesture handler is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed gesture handler, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

Once the key listener is removed, the Control no longer references it, but it is still owned by the Control. It is up to the application to either delete the removed key listener, transfer its ownership (by setting its parent) to another object, or leave it as a child of the Control (in which case it will be deleted with the Control).

Once the shortcut is removed, the Control no longer references it, but it is still owned by the Control. It is up to the application to either delete the removed shortcut, transfer its ownership (by setting its parent) to another object, or leave it as a child of the Control (in which case it will be deleted with the Control).

Once the touch behavior is removed, the visual node no longer references it, but it is still owned by the visual node. It is up to the application to either delete the removed touch behavior, transfer its ownership (by setting its parent) to another object or leave it as a child of the visual node (in which case it will be deleted with the visual node).

When requesting focus for a control, you must ensure that the control is currently a part of the scene.

A common use case for requesting focus is when a new Page is loaded into the scene. For example, on a page that requires text input from the user, you might want to request focus on a TextField as soon as the page loads so that the keyboard is automatically displayed. In this scenario, the natural assumption might be to request focus within the page's BaseObject::creationCompleted() signal, which is emitted once the object's construction is complete. However, this approach is incorrect. Even though the object has been created, it has not yet been added to the UI tree, so the call would fail.

Here are two different methods that you can use for requesting focus. The first method involves listening for changes to the Application::scene property. Here's a .qml file called RequestFocusPage.qml, which contains a TextField that you want to request focus for as soon as the page loads. The page contains a variant property that is bound to the application's scene property. When you declare a variable in QML, a value-change signal is implicitly created as well. So, whenever this page gets added to the scene, the onAppSceneChanged() signal handler is called where it's safe to request focus for the control.

import bb.cascades 1.2

Page {
    property variant appScene: Application.scene
    Container {
        TextArea {
            id: theTextArea
            text: "Give me focus!"
        }
    }
    onAppSceneChanged: {
        // This triggers focus if the application scene is set to
        // this QML Page.
        theTextArea.requestFocus();
    }
}

import bb.cascades 1.2

Page {
    property bool readyForFocus: false
    Container {
        TextArea {
            id: theTextArea
            text: "I want some focus too!"
        }
    }
    onReadyForFocusChanged: {
        if (readyForFocus) {
            // This triggers focus if the Page is created using a
            // ComponentDefinition.
            theTextArea.requestFocus();
        }
    }
}

import bb.cascades 1.2

NavigationPane {
    id: nav
    RequestFocusPage {
        actions: ActionItem {
            ActionBar.placement: ActionBarPlacement.OnBar
            title: "Navigate"
            onTriggered: {
                var page = refocusPage.createObject();
                nav.push(page);

                // Here it is ok to trigger the focus request since the page is added to
                // the UI tree as it is pushed to the NavigationPane.
                page.readyForFocus = true;
            }
        }
    }
    attachedObjects: ComponentDefinition {
        id: refocusPage
        source: "RequestFocusPage2.qml"
    }
    onPopTransitionEnded: {
        page.destroy()
    }
}

The default bottom padding is 0.

After the padding is reset, the bottomPaddingChanged() signal is emitted.

Default value is true.

Removes the ContextMenuHandler from this control by resetting it to 0.

The default alignment is HorizontalAlignment::Left.

After the horizontal alignment is reset, the horizontalAlignmentChanged() signal is emitted.

The default left padding is 0.

After the padding is reset, the leftPaddingChanged() signal is emitted.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

If overlap touch policy is OverlapTouchPolicy::Deny, overlapped nodes will be excluded from touch propagation at an early stage during the processing of touch input. This means a scene with many layers of visual nodes with overlap touch policy set to OverlapTouchPolicy::Allow, may affect touch performance negatively.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

A convenience function for resetting both the preferred width and height. It is equivalent to calling both resetPreferredWidth() and resetPreferredHeight().

The default right padding is 0.

After the padding is reset, the rightPaddingChanged() signal is emitted.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

The default top padding is 0.

After the padding is reset, the topPaddingChanged() signal is emitted.

This property controls how the visual node and its subtree partakes in touch event propagation. There are three possible modes, as defined by TouchPropagationMode::Type:

The default propagation mode is TouchPropagationMode::Full.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

The translation is mostly useful for animations as it doesn't affect the actual laid out position of the visual node. This translation is added after the node has been laid out so it doesn't affect layout in any way.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

The translation is mostly useful for animations as it doesn't affect the actual laid out position of the visual node. This translation is added after the node has been laid out so it doesn't affect layout in any way.

The translationX and translationY correspond to pixels as long as the translationZ is 0.0.

The translation is mostly useful for animations as it doesn't affect the actual laid out position of the visual node. This translation is added after the node has been laid out so it doesn't affect layout in any way.

The default alignment is VerticalAlignment::Top.

After the vertical alignment is reset, the verticalAlignmentChanged() signal is emitted.

If the visible property is set to false, the visual node is neither laid out nor rendered. The default visible value is true.

Important: Setting the visible value to false is not the same as setting opacity to 0.0f (transparent). While a transparent node is still laid out taking up room in the scene, a node that is not visible, will neither be rendered nor laid out inside the scene. It will behave as if it was removed from the scene without actually been unlinked from the scene graph. No touch events will be sent to the node if the visible value is false. This a convenient way of removing nodes to optimize the performance of the scene without is actually unlinking them. It is highly recommended to use this property to hide visual nodes whenever possible.

The visual node is rotated around the z-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default rotation is 0.0 degrees.

The visual node is scaled along the x-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

The visual node is scaled along the y-axis, centered around a pivot point defined by the components pivotX, pivotY and pivotZ. The default scale factor is 1.0 (not scaled).

After the padding is set, the bottomPaddingChanged() signal is emitted.

Built-in Shortcuts that are attached afterward will use the specified enabled state.

Built-in Shortcuts that are attached afterward will use the specified enabled state.

The control takes ownership of the ContextMenuHandler object. Once completed, the contextMenuHandlerChanged() signal is emitted. The replaced context menu handler (if one was set) remains owned by the control.

The policy describes under which condtions the control will lose focus.

After the horizontal alignment is set, the horizontalAlignmentChanged() signal is emitted.

The control takes ownership of the LayoutProperties object if no other control owns it already. If the LayoutProperties object already has an owner, the properties are applied to the control, but ownership of the LayoutProperties object remains unchanged. If the control already owns a LayoutProperties object, the existing settings are replaced by the specified LayoutProperties object and the container retains ownership of both.

After the padding is set, the leftPaddingChanged() signal is emitted.

A value between 0.0 (transparent) and 1.0 (opaque). This is the local opacity of the visual node, i.e. not taking the ancestor opacities into account. The default opacity is 1.0 (opaque).

If overlap touch policy is OverlapTouchPolicy::Deny, overlapped nodes will be excluded from touch propagation at an early stage during the processing of touch input. This means a scene with many layers of visual nodes with overlap touch policy set to OverlapTouchPolicy::Allow, may affect touch performance negatively.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

The pivot is used as the anchoring point when rotating and scaling the visual node. It is defined by the components pivotX, pivotY and pivotZ and is relative to the center of the visual node. The default position of the pivot point is (0.0, 0.0, 0.0), which means it is at the center of the visual node.

A convenience function for setting both preferred width and height. It is equivalent to calling both setPreferredWidth() and setPreferredHeight().