.TH "KCmdLineOptions" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCmdLineOptions \- Structure that holds command line options.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kcmdlineargs.h>\fP
.PP
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "const char * \fBname\fP"
.br
.ti -1c
.RI "const char * \fBdescription\fP"
.br
.ti -1c
.RI "const char * \fBdef\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Structure that holds command line options. 

This class is intended to be used with the \fBKCmdLineArgs\fP class, which provides convenient and powerful command line argument parsing and handling functionality.
.PP
\fBSee also:\fP
.RS 4
\fBKCmdLineArgs\fP for additional usage information 
.RE
.PP

.PP
Definition at line 40 of file kcmdlineargs.h.
.SH "Member Data Documentation"
.PP 
.SS "const char* \fBKCmdLineOptions::name\fP"
.PP
The name of the argument as it should be called on the command line and appear in \fImyapp --help\fP. 
.PP
Note that if this option starts with 'no' that you will need to test for the name without the 'no' and the result will be the inverse of what is specified. i.e. if 'nofoo' is the name of the option and \fImyapp --nofoo\fP is called:
.PP
.PP
.nf
 KCmdLineArgs::parsedArgs()->isSet('foo'); // false
.fi
.PP
 
.PP
Definition at line 55 of file kcmdlineargs.h.
.PP
Referenced by KCmdLineArgs::usage().
.SS "const char* \fBKCmdLineOptions::description\fP"
.PP
The text description of the option as should appear in \fImyapp --help\fP. 
.PP
This value should be wrapped with I18N_NOOP(). 
.PP
Definition at line 60 of file kcmdlineargs.h.
.PP
Referenced by KCmdLineArgs::usage().
.SS "const char* \fBKCmdLineOptions::def\fP"
.PP
The default value for the option, if it is not specified on the command line. 
.PP
Definition at line 65 of file kcmdlineargs.h.
.PP
Referenced by KCmdLineArgs::usage().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
