mirror of
https://bitbucket.org/smil3y/katie.git
synced 2025-02-27 20:32:57 +00:00
90 lines
2.9 KiB
C
90 lines
2.9 KiB
C
|
/****************************************************************************
|
||
|
|
**
|
||
|
|
** Copyright (C) 2015 The Qt Company Ltd.
|
||
|
|
** Contact: http://www.qt.io/licensing/
|
||
|
|
**
|
||
|
|
** This file is part of the Qt Assistant of the Qt Toolkit.
|
||
|
|
**
|
||
|
|
** $QT_BEGIN_LICENSE:LGPL$
|
||
|
|
** Commercial License Usage
|
||
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
||
|
|
** accordance with the commercial license agreement provided with the
|
||
|
|
** Software or, alternatively, in accordance with the terms contained in
|
||
|
|
** a written agreement between you and The Qt Company. For licensing terms
|
||
|
|
** and conditions see http://www.qt.io/terms-conditions. For further
|
||
|
|
** information use the contact form at http://www.qt.io/contact-us.
|
||
|
|
**
|
||
|
|
** GNU Lesser General Public License Usage
|
||
|
|
** Alternatively, this file may be used under the terms of the GNU Lesser
|
||
|
|
** General Public License version 2.1 or version 3 as published by the Free
|
||
|
|
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
|
||
|
|
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
|
||
|
|
** following information to ensure the GNU Lesser General Public License
|
||
|
|
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
|
||
|
|
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
||
|
|
**
|
||
|
|
** As a special exception, The Qt Company gives you certain additional
|
||
|
|
** rights. These rights are described in The Qt Company LGPL Exception
|
||
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||
|
|
**
|
||
|
|
** GNU General Public License Usage
|
||
|
|
** Alternatively, this file may be used under the terms of the GNU
|
||
|
|
** General Public License version 3.0 as published by the Free Software
|
||
|
|
** Foundation and appearing in the file LICENSE.GPL included in the
|
||
|
|
** packaging of this file. Please review the following information to
|
||
|
|
** ensure the GNU General Public License version 3.0 requirements will be
|
||
|
|
** met: http://www.gnu.org/copyleft/gpl.html.
|
||
|
|
**
|
||
|
|
** $QT_END_LICENSE$
|
||
|
|
**
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifndef QHELPPROJECTDATA_H
|
||
|
|
#define QHELPPROJECTDATA_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 "qhelp_global.h"
|
||
|
|
#include "qhelpdatainterface_p.h"
|
||
|
|
|
||
|
|
QT_BEGIN_HEADER
|
||
|
|
|
||
|
|
QT_BEGIN_NAMESPACE
|
||
|
|
|
||
|
|
class QHelpProjectDataPrivate;
|
||
|
|
|
||
|
|
class QHELP_EXPORT QHelpProjectData : public QHelpDataInterface
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
QHelpProjectData();
|
||
|
|
~QHelpProjectData();
|
||
|
|
|
||
|
|
bool readData(const QString &fileName);
|
||
|
|
QString errorMessage() const;
|
||
|
|
|
||
|
|
QString namespaceName() const;
|
||
|
|
QString virtualFolder() const;
|
||
|
|
QList<QHelpDataCustomFilter> customFilters() const;
|
||
|
|
QList<QHelpDataFilterSection> filterSections() const;
|
||
|
|
QMap<QString, QVariant> metaData() const;
|
||
|
|
QString rootPath() const;
|
||
|
|
|
||
|
|
private:
|
||
|
|
QHelpProjectDataPrivate *d;
|
||
|
|
};
|
||
|
|
|
||
|
|
QT_END_NAMESPACE
|
||
|
|
|
||
|
|
QT_END_HEADER
|
||
|
|
|
||
|
|
#endif
|