AppUIScreen QML Type

A base QML item for developing applications. More...

Import Statement: import utils 1.0
Inherited By:

NavigationUIScreen

Properties

Signals

Methods

Detailed Description

AppUIScreen is a QML item which should be a root element in every Neptune UI application. It provides APIs for interacting with a system UI and for positioning the application's visual elements.

See Neptune UI Application Development for best practices on how to use the APIs.

Example Usage

The following example uses AppUIScreen as a root element:

AppUIScreen {
    id: root
    title: "Neptune Template"

    UIScreen {
        Content {
            anchors.centerIn: parent
            width: Style.hspan(13)
            height: Style.vspan(24)
        }

        onBackScreen: root.back()
    }
}

Property Documentation

cluster : Item

If a cluster is available, this property assigns visual content for the cluster window.


[default] content : Item

A default property that specifies a content area for the application's visual content.


Signal Documentation

closeApp()

This signal is emitted every time an application is closed by clicking the back button.


clusterKeyPressed(int key)

This signal is emitted every time a key is pressed in a cluster.


raiseApp()

This signal is emitted every time an application is started.


Method Documentation

back()

This method is called when an application needs to exit. It ensures the system UI screen visibility when a back button is clicked.

AppUIScreen {
    id: root
    title: "Neptune Template"

    UIScreen {
        Content {
            anchors.centerIn: parent
            width: Style.hspan(13)
            height: Style.vspan(24)
        }

        onBackScreen: root.back()
    }
}

© 2017 Pelagicore AG. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.