QcHandbook Class

Member Function Documentation

[constexpr noexcept default] QcHandbook::QcHandbook()

Default-constructs an instance of QcHandbook.

const QList<QcHandbook::Category> &QcHandbook::categories() const

Returns the categories.

const QcHandbook::Category *QcHandbook::category(const QString &id) const

Returns the category with the id id; null when there is none.

const QList<QcHandbookEntry> &QcHandbook::entries() const

Returns every entry.

const QcHandbookEntry *QcHandbook::entry(const QString &id) const

Returns the entry with the id id; null when there is none.

QString QcHandbook::label(const QString &key) const

Returns the translated text key of the handbook itself for exports ("title", "intro", "contents", "index", "packs", "fact.id"); the key itself when missing.

const QString &QcHandbook::language() const

Returns the language of the texts.

QString QcHandbook::packName(const QString &id) const

Returns the display name of the pack id (its namespace when no such pack was loaded).

const QList<QcPackReference> &QcHandbook::packs() const

Returns the packs in load order; entries of names without a loaded pack come last under their namespace.

const QStringList &QcHandbook::problems() const

Returns the inconsistencies found while building (links to unknown entries, unknown rule placeholders).

QList<qsizetype> QcHandbook::search(const QString &text, int limit = defaultSearchLimit) const

Returns the indices of the entries (at most limit) whose title (in this language or English), name or text contains every word of text, best matches first: title equals it, title starts with it, a title word starts with it, title or name contains it, then the text. Case and accents are ignored.

[static] QString QcHandbook::searchKey(const QString &text)

Returns text in lower case without accents, as compared by search().