//Auto-generated by kalyptus. DO NOT EDIT. package org.kde.koala; import org.kde.qt.Qt; import org.kde.qt.QtSupport; import org.kde.qt.TQDataStream; import java.util.ArrayList; /** KCmdLineArgs provides simple access to the command-line arguments for an application. It takes into account Qt-specific options, KDE-specific options and application specific options. This class is used in %main() via the static method init(). A typical %KDE application using %KCmdLineArgs should look like this:
int main(String[] args) { // Initialize command line args KCmdLineArgs.init(args, appName, programName, description, version); // Tell which options are supported KCmdLineArgs.addCmdLineOptions( options ); // Add options from other components KUniqueApplication.addCmdLineOptions(); .... // Create application object without passing 'argc' and 'argv' again. KUniqueApplication app; .... // Handle our own options/arguments // A KApplication will usually do this in main but this is not // necessary. // A KUniqueApplication might want to handle it in newInstance(). KCmdLineArgs args = KCmdLineArgs.parsedArgs(); // A binary option (on / off) if (args.isSet("some-option")) .... // An option which takes an additional argument String anotherOptionArg = args.getOption("another-option"); // Arguments (e.g. files to open) for(int i = 0; i < args.count(); i++) // Counting start at 0! { // don't forget to convert to Unicode! openFile( TQFile.decodeName( args.arg(i))); // Or more convenient: // openURL( args.url(i)); } args.clear(); // Free up some memory. .... }The options that an application supports are configured using the String[][] class. An example is shown below:
static String[][] options = { { "a", I18N_NOOP("A short binary option"), 0 }, { "b \The I18N_NOOP macro is used to indicate that these strings should be marked for translation. The actual translation is done by KCmdLineArgs. You can't use i18n() here because we are setting up a static data structure and can't do translations at compile time. Note that a program should define the options before any arguments. When a long option has a short option as an alias, a program should only test for the long option. With the above options a command line could look like:", I18N_NOOP("A short option which takes an argument"), 0 }, { "c \ ", I18N_NOOP("As above but with a default value"), "9600" }, { "option1", I18N_NOOP("A long binary option, off by default"), 0 }, { "nooption2", I18N_NOOP("A long binary option, on by default"), 0 }, { ":", I18N_NOOP("Extra options:"), 0 }, { "option3 \ ", I18N_NOOP("A long option which takes an argument"), 0 }, { "option4 \ ", I18N_NOOP("A long option which takes an argument, defaulting to 9600"), "9600" }, { "d", 0, 0 }, { "option5", I18N_NOOP("A long option which has a short option as alias"), 0 }, { "e", 0, 0 }, { "nooption6", I18N_NOOP("Another long option with an alias"), 0 }, { "f", 0, 0 }, { "option7 \ ", I18N_NOOP("'--option7 speed' is the same as '-f speed'"), 0 }, { "!option8 \ ", I18N_NOOP("All options following this one will be treated as arguments"), 0 }, { "+file", I18N_NOOP("A required argument 'file'"), 0 }, { "+[arg1]", I18N_NOOP("An optional argument 'arg1'"), 0 }, { "!+command", I18N_NOOP("A required argument 'command', that can contain multiple words, even starting with '-'"), 0 }, { "", I18N_NOOP("Additional help text not associated with any particular option") 0 }, // End of options. }
myapp -a -c 4800 --display localhost:0.0 --nooption5 -d /tmp/fileLong binary options can be in the form 'option' and 'nooption'. A command line may contain the same binary option multiple times, the last option determines the outcome:
myapp --nooption4 --option4 --nooption4is the same as:
myapp --nooption4If an option value is provided multiple times, normally only the last value is used:
myapp -c 1200 -c 2400 -c 4800is usually the same as:
myapp -c 4800However, an application can choose to use all values specified as well. As an example of this, consider that you may wish to specify a number of directories to use:
myapp -I /usr/include -I /opt/kde/include -I /usr/X11/includeWhen an application does this it should mention this in the description of the option. To access these options, use getOptionList() Tips for end-users:
{ "option \You cannot test for the presence of an alias - you must always test for the full option. @param option The name of the option without '-'. @return The value of the option. If the option was not present on the command line the default is returned. If the option was present more than the value of the last occurrence is used. @short Read out a string option. */ public native String getOption(String option); /** Read out all occurrences of a string option. The option must have a corresponding String[][] entry of the form:", I18N_NOOP("Description"), "default" }
{ "option \You cannot test for the presence of an alias - you must always test for the full option. @param option The name of the option, without '-' or '-no'. @return A list of all option values. If no option was present on the command line, an empty list is returned. @short Read out all occurrences of a string option. */ public native ArrayList getOptionList(String option); /** Read out a booleanean option or check for the presence of string option. @param option The name of the option without '-' or '-no'. @return The value of the option. It will be true if the option was specifically turned on in the command line, or if the option is turned on by default (in the String[][] list) and was not specifically turned off in the command line. Equivalently, it will be false if the option was specifically turned off in the command line, or if the option is turned off by default (in the KCmdLineOptions list) and was not specifically turned on in the command line. @short Read out a boolean option or check for the presence of string option. */ public native boolean isSet(String option); /** Read the number of arguments that aren't options (but, for example, filenames). @return The number of arguments that aren't options @short Read the number of arguments that aren't options (but, for example, filenames). */ public native int count(); /** Read out an argument. @param n The argument to read. 0 is the first argument. count()-1 is the last argument. @return A", I18N_NOOP("Description"), "default" }
const
char
* pointer to the n'th argument.
@short Read out an argument.
*/
public native String arg(int n);
/**
Read out an argument representing a URL.
The argument can be
main
(...).
@param _appname The untranslated name of your application. This should
match with argv
[0].
@param programName A program name string to be used for display
purposes. This string should be marked for
translation. Example: I18N_NOOP("KEdit")
@param _description A short description of what your application is about.
@param _version A version.
@param noKApp Set this true to not add commandline options for
TQApplication / KApplication
@short Initialize class.
*/
public static native void init(String[] _argv, String _appname, String programName, String _description, String _version, boolean noKApp);
public static native void init(String[] _argv, String _appname, String programName, String _description, String _version);
/**
Initialize class.
This function should be called as the very first thing in
your application. It uses KAboutData to replace some of the
arguments that would otherwise be required.
@param _argv As passed to main
(...).
@param about A KAboutData object describing your program.
@param noKApp Set this true to not add commandline options for
TQApplication / KApplication
@short Initialize class.
*/
public static native void init(String[] _argv, KAboutData about, boolean noKApp);
public static native void init(String[] _argv, KAboutData about);
/**
Initialize Class
This function should be called as the very first thing in your
application. This method will rarely be used, since it doesn't
provide any argument parsing. It does provide access to the
KAboutData information.
This method is exactly the same as calling
init(0,0, const KAboutData about, true).
@param about the about data.
\see KAboutData
@short Initialize Class
*/
public static native void init(KAboutData about);
/**
Add options to your application.
You must make sure that all possible options have been added before
any class uses the command line arguments.
The list of options should look like this:
static String[][] options = { { "option1 \", I18N_NOOP("Description 1"), "my_extra_arg" }, { "o", 0, 0 }, { "option2", I18N_NOOP("Description 2"), 0 }, { "nooption3", I18N_NOOP("Description 3"), 0 }, }
KCmdLineArgs args = KCmdLineArgs.parsedArgs(); if (args.count() == 0) KCmdLineArgs.usage(i18n("No file specified!"));
cmd = myapp [options] file options = (option) option = --option1 \Instead of "--option3" one may also use "-option3" Usage examples:| (-o | --option2 | --nooption2) | ( --option3 | --nooption3 )