Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
IR::CollectionInfo Struct Reference

#include <document.h>

Collaboration diagram for IR::CollectionInfo:

Classes

struct  MemberEntry

Public Member Functions

QJsonObject toJson () const
 Converts the CollectionInfo to a QJsonObject for template rendering.

Public Attributes

QString logicalModuleName
QString logicalModuleVersion
QString qtVariable
QString cmakePackage
QString cmakeComponent
QString cmakeTargetItem
QString state
bool isModule { false }
bool isQmlModule { false }
bool isGroup { false }
bool noAutoList { false }
QList< MemberEntry > namespaces
QList< MemberEntry > classes
QList< MemberEntry > members

Detailed Description

Definition at line 52 of file document.h.

Member Function Documentation

◆ toJson()

QJsonObject IR::CollectionInfo::toJson ( ) const
nodiscard

Converts the CollectionInfo to a QJsonObject for template rendering.

Type flags (isModule, isQmlModule, isGroup) and noAutoList are always emitted so templates can use unconditional checks. CMake/qmake build variables are always emitted as empty strings when absent, for template safety. Module metadata (logicalModuleName, logicalModuleVersion, state) is conditionally emitted when non-empty. Member arrays are always emitted (empty arrays when no entries) so Inja can iterate without guards.

Definition at line 99 of file document.cpp.

Member Data Documentation

◆ classes

QList<MemberEntry> IR::CollectionInfo::classes

Definition at line 74 of file document.h.

◆ cmakeComponent

QString IR::CollectionInfo::cmakeComponent

Definition at line 58 of file document.h.

◆ cmakePackage

QString IR::CollectionInfo::cmakePackage

Definition at line 57 of file document.h.

◆ cmakeTargetItem

QString IR::CollectionInfo::cmakeTargetItem

Definition at line 59 of file document.h.

◆ isGroup

bool IR::CollectionInfo::isGroup { false }

Definition at line 64 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ isModule

bool IR::CollectionInfo::isModule { false }

Definition at line 62 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ isQmlModule

bool IR::CollectionInfo::isQmlModule { false }

Definition at line 63 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ logicalModuleName

QString IR::CollectionInfo::logicalModuleName

Definition at line 54 of file document.h.

◆ logicalModuleVersion

QString IR::CollectionInfo::logicalModuleVersion

Definition at line 55 of file document.h.

◆ members

QList<MemberEntry> IR::CollectionInfo::members

Definition at line 75 of file document.h.

◆ namespaces

QList<MemberEntry> IR::CollectionInfo::namespaces

Definition at line 73 of file document.h.

◆ noAutoList

bool IR::CollectionInfo::noAutoList { false }

Definition at line 65 of file document.h.

Referenced by IR::Builder::buildPageIR().

◆ qtVariable

QString IR::CollectionInfo::qtVariable

Definition at line 56 of file document.h.

◆ state

QString IR::CollectionInfo::state

Definition at line 60 of file document.h.

The documentation for this struct was generated from the following files: