1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
5** Contact: https://www.qt.io/licensing/
6**
7** This file is part of the QtCore module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial License Usage
11** Licensees holding valid commercial Qt licenses may use this file in
12** accordance with the commercial license agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and The Qt Company. For licensing terms
15** and conditions see https://www.qt.io/terms-conditions. For further
16** information use the contact form at https://www.qt.io/contact-us.
17**
18** GNU Lesser General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU Lesser
20** General Public License version 3 as published by the Free Software
21** Foundation and appearing in the file LICENSE.LGPL3 included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU Lesser General Public License version 3 requirements
24** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
25**
26** GNU General Public License Usage
27** Alternatively, this file may be used under the terms of the GNU
28** General Public License version 2.0 or (at your option) the GNU General
29** Public license version 3 or any later version approved by the KDE Free
30** Qt Foundation. The licenses are as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
32** included in the packaging of this file. Please review the following
33** information to ensure the GNU General Public License requirements will
34** be met: https://www.gnu.org/licenses/gpl-2.0.html and
35** https://www.gnu.org/licenses/gpl-3.0.html.
36**
37** $QT_END_LICENSE$
38**
39****************************************************************************/
40
41#ifndef QCOMMANDLINEOPTION_H
42#define QCOMMANDLINEOPTION_H
43
44#include <QtCore/qstringlist.h>
45#include <QtCore/qshareddata.h>
46
47QT_REQUIRE_CONFIG(commandlineparser);
48
49QT_BEGIN_NAMESPACE
50
51class QCommandLineOptionPrivate;
52
53class Q_CORE_EXPORT QCommandLineOption
54{
55public:
56 enum Flag {
57 HiddenFromHelp = 0x1,
58 ShortOptionStyle = 0x2
59 };
60 Q_DECLARE_FLAGS(Flags, Flag)
61
62 explicit QCommandLineOption(const QString &name);
63 explicit QCommandLineOption(const QStringList &names);
64 /*implicit*/ QCommandLineOption(const QString &name, const QString &description,
65 const QString &valueName = QString(),
66 const QString &defaultValue = QString());
67 /*implicit*/ QCommandLineOption(const QStringList &names, const QString &description,
68 const QString &valueName = QString(),
69 const QString &defaultValue = QString());
70 QCommandLineOption(const QCommandLineOption &other);
71
72 ~QCommandLineOption();
73
74 QCommandLineOption &operator=(const QCommandLineOption &other);
75 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QCommandLineOption)
76
77 void swap(QCommandLineOption &other) noexcept
78 { qSwap(d, other.d); }
79
80 QStringList names() const;
81
82 void setValueName(const QString &name);
83 QString valueName() const;
84
85 void setDescription(const QString &description);
86 QString description() const;
87
88 void setDefaultValue(const QString &defaultValue);
89 void setDefaultValues(const QStringList &defaultValues);
90 QStringList defaultValues() const;
91
92 Flags flags() const;
93 void setFlags(Flags aflags);
94
95private:
96 QSharedDataPointer<QCommandLineOptionPrivate> d;
97};
98
99Q_DECLARE_SHARED(QCommandLineOption)
100Q_DECLARE_OPERATORS_FOR_FLAGS(QCommandLineOption::Flags)
101
102
103QT_END_NAMESPACE
104
105#endif // QCOMMANDLINEOPTION_H
106