Module qtjambi

Package io.qt.core

Class QCommandLineParser

java.lang.Object

io.qt.QtObject

io.qt.core.QCommandLineParser

All Implemented Interfaces:

QtObjectInterface

public class QCommandLineParser
extends QtObject

Means for handling the command line options

Java wrapper for Qt class QCommandLineParser

Since:

This class was introduced in Qt 5.2.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QCommandLineParser.OptionsAfterPositionalArgumentsMode	Java wrapper for Qt enum QCommandLineParser::OptionsAfterPositionalArgumentsMode
static enum	QCommandLineParser.SingleDashWordOptionMode	Java wrapper for Qt enum QCommandLineParser::SingleDashWordOptionMode

Constructor Summary

Constructors

Constructor	Description
QCommandLineParser()	See QCommandLineParser::QCommandLineParser()

Method Summary

Modifier and Type	Method	Description
final QCommandLineOption	addHelpOption()	See QCommandLineParser::addHelpOption()
final boolean	addOption(QCommandLineOption commandLineOption)	See QCommandLineParser::addOption(QCommandLineOption)
final boolean	addOptions(Collection<? extends QCommandLineOption> options)	See QCommandLineParser::addOptions(QList<QCommandLineOption>)
final void	addPositionalArgument(String name, String description)	Overloaded function for addPositionalArgument(java.lang.String, java.lang.String, java.lang.String) with syntax = (String)null.
final void	addPositionalArgument(String name, String description, String syntax)	See QCommandLineParser::addPositionalArgument(QString,QString,QString)
final QCommandLineOption	addVersionOption()	See QCommandLineParser::addVersionOption()
final String	applicationDescription()	See QCommandLineParser::applicationDescription()const
final void	clearPositionalArguments()	See QCommandLineParser::clearPositionalArguments()
final String	errorText()	See QCommandLineParser::errorText()const
final String	helpText()	See QCommandLineParser::helpText()const
final boolean	isSet(QCommandLineOption option)	See QCommandLineParser::isSet(QCommandLineOption)const
final boolean	isSet(String name)	See QCommandLineParser::isSet(QString)const
final QStringList	optionNames()	See QCommandLineParser::optionNames()const
final boolean	parse(Collection<String> arguments)	See QCommandLineParser::parse(QStringList)
final QStringList	positionalArguments()	See QCommandLineParser::positionalArguments()const
final void	process(QCoreApplication app)	See QCommandLineParser::process(QCoreApplication)
final void	process(Collection<String> arguments)	See QCommandLineParser::process(QStringList)
final void	setApplicationDescription(String description)	See QCommandLineParser::setApplicationDescription(QString)
final void	setOptionsAfterPositionalArgumentsMode(QCommandLineParser.OptionsAfterPositionalArgumentsMode mode)	See QCommandLineParser::setOptionsAfterPositionalArgumentsMode(QCommandLineParser::OptionsAfterPositionalArgumentsMode)
final void	setSingleDashWordOptionMode(QCommandLineParser.SingleDashWordOptionMode parsingMode)	See QCommandLineParser::setSingleDashWordOptionMode(QCommandLineParser::SingleDashWordOptionMode)
final void	showHelp()	Overloaded function for showHelp(int) with exitCode = 0.
final void	showHelp(int exitCode)	See QCommandLineParser::showHelp(int)
final void	showVersion()	See QCommandLineParser::showVersion()
final QStringList	unknownOptionNames()	See QCommandLineParser::unknownOptionNames()const
final String	value(QCommandLineOption option)	See QCommandLineParser::value(QCommandLineOption)const
final String	value(String name)	See QCommandLineParser::value(QString)const
final QStringList	values(QCommandLineOption option)	See QCommandLineParser::values(QCommandLineOption)const
final QStringList	values(String name)	See QCommandLineParser::values(QString)const

Methods inherited from class io.qt.QtObject

dispose, equals, isDisposed

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

QCommandLineParser

public QCommandLineParser()

See QCommandLineParser::QCommandLineParser()

Method Details

addHelpOption

@QtUninvokable
public final QCommandLineOption addHelpOption()

See QCommandLineParser::addHelpOption()

Returns:

addOption

@QtUninvokable
public final boolean addOption(QCommandLineOption commandLineOption)

See QCommandLineParser::addOption(QCommandLineOption)

Parameters:

commandLineOption -

Returns:

addOptions

@QtUninvokable
public final boolean addOptions(Collection<? extends QCommandLineOption> options)

See QCommandLineParser::addOptions(QList<QCommandLineOption>)

Parameters:

options -

Returns:

Since:

This function was introduced in Qt 5.4.

addPositionalArgument

@QtUninvokable
public final void addPositionalArgument(String name,
 String description,
 String syntax)

See QCommandLineParser::addPositionalArgument(QString,QString,QString)

Parameters:

name -

description -

syntax -

addVersionOption

@QtUninvokable
public final QCommandLineOption addVersionOption()

See QCommandLineParser::addVersionOption()

Returns:

applicationDescription

@QtUninvokable
public final String applicationDescription()

See QCommandLineParser::applicationDescription()const

Returns:

clearPositionalArguments

@QtUninvokable
public final void clearPositionalArguments()

See QCommandLineParser::clearPositionalArguments()

errorText

@QtUninvokable
public final String errorText()

See QCommandLineParser::errorText()const

Returns:

helpText

@QtUninvokable
public final String helpText()

See QCommandLineParser::helpText()const

Returns:

isSet

@QtUninvokable
public final boolean isSet(QCommandLineOption option)

See QCommandLineParser::isSet(QCommandLineOption)const

Parameters:

option -

Returns:

isSet

@QtUninvokable
public final boolean isSet(String name)

See QCommandLineParser::isSet(QString)const

Parameters:

name -

Returns:

optionNames

@QtUninvokable
public final QStringList optionNames()

See QCommandLineParser::optionNames()const

Returns:

parse

@QtUninvokable
public final boolean parse(Collection<String> arguments)

See QCommandLineParser::parse(QStringList)

Parameters:

arguments -

Returns:

positionalArguments

@QtUninvokable
public final QStringList positionalArguments()

See QCommandLineParser::positionalArguments()const

Returns:

process

@QtUninvokable
public final void process(QCoreApplication app)

See QCommandLineParser::process(QCoreApplication)

Parameters:

app -

process

@QtUninvokable
public final void process(Collection<String> arguments)

See QCommandLineParser::process(QStringList)

Parameters:

arguments -

setApplicationDescription

@QtUninvokable
public final void setApplicationDescription(String description)

See QCommandLineParser::setApplicationDescription(QString)

Parameters:

description -

setOptionsAfterPositionalArgumentsMode

@QtUninvokable
public final void setOptionsAfterPositionalArgumentsMode(QCommandLineParser.OptionsAfterPositionalArgumentsMode mode)

See QCommandLineParser::setOptionsAfterPositionalArgumentsMode(QCommandLineParser::OptionsAfterPositionalArgumentsMode)

Parameters:

mode -

Since:

This function was introduced in Qt 5.6.

setSingleDashWordOptionMode

@QtUninvokable
public final void setSingleDashWordOptionMode(QCommandLineParser.SingleDashWordOptionMode parsingMode)

See QCommandLineParser::setSingleDashWordOptionMode(QCommandLineParser::SingleDashWordOptionMode)

Parameters:

parsingMode -

showHelp

@QtUninvokable
public final void showHelp(int exitCode)

See QCommandLineParser::showHelp(int)

Parameters:

exitCode -

showVersion

@QtUninvokable
public final void showVersion()

See QCommandLineParser::showVersion()

Since:

This function was introduced in Qt 5.4.

unknownOptionNames

@QtUninvokable
public final QStringList unknownOptionNames()

See QCommandLineParser::unknownOptionNames()const

Returns:

value

@QtUninvokable
public final String value(QCommandLineOption option)

See QCommandLineParser::value(QCommandLineOption)const

Parameters:

option -

Returns:

value

@QtUninvokable
public final String value(String name)

See QCommandLineParser::value(QString)const

Parameters:

name -

Returns:

values

@QtUninvokable
public final QStringList values(QCommandLineOption option)

See QCommandLineParser::values(QCommandLineOption)const

Parameters:

option -

Returns:

values

@QtUninvokable
public final QStringList values(String name)

See QCommandLineParser::values(QString)const

Parameters:

name -

Returns:

addPositionalArgument

@QtUninvokable
public final void addPositionalArgument(String name,
 String description)

Overloaded function for addPositionalArgument(java.lang.String, java.lang.String, java.lang.String) with syntax = (String)null.

showHelp

@QtUninvokable
public final void showHelp()

Overloaded function for showHelp(int) with exitCode = 0.