Skip to content
GitLab
Select Git revision
  • 6.2.2
  • dev default
  • 6.2
  • 6.2.1
  • 6.2.0
  • 5.12
  • 5.12.12
  • 6.1
  • 6.1.3
  • 6.0
  • 6.1.2
  • 6.1.1
  • 6.1.0
  • 5.12.11
  • 6.0.0
  • 5.15
  • 5.15.2
  • 5.12.10
  • 5.15.1
  • 5.12.9
  • v5.15.0-alpha1
  • v5.12.7
  • v5.14.1
  • v5.9.9
  • v5.14.0
  • v5.14.0-rc2
  • v5.14.0-rc1
  • v5.12.6
  • v5.14.0-beta3
  • v5.13.2
  • v5.14.0-beta2
  • v5.14.0-beta1
  • v5.14.0-alpha1
  • v5.12.5
  • v5.13.1
  • v5.13.0
  • v5.13.0-rc3
  • v5.12.4
  • v5.13.0-rc2
  • v5.13.0-rc1
Find file BlameHistoryPermalink
qhelpdatainterface_p.h 4.23 KiB
1 
/****************************************************************************
2 
**
3 
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 
** Contact: http://www.qt-project.org/legal
5 
**
6 
** This file is part of the Qt Assistant of the Qt Toolkit.
7 
**
8 
** $QT_BEGIN_LICENSE:LGPL21$
9 
** Commercial License Usage
10 
** Licensees holding valid commercial Qt licenses may use this file in
11 
** accordance with the commercial license agreement provided with the
12 
** Software or, alternatively, in accordance with the terms contained in
13 
** a written agreement between you and Digia. For licensing terms and
14 
** conditions see http://qt.digia.com/licensing. For further information
15 
** use the contact form at http://qt.digia.com/contact-us.
16 
**
17 
** GNU Lesser General Public License Usage
18 
** Alternatively, this file may be used under the terms of the GNU Lesser
19 
** General Public License version 2.1 or version 3 as published by the Free
20 
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 
** following information to ensure the GNU Lesser General Public License
23 
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 
**
26 
** In addition, as a special exception, Digia gives you certain additional
27 
** rights. These rights are described in the Digia Qt LGPL Exception
28 
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 
**
30 
** $QT_END_LICENSE$
31 
**
32 
****************************************************************************/
33
34 
#ifndef QHELPDATAINTERFACE_H
35 
#define QHELPDATAINTERFACE_H
36
37 
//
38 
//  W A R N I N G
39 
//  -------------
40 
//
41 
// This file is not part of the Qt API. It exists for the convenience
42 
// of the help generator tools. This header file may change from version
43 
// to version without notice, or even be removed.
44 
//
45 
// We mean it.
46 
//
47
48 
#include "qhelp_global.h"
49
50 
#include <QtCore/QStringList>
51 
#include <QtCore/QSharedData>
52
53 
QT_BEGIN_NAMESPACE
54
55 
class QHELP_EXPORT QHelpDataContentItem
56 
{
57 
public:
58 
    QHelpDataContentItem(QHelpDataContentItem *parent, const QString &title,
59 
        const QString &reference);
60 
    ~QHelpDataContentItem();
61
62 
    QString title() const;
63 
    QString reference() const;
64 
    QList<QHelpDataContentItem*> children() const;
65
66 
private:
67 
    QString m_title;
68 
    QString m_reference;
69 
    QList<QHelpDataContentItem*> m_children;
70 
};
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
struct QHELP_EXPORT 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 QHELP_EXPORT 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 QHELP_EXPORT QHelpDataCustomFilter { QStringList filterAttributes; QString name; }; class QHELP_EXPORT QHelpDataInterface { public: QHelpDataInterface() {} virtual ~QHelpDataInterface() {} virtual QString namespaceName() const = 0; virtual QString virtualFolder() const = 0; virtual QList<QHelpDataCustomFilter> customFilters() const = 0; virtual QList<QHelpDataFilterSection> filterSections() const = 0; virtual QMap<QString, QVariant> metaData() const = 0; virtual QString rootPath() const = 0; };
141142143144
QT_END_NAMESPACE #endif // QHELPDATAINTERFACE_H