C

enumeration QML Basic Type

The enumeration type refers to a named enumeration value.

Each named value can be referred to as <Type>.<value>. For example, the Text type has an AlignRight enumeration value:

Text { horizontalAlignment: Text.AlignRight }

When integrating with C++, note that any enum value passed into QML from C++ is automatically converted into an enumeration value, and vice-versa.

This basic type is provided by the QML language. Some enumeration values are provided by the QtQuick import.

Using the enumeration Type in QML

The enumeration type is a representation of a C++ enum type. It is possible to refer to the enumeration type in QML itself; but instead, the int type shall be used when referring to enumeration values from QML code.

For example:

import QtQuick

Item {
    // refer to Text.AlignRight using an int type
    property int enumValue: textItem.horizontalAlignment

    signal valueEmitted(int someValue)

    Text {
        id: textItem
        horizontalAlignment: Text.AlignRight
    }

    // emit valueEmitted() signal, which expects an int, with Text.AlignRight
    Component.onCompleted: valueEmitted(Text.AlignRight)
}

See also QML Basic Types, enum type as a property type, and QML Object - Enumeration Attributes.

Available under certain Qt licenses.
Find out more.