QCommandLineOption Class

メンバ関数のドキュメント

[explicit] QCommandLineOption::QCommandLineOption(const QString &name)

name という名前のコマンドラインオプションオブジェクトを作成します。

名前は短縮形または完全形のいずれでもよい。名前が 1 文字の場合は、短縮名とみなされる。オプション名は空にしてはならず、ダッシュやスラッシュで始まってはならず、= を含んではならず、重複してはならない。

setDescription()、setValueName()、およびsetDefaultValues()も参照してください 。

[explicit] QCommandLineOption::QCommandLineOption(const QStringList &names)

names という名前のコマンドラインオプションオブジェクトを作成します。

このオーバーロードにより、オプションに複数の名前（例：o やoutput ）を設定できます。

名前は「短名」または「長名」のいずれかです。リスト内の名前で長さが 1 文字のものはすべて短名となります。オプション名は空であってはならず、ダッシュやスラッシュで始まってはならず、= を含んではならず、重複してはなりません。

setDescription()、setValueName()、およびsetDefaultValues()も参照してください 。

QCommandLineOption::QCommandLineOption(const QString &name, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

指定された引数を使用して、コマンドラインオプションオブジェクトを作成します。

オプション名は `name` に設定されます。名前は短縮形または完全形のいずれかです。名前が 1 文字の場合は、短縮名とみなされます。オプション名は空にしてはならず、ダッシュやスラッシュで始まってはならず、= を含んではならず、重複してはなりません。

説明はdescription に設定されます。説明の末尾に「.」を付けるのが慣例です。

さらに、オプションが値を期待する場合は、valueName を設定する必要があります。オプションのデフォルト値はdefaultValue に設定されます。

Qt 5.4 以前のバージョンでは、このコンストラクタは `explicit` でした。Qt 5.4 以降では、これではなくなり、統一的な初期化に使用できるようになりました:

QCommandLineParser parser;
parser.addOption({"verbose", "Verbose mode. Prints out more information."});

setDescription()、setValueName()、およびsetDefaultValues()も参照してください 。

QCommandLineOption::QCommandLineOption(const QStringList &names, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

指定された引数を使用して、コマンドラインオプションオブジェクトを作成します。

このオーバーロードにより、オプションに複数の名前を設定できます。例えば、o やoutput などです。

オプション名はnames に設定されます。名前は短縮形でも完全形でも構いません。リスト内の名前で長さが 1 文字のものはすべて短縮形です。オプション名は空にしてはならず、ダッシュやスラッシュで始まってはならず、= を含んではならず、重複してはなりません。

説明はdescription に設定されます。説明の末尾に「.」を付けるのが慣例となっています。

さらに、オプションが値を期待する場合は、valueName を設定する必要があります。オプションのデフォルト値はdefaultValue に設定されます。

Qt 5.4 以前のバージョンでは、このコンストラクタはexplicit でした。Qt 5.4 以降では、これではなくなり、統一的な初期化に使用できるようになりました:

QCommandLineParser parser;
parser.addOption({{"o", "output"}, "Write generated data into <file>.", "file"});

setDescription()、setValueName()、およびsetDefaultValues()も参照してください 。

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

other という QCommandLineOption オブジェクトのコピーとなる QCommandLineOption オブジェクトを生成します。

operator=()も参照してください 。

[noexcept] QCommandLineOption::~QCommandLineOption()

コマンドラインオプションオブジェクトを破棄します。

QStringList QCommandLineOption::defaultValues() const

このオプションに設定されているデフォルト値を返します。

setDefaultValues()も参照してください 。

QString QCommandLineOption::description() const

このオプションに設定されている説明を返します。

setDescription()も参照してください 。

QCommandLineOption::Flags QCommandLineOption::flags() const

このコマンドラインオプションに影響を与えるフラグのセットを返します。

setFlags() およびQCommandLineOption::Flagsも参照してください 。

QStringList QCommandLineOption::names() const

このオプションに設定されている名前を返します。

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

このオプションのデフォルト値を「defaultValue 」に設定します。

アプリケーションのユーザーがコマンドラインでこのオプションを指定しなかった場合、このデフォルト値が使用されます。

defaultValue が空の場合、このオプションにはデフォルト値がありません。

defaultValues() およびsetDefaultValues()も参照してください 。

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

このオプションに使用されるデフォルト値のリストを `defaultValues` に設定します。

アプリケーションのユーザーがコマンドラインでこのオプションを指定しなかった場合、デフォルト値が使用されます。

defaultValues() およびsetDefaultValue()も参照してください 。

void QCommandLineOption::setDescription(const QString &description)

このオプションに使用される説明を「description 」に設定します。

説明文の末尾に「.」を付けるのが慣例となっています。

この説明文は、QCommandLineParser::showHelp() によって使用されます。

description()も参照してください 。

void QCommandLineOption::setFlags(QCommandLineOption::Flags flags)

このコマンドラインオプションに影響するフラグのセットを、flags に設定します。

flags() およびQCommandLineOption::Flagsも参照してください 。

void QCommandLineOption::setValueName(const QString &valueName)

ドキュメント用に、期待される値の名前を「valueName 」に設定します。

値が割り当てられていないオプションは、ブール値のような挙動を示します。つまり、ユーザーが –option を指定するか、指定しないかのどちらかです。

値が割り当てられたオプションでは、ヘルプ出力におけるオプションのドキュメント用に、期待される値の名前を設定する必要があります。名前が `o ` および `output` で、値名が `file ` であるオプションは、`-o, --output <file>` として表示されます。

オプションが 1 回のみ指定されることが予想される場合は `QCommandLineParser::value()` を、複数回指定されることが予想される場合は `QCommandLineParser::values()` を呼び出してください。

valueName()も参照してください 。

[noexcept] void QCommandLineOption::swap(QCommandLineOption &other)

このオプションを「other 」と入れ替えます。この操作は非常に高速で、失敗することはありません。

QString QCommandLineOption::valueName() const

期待される値の名前を返します。

空の場合、そのオプションは値を受け取りません。

setValueName()も参照してください 。

[noexcept] QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)

other をこのQCommandLineOption インスタンスに割り当てます。

QCommandLineOption &QCommandLineOption::operator=(const QCommandLineOption &other)

other オブジェクトのコピーを作成し、それをこのQCommandLineOption オブジェクトに割り当てます。