qt-everywhere-src-5.15.1/qttools/src/assistant/help/qhelpfiltersettings_p.h

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://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 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QHELPFILTERSETTINGS_H
#define QHELPFILTERSETTINGS_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/QSharedDataPointer>

QT_BEGIN_NAMESPACE

template <class K, class T>
class QMap;
class QHelpFilterData;
class QHelpFilterEngine;
class QHelpFilterSettingsPrivate;

class QHelpFilterSettings final
{
public:
    QHelpFilterSettings();
    QHelpFilterSettings(const QHelpFilterSettings &other);
    QHelpFilterSettings(QHelpFilterSettings &&other);
    ~QHelpFilterSettings();

    QHelpFilterSettings &operator=(const QHelpFilterSettings &other);
    QHelpFilterSettings &operator=(QHelpFilterSettings &&other);

    void swap(QHelpFilterSettings &other) noexcept
    { d.swap(other.d); }

    void setFilter(const QString &filterName, const QHelpFilterData &filterData);
    void removeFilter(const QString &filterName);
    QStringList filterNames() const;
    QHelpFilterData filterData(const QString &filterName) const;
    QMap<QString, QHelpFilterData> filters() const;

    void setCurrentFilter(const QString &filterName);
    QString currentFilter() const;

    static QHelpFilterSettings readSettings(const QHelpFilterEngine *filterEngine);
    static bool applySettings(QHelpFilterEngine *filterEngine, const QHelpFilterSettings &settings);

private:
    QSharedDataPointer<QHelpFilterSettingsPrivate> d;
};

QT_END_NAMESPACE

#endif // QHELPFILTERSETTINGS_H