{#- Copyright (C) 2026 The Qt Company Ltd. SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 -#} {% include "partials/html/head.html" %} {% include "partials/qt-branded/header-bar.html" %}

{{ fullTitle }}

{% if hasCppRef %} {% if length(cppRef.templateDeclSpans) > 0 or cppRef.typeWord != "" %}

{% if length(cppRef.templateDeclSpans) > 0 %}{{ render_signature_spans(cppRef.templateDeclSpans) }}
{% endif %}{{ escape_html(cppRef.typeWord) }}{{ " " }}{{ escape_html(title) }}

{% endif %} {% endif %} {% if default(brief, "") != "" %}

{{ brief }}

{% endif %} {% include "partials/qt-branded/toolbar.html" %} {% if hasCppRef and cppRef.isPartialNamespace %}

The {{ escape_html(title) }} namespace is documented in the module {{ escape_html(cppRef.fullNamespaceModuleName) }}.

{% endif %} {% if hasCppRef and not cppRef.isInnerClass %} {% if existsIn(cppRef, "headerInclude") and cppRef.headerInclude != "" %} {% endif %} {% if existsIn(cppRef, "cmakeFindPackage") and cppRef.cmakeFindPackage != "" %} {% endif %} {% if existsIn(cppRef, "qmakeVariable") and cppRef.qmakeVariable != "" %} {% endif %} {% if default(since, "") != "" %} {% endif %} {% if existsIn(cppRef, "qmlNativeType") %} {% endif %} {% if not cppRef.suppressInheritance and length(cppRef.baseClasses) > 0 %} {% endif %} {% if length(cppRef.derivedClasses) > 0 %} {% endif %} {% if existsIn(cppRef, "statusText") and cppRef.statusText != "" %} {% endif %}
Header: {{ escape_html(cppRef.headerInclude) }}
CMake: {{ escape_html(cppRef.cmakeFindPackage) }}
{{ escape_html(cppRef.cmakeTargetLinkLibraries) }}
qmake: {{ escape_html(cppRef.qmakeVariable) }}
Since: Qt {{ escape_html(since) }}
In QML: {% if cppRef.qmlNativeType.href != "" %}{{ escape_html(cppRef.qmlNativeType.name) }}{% else %}{{ escape_html(cppRef.qmlNativeType.name) }}{% endif %}
Inherits: {% for base in cppRef.baseClasses %}{% if not loop.is_first %}, {% endif %}{% if base.href != "" %}{{ escape_html(base.name) }}{% else %}{{ escape_html(base.name) }}{% endif %}{% if base.access.id != "public" %} ({{ escape_html(base.access.label) }}){% endif %}{% endfor %}
Inherited By: {% for derived in cppRef.derivedClasses %}{% if not loop.is_first %}, {% endif %}{% if derived.href != "" %}{{ escape_html(derived.name) }}{% else %}{{ escape_html(derived.name) }}{% endif %}{% endfor %}
Status: {{ escape_html(cppRef.statusText) }}
{% endif %} {% if hasCppRef and cppRef.isInnerClass %} {% if default(since, "") != "" %}
Since: Qt {{ escape_html(since) }}
{% endif %} {% endif %} {% if membersPageUrl != "" %} {% endif %} {% if hasCppRef and cppRef.hasObsoleteMembers %} {% endif %} {% if hasCppRef and length(cppRef.groups) > 0 %}

{{ escape_html(title) }} is part of {% for group in cppRef.groups %}{% if not loop.is_first %}, {% endif %}{{ escape_html(group.name) }}{% endfor %}.

{% endif %} {% if hasCppRef and existsIn(cppRef, "threadSafetyAdmonition") %} {% if cppRef.threadSafety.level == "non-reentrant" %} {% else %} {% endif %} {% endif %} {% if hasCppRef and length(cppRef.comparisonEntries) > 0 %}

{{ escape_html(title) }} Comparisons

{% for entry in cppRef.comparisonEntries %} {% endfor %}
CategoryComparable TypesDescription
{{ escape_html(entry.category) }}{% for t in entry.comparableTypes %}{% if not loop.is_first %}, {% endif %}{{ escape_html(t) }}{% endfor %}{{ escape_html(entry.description) }}
{% endif %} {% if length(sections) > 0 %} {% for section in sections %}

{{ escape_html(section.title) }}

{% if length(section.members) > 0 %} {% for member in section.members %} {% endfor %}
{% if existsIn(member, "signatureSpans") %}{{ render_signature_spans(member.signatureSpans) }}{% else %}{% if existsIn(member, "href") and member.href != "" %}{{ escape_html(member.signature) }}{% else %}{{ escape_html(member.signature) }}{% endif %}{% endif %} {{ escape_html(default(member.brief, "")) }}
{% endif %} {% if existsIn(section, "reimplementedMembers") %}

Reimplemented {{ escape_html(section.plural) }}

{% for member in section.reimplementedMembers %} {% endfor %}
{% if existsIn(member, "signatureSpans") %}{{ render_signature_spans(member.signatureSpans) }}{% else %}{% if existsIn(member, "href") and member.href != "" %}{{ escape_html(member.signature) }}{% else %}{{ escape_html(member.signature) }}{% endif %}{% endif %} {{ escape_html(default(member.brief, "")) }}
{% endif %} {% if existsIn(section, "inheritedMembers") %} {% for inherited in section.inheritedMembers %}

{{ inherited.count }} {{ escape_html(section.plural) }} inherited from {% if inherited.href != "" %}{{ escape_html(inherited.className) }}{% else %}{{ escape_html(inherited.className) }}{% endif %}

{% endfor %} {% endif %}
{% endfor %} {% endif %} {% if length(content.blocks) > 0 %}

Detailed Description

{% endif %} {% include "partials/html/content_blocks.html" %} {% if length(detailSections) > 0 %} {% for section in detailSections %} {% if length(section.members) > 0 %}

{{ escape_html(section.title) }}

{% for member in section.members %} {% include "partials/html/member_detail.html" %} {% endfor %} {% endif %} {% endfor %} {% endif %}
{% include "partials/qt-branded/footer.html" %}