inline-component-enums.qdoc

Go to the documentation of this file.

// Copyright (C) 2026 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
 
/*!
\ingroup qmllint-warnings-and-errors
 
\title Inline component enums
\brief [inline-component-enums] An enum was declared inside an inline component.
 
\qmllintwarningcategory inline-component-enums
 
\section1 Enums declared inside of inline components are ignored
 
\section2 What happened?
You defined an \l{qtqml-syntax-objectattributes.html#enumeration-attributes}{enum}
inside an inline component.
 
\section2 Why is this bad?
The QML language only allows enum definitions inside the root
item of the QML file. Enums declared inside an inline
component are unusable, even inside the inline component. The same applies to
enums declared inside non-root QML objects.
 
\section2 Example
\qml
import QtQuick
 
Item {
    component MyInlineComponent: Item {
        enum MyEnum { Hello, World }
    }
}
 
\endqml
To fix this warning, move the enum declaration into the root element of the
QML file:
\qml
import QtQuick
 
Item {
    enum MyEnum { Hello, World }
    component MyInlineComponent: Item {
    }
}
 
\endqml
*/