1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Assistant of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL-EXCEPT$
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 as published by the Free Software
20** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
21** included in the packaging of this file. Please review the following
22** information to ensure the GNU General Public License requirements will
23** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24**
25** $QT_END_LICENSE$
26**
27****************************************************************************/
28
29#ifndef QOPTIONSWIDGET_H
30#define QOPTIONSWIDGET_H
31
32//
33// W A R N I N G
34// -------------
35//
36// This file is not part of the Qt API. It exists for the convenience
37// of the help generator tools. This header file may change from version
38// to version without notice, or even be removed.
39//
40// We mean it.
41//
42
43#include <QtWidgets/QWidget>
44#include <QtCore/QMap>
45
46QT_BEGIN_NAMESPACE
47
48class QListWidget;
49class QListWidgetItem;
50
51class QOptionsWidget : public QWidget
52{
53 Q_OBJECT
54public:
55 QOptionsWidget(QWidget *parent = nullptr);
56
57 void clear();
58 void setOptions(const QStringList &validOptions,
59 const QStringList &selectedOptions);
60 QStringList validOptions() const;
61 QStringList selectedOptions() const;
62
63 void setNoOptionText(const QString &text);
64 void setInvalidOptionText(const QString &text);
65
66signals:
67 void optionSelectionChanged(const QStringList &options);
68
69private:
70 QString optionText(const QString &optionName, bool valid) const;
71 QListWidgetItem *appendItem(const QString &optionName, bool valid, bool selected);
72 void appendSeparator();
73 void itemChanged(QListWidgetItem *item);
74
75 QListWidget *m_listWidget = nullptr;
76 QString m_noOptionText;
77 QString m_invalidOptionText;
78 QStringList m_validOptions;
79 QStringList m_invalidOptions;
80 QStringList m_selectedOptions;
81 QMap<QString, QListWidgetItem *> m_optionToItem;
82 QMap<QListWidgetItem *, QString> m_itemToOption;
83};
84
85QT_END_NAMESPACE
86
87#endif // OPTIONSWIDGET_H
88

source code of qttools/src/assistant/help/qoptionswidget_p.h