BottomEdgeHint QML Type

The BottomEdgeHint shows the availability of extra features available from the bottom edge of the application. More...

Import Statement: import Ubuntu.Components 1.2
Inherits:

Item

Properties

Signals

Detailed Description

It displays either a label or an icon at the bottom of the application.

It has 2 states: hidden or visible. When hidden, part of it is still visible to hint at the existence of the bottom edge.

When used with a mouse it acts like a button. The typical action associated with clicking on it should be revealing the extra features provided by the bottom edge.

Example:

BottomEdgeHint {
    id: bottomEdgeHint
    text: i18n.tr("Favorites")
    onClicked: revealBottomEdge()
}

Property Documentation

iconName : string

The icon associated with the BottomEdgeHint in the icon theme.

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


iconSource : url

The icon displayed by the BottomEdgeHint.

This is the URL of any image file. If both iconSource and iconName are defined, iconName will be ignored.


state : string

BottomEdgeHint can take 2 states of visibility: "Hidden" and "Visible".

When "Visible", the full hint with its content is shown.

When "Hidden", only part of the hint is visible leaving more space for application content.


text : string

The label displayed by the BottomEdgeHint.


Signal Documentation

clicked()

This handler is called when there is a mouse click on the BottomEdgeHint and the BottomEdgeHint is not disabled.