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