Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
qcommandlineoption.h
Go to the documentation of this file.
1// Copyright (C) 2020 The Qt Company Ltd.
2// Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
4
5#ifndef QCOMMANDLINEOPTION_H
6#define QCOMMANDLINEOPTION_H
7
8#include <QtCore/qstringlist.h>
9#include <QtCore/qshareddata.h>
10
11QT_REQUIRE_CONFIG(commandlineparser);
12
14
16
17class Q_CORE_EXPORT QCommandLineOption
18{
19public:
20 enum Flag {
21 HiddenFromHelp = 0x1,
22 ShortOptionStyle = 0x2
23 };
25
26 explicit QCommandLineOption(const QString &name);
27 explicit QCommandLineOption(const QStringList &names);
28 /*implicit*/ QCommandLineOption(const QString &name, const QString &description,
29 const QString &valueName = QString(),
30 const QString &defaultValue = QString());
31 /*implicit*/ QCommandLineOption(const QStringList &names, const QString &description,
32 const QString &valueName = QString(),
33 const QString &defaultValue = QString());
35
37
39 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QCommandLineOption)
40
42 { d.swap(other.d); }
43
44 QStringList names() const;
45
46 void setValueName(const QString &name);
47 QString valueName() const;
48
49 void setDescription(const QString &description);
50 QString description() const;
51
52 void setDefaultValue(const QString &defaultValue);
53 void setDefaultValues(const QStringList &defaultValues);
54 QStringList defaultValues() const;
55
56 Flags flags() const;
57 void setFlags(Flags aflags);
58
59private:
60 QSharedDataPointer<QCommandLineOptionPrivate> d;
61};
62
63Q_DECLARE_SHARED(QCommandLineOption)
64Q_DECLARE_OPERATORS_FOR_FLAGS(QCommandLineOption::Flags)
65
66
68
69#endif // QCOMMANDLINEOPTION_H
The QCommandLineOption class defines a possible command-line option. \inmodule QtCore.
Flag
\value HiddenFromHelp Hide this option in the user-visible help output.
\inmodule QtCore
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:129
Combined button and popup list for selecting options.
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
Definition qflags.h:194
Flags
GLbitfield flags
GLuint name
GLuint GLuint * names
#define QT_REQUIRE_CONFIG(feature)
QSharedPointer< T > other(t)
[5]
this swap(other)