cppref

{#- 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/md/nav.md" %}

{{ fullTitle }}

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

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

{% endif %} {% if hasCppRef and cppRef.isPartialNamespace %} The {{ title }} namespace is documented in the module {{ cppRef.fullNamespaceModuleName }}.

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

{% if hasCppRef and cppRef.isInnerClass %} {% if default(since, "") != "" %}

Key	Value
Since	Qt {{ since }}

{% endif %} {% endif %} {% if membersPageUrl != "" %}

• [List of all members, including inherited members]({{ membersPageUrl }})

{% endif %} {% if hasCppRef and cppRef.hasObsoleteMembers %}

• Obsolete members

{% endif %} {% if hasCppRef and length(cppRef.groups) > 0 %} {{ title }} is part of {% for group in cppRef.groups %}{% if not loop.is_first %}, {% endif %}{{ group.name }}{% endfor %}.

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

Warning:{{ " " }}{% for block in cppRef.threadSafetyAdmonition %}{% for i in block.inlines %}{% if i.type == "text" %}{{ i.text }}{% else if i.type == "link" %}{% if existsIn(i, "href") %}{% for c in i.children %}{{ c.text }}{% endfor %}{% else %}{% for c in i.children %}{{ c.text }}{% endfor %}{% endif %}{% endif %}{% endfor %}{% endfor %}

{% else %}

Note:{{ " " }}{% for block in cppRef.threadSafetyAdmonition %}{% for i in block.inlines %}{% if i.type == "text" %}{{ i.text }}{% else if i.type == "link" %}{% if existsIn(i, "href") %}{% for c in i.children %}{{ c.text }}{% endfor %}{% else %}{% for c in i.children %}{{ c.text }}{% endfor %}{% endif %}{% endif %}{% endfor %}{% endfor %}

{% endif %} {% endif %} {% if hasCppRef and length(cppRef.comparisonEntries) > 0 %}

| Category | Type(s) | Description | | — | — | — | {% for entry in cppRef.comparisonEntries %} | {{ entry.category }} | {% for t in entry.comparableTypes %}{% if not loop.is_first %}, {% endif %}{{ t }}{% endfor %} | {{ entry.description }} | {% endfor %}

{% endif %} {% if length(sections) > 0 %} {% for section in sections %}

{{ section.title }}

| Member | Description | | — | — | {% for member in section.members %} | {{ escape_md_table(member.signature) }} | {{ escape_md_table(default(member.brief, "")) }} | {% endfor %} {% if existsIn(section, "reimplementedMembers") %}

Reimplemented {{ section.plural }}

| Member | Description | | — | — | {% for member in section.reimplementedMembers %} | {{ escape_md_table(member.signature) }} | {{ escape_md_table(default(member.brief, "")) }} | {% endfor %} {% endif %} {% if existsIn(section, "inheritedMembers") %} {% for inherited in section.inheritedMembers %}

• {{ inherited.count }} {{ section.plural }} inherited from {% if inherited.href != "" %}{{ inherited.className }}{% else %}{{ inherited.className }}{% endif %} {% endfor %} {% endif %} {% endfor %} {% endif %}

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

Detailed Description

{% endif %} {% include "partials/md/content_blocks.md" %}

{% if length(detailSections) > 0 %} {% for section in detailSections %} {% if length(section.members) > 0 %}

{{ section.title }}

{% for member in section.members %} {% include "partials/md/member_detail.md" %} {% endfor %} {% endif %} {% endfor %} {% endif %} {% include "partials/md/footer.md" %}