qcommandlineparser.sip 2.87 KB
Newer Older
xuebingbing's avatar
xuebingbing committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
// qcommandlineparser.sip generated by MetaSIP
//
// This file is part of the QtCore Python extension module.
//
// Copyright (c) 2018 Riverbank Computing Limited <info@riverbankcomputing.com>
// 
// This file is part of PyQt5.
// 
// This file may be used under the terms of the GNU General Public License
// version 3.0 as published by the Free Software Foundation and appearing in
// the file LICENSE included in the packaging of this file.  Please review the
// following information to ensure the GNU General Public License version 3.0
// requirements will be met: http://www.gnu.org/copyleft/gpl.html.
// 
// If you do not wish to use this file under the terms of the GPL version 3.0
// then you may purchase a commercial license.  For more information contact
// info@riverbankcomputing.com.
// 
// This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
// WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.


%If (Qt_5_2_0 -)

class QCommandLineParser
{
%TypeHeaderCode
#include <qcommandlineparser.h>
%End

public:
    QCommandLineParser();
    ~QCommandLineParser();

    enum SingleDashWordOptionMode
    {
        ParseAsCompactedShortOptions,
        ParseAsLongOptions,
    };

    void setSingleDashWordOptionMode(QCommandLineParser::SingleDashWordOptionMode parsingMode);
    bool addOption(const QCommandLineOption &commandLineOption);
    QCommandLineOption addVersionOption();
    QCommandLineOption addHelpOption();
    void setApplicationDescription(const QString &description);
    QString applicationDescription() const;
    void addPositionalArgument(const QString &name, const QString &description, const QString &syntax = QString());
    void clearPositionalArguments();
    void process(const QStringList &arguments) /ReleaseGIL/;
    void process(const QCoreApplication &app) /ReleaseGIL/;
    bool parse(const QStringList &arguments);
    QString errorText() const;
    bool isSet(const QString &name) const;
    QString value(const QString &name) const;
    QStringList values(const QString &name) const;
    bool isSet(const QCommandLineOption &option) const;
    QString value(const QCommandLineOption &option) const;
    QStringList values(const QCommandLineOption &option) const;
    QStringList positionalArguments() const;
    QStringList optionNames() const;
    QStringList unknownOptionNames() const;
    void showHelp(int exitCode = 0) /ReleaseGIL/;
    QString helpText() const;
%If (Qt_5_4_0 -)
    bool addOptions(const QList<QCommandLineOption> &options);
%End
%If (Qt_5_4_0 -)
    void showVersion();
%End
%If (Qt_5_6_0 -)

    enum OptionsAfterPositionalArgumentsMode
    {
        ParseAsOptions,
        ParseAsPositionalArguments,
    };

%End
%If (Qt_5_6_0 -)
    void setOptionsAfterPositionalArgumentsMode(QCommandLineParser::OptionsAfterPositionalArgumentsMode mode);
%End

private:
    QCommandLineParser(const QCommandLineParser &);
};

%End