QtCraft API C++ classes QML types Handbook

QcHandbookContext Struct

What the handbook page builders share while building one handbook. More...

Header: #include <common/handbook/builder/QcHandbookContext.h>

Public Variables

const QcContentRegistry &content
const QcHandbookIndex &index
const QcHandbookLinks &links
const QcHandbookRecipes &recipes
QcHandbookText &text

Detailed Description

Member Variable Documentation

const QcContentRegistry &QcHandbookContext::content

The content the handbook describes.

const QcHandbookIndex &QcHandbookContext::index

Where blocks and items are used and found.

Titles, icons and links of the content.

const QcHandbookRecipes &QcHandbookContext::recipes

The recipes as pages show them.

QcHandbookText &QcHandbookContext::text

The texts. Not const: filling placeholders reports problems.