Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
// Qt-Security score:insignificant reason:build-tool
#ifndef QHELPDATAINTERFACE_H
#define QHELPDATAINTERFACE_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists for the convenience
// of the help generator tools. This header file may change from version
// to version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/QSharedData>
#include <QtCore/QStringList>
#include <QtCore/QVariant>
QT_BEGIN_NAMESPACE
class QHelpDataContentItem
{
public:
QHelpDataContentItem(QHelpDataContentItem *parent, const QString &title,
const QString &reference);
~QHelpDataContentItem();
QString title() const;
QString reference() const;
QList<QHelpDataContentItem*> children() const;
private:
QString m_title;
QString m_reference;
QList<QHelpDataContentItem*> m_children;
};
struct QHelpDataIndexItem {
QHelpDataIndexItem() {}
QHelpDataIndexItem(const QString &n, const QString &id, const QString &r)
: name(n), identifier(id), reference(r) {}
QString name;
QString identifier;
QString reference;
bool operator==(const QHelpDataIndexItem & other) const;
};
class QHelpDataFilterSectionData : public QSharedData
{
public:
~QHelpDataFilterSectionData()
{
qDeleteAll(contents);
}
QStringList filterAttributes;
QList<QHelpDataIndexItem> indices;
QList<QHelpDataContentItem*> contents;
QStringList files;
};
class QHelpDataFilterSection
{
public:
QHelpDataFilterSection();
void addFilterAttribute(const QString &filter);
QStringList filterAttributes() const;
void addIndex(const QHelpDataIndexItem &index);
void setIndices(const QList<QHelpDataIndexItem> &indices);
QList<QHelpDataIndexItem> indices() const;
void addContent(QHelpDataContentItem *content);
void setContents(const QList<QHelpDataContentItem*> &contents);
QList<QHelpDataContentItem*> contents() const;
void addFile(const QString &file);
void setFiles(const QStringList &files);
QStringList files() const;
private:
QSharedDataPointer<QHelpDataFilterSectionData> d;
};
struct QHelpDataCustomFilter {
QStringList filterAttributes;
QString name;
};
QT_END_NAMESPACE
#endif // QHELPDATAINTERFACE_H