<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kdecore: KCmdLineArgs Class Reference (kdecore)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kdecore</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KCmdLineArgs Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KCmdLineArgs" -->
<p>A class for command-line argument handling.
<a href="classKCmdLineArgs.html#details">More...</a></p>
<p><code>#include <<a class="el" href="kcmdlineargs_8h_source.html">kcmdlineargs.h</a>></code></p>
<p><a href="classKCmdLineArgs-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qcstring.html">QCString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ac82aded6dcc1f9446c4c578d7116bc52">getOption</a> (const char *option) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qvaluelist.html">QCStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ae2d38b09a5729d15123f6a99ba22675a">getOptionList</a> (const char *option) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a4ed1605753de66b1c1d33b43ae99303f">isSet</a> (const char *option) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a9f1b8ca6c31221cafeaa138ee5188895">count</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ae3c2372b95f7c25d4a9b4cb507f31014">arg</a> (int n) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKURL.html">KURL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#afee77b07abb349f5f042b8157d272ba0">url</a> (int n) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a43c872b0c4c37aed1cba3be2603590b9">clear</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a6fc0ecc5385a924cdbe0e2e668e52517">init</a> (int _argc, char **_argv, const char *_appname, const char *programName, const char *_description, const char *_version, bool noKApp=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ac3267bcb4248969dbc1c6e0631e2da72">init</a> (int _argc, char **_argv, const char *_appname, const char *_description, const char *_version, bool noKApp=false) KDE_DEPRECATED</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a207e2cb85d9230dc742f50a0bab8f88c">init</a> (int _argc, char **_argv, const <a class="el" href="classKAboutData.html">KAboutData</a> *about, bool noKApp=false)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a61a0387bdaadfa85f30b2e112a982426">init</a> (const <a class="el" href="classKAboutData.html">KAboutData</a> *about)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#aa27bb279d3b0f958dcc249dd42b90ce1">addCmdLineOptions</a> (const <a class="el" href="structKCmdLineOptions.html">KCmdLineOptions</a> *options, const char *name=0, const char *id=0, const char *afterId=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKCmdLineArgs.html">KCmdLineArgs</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#acd1cd75c0ac04930b0acec605a42cc54">parsedArgs</a> (const char *id=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a5de15aae1292e79c1e05d5d079c5406e">cwd</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ade69c956977ab5e1879f65c6fba8485a">appName</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a9844bf641e4e74e6ce0fd226ba76c291">usage</a> (const char *id=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a9a4e9628cf58aa7b62b97bddd2e0a555">usage</a> (const <a class="elRef" href="qstring.html">QString</a> &error)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a4e272306f5bfbc7f56931e7e4351f163">enable_i18n</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKURL.html">KURL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a2848023684a3c5ff11e5dff8e64ad6e4">makeURL</a> (const char *urlArg)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a9b0caf1af2d6ebc85ae7ab6f5a5d5d7e">setCwd</a> (char *cwd)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a33186091167847be78e875f128788c05">reset</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#aee26d40daeae0a32ac3a334de2b1c8da">loadAppArgs</a> (<a class="elRef" href="qdatastream.html">QDataStream</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a386bfcf0a0cccd43c81fde3a0490b275">addTempFileOption</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a6308627fb82b11e3789017f3800472c1">isTempFileSet</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a06e692130820c68a4959e2698843b213">KCmdLineArgs</a> (const <a class="el" href="structKCmdLineOptions.html">KCmdLineOptions</a> *_options, const char *_name, const char *_id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a106c07e1a504ac01a49bd5a97bb33740">~KCmdLineArgs</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f437f9eaecf47a3f9db2c94fad91e69"></a><!-- doxytag: member="KCmdLineArgs::KApplication" ref="a4f437f9eaecf47a3f9db2c94fad91e69" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#a4f437f9eaecf47a3f9db2c94fad91e69">KApplication</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae776319ea858854b28a14d67b9e39dda"></a><!-- doxytag: member="KCmdLineArgs::KUniqueApplication" ref="ae776319ea858854b28a14d67b9e39dda" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ae776319ea858854b28a14d67b9e39dda">KUniqueApplication</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4cf7a5c5086a184c8c9e769e6949632"></a><!-- doxytag: member="KCmdLineArgs::QPtrList< KCmdLineArgs >" ref="ae4cf7a5c5086a184c8c9e769e6949632" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classKCmdLineArgs.html#ae4cf7a5c5086a184c8c9e769e6949632">QPtrList< KCmdLineArgs ></a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A class for command-line argument handling. </p>
<p><a class="el" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a> 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.</p>
<p>This class is used in main() via the static method <a class="el" href="classKCmdLineArgs.html#a6fc0ecc5385a924cdbe0e2e668e52517" title="Initialize class.">init()</a>.</p>
<p>A typical KDE application using KCmdLineArgs should look like this:</p>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> *argv[])
{
<span class="comment">// Initialize command line args</span>
<a class="code" href="classKCmdLineArgs.html#a6fc0ecc5385a924cdbe0e2e668e52517" title="Initialize class.">KCmdLineArgs::init</a>(argc, argv, <a class="code" href="classKCmdLineArgs.html#ade69c956977ab5e1879f65c6fba8485a" title="Get the appname according to argv[0].">appName</a>, programName, description, version);
<span class="comment">// Tell which options are supported</span>
<a class="code" href="classKCmdLineArgs.html#aa27bb279d3b0f958dcc249dd42b90ce1" title="Add options to your application.">KCmdLineArgs::addCmdLineOptions</a>( options );
<span class="comment">// Add options from other components</span>
<a class="code" href="classKCmdLineArgs.html#aa27bb279d3b0f958dcc249dd42b90ce1" title="Add options to your application.">KUniqueApplication::addCmdLineOptions</a>();
....
<span class="comment">// Create application object without passing 'argc' and 'argv' again.</span>
<a class="code" href="classKUniqueApplication.html" title="Maintains only a single instance of a running application at a time.">KUniqueApplication</a> app;
....
<span class="comment">// Handle our own options/arguments</span>
<span class="comment">// A KApplication will usually do this in main but this is not</span>
<span class="comment">// necessary.</span>
<span class="comment">// A KUniqueApplication might want to handle it in newInstance().</span>
<a class="code" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a> *args = <a class="code" href="classKCmdLineArgs.html#acd1cd75c0ac04930b0acec605a42cc54" title="Access parsed arguments.">KCmdLineArgs::parsedArgs</a>();
<span class="comment">// A binary option (on / off)</span>
<span class="keywordflow">if</span> (args-><a class="code" href="classKCmdLineArgs.html#a4ed1605753de66b1c1d33b43ae99303f" title="Read out a boolean option or check for the presence of string option.">isSet</a>(<span class="stringliteral">"some-option"</span>))
....
<span class="comment">// An option which takes an additional argument</span>
<a class="codeRef" href="qcstring.html">QCString</a> anotherOptionArg = args-><a class="code" href="classKCmdLineArgs.html#ac82aded6dcc1f9446c4c578d7116bc52" title="Read out a string option.">getOption</a>(<span class="stringliteral">"another-option"</span>);
<span class="comment">// Arguments (e.g. files to open)</span>
<span class="keywordflow">for</span>(<span class="keywordtype">int</span> i = 0; i < args-><a class="code" href="classKCmdLineArgs.html#a9f1b8ca6c31221cafeaa138ee5188895" title="Read the number of arguments that aren't options (but, for example, filenames).">count</a>(); i++) <span class="comment">// Counting start at 0!</span>
{
<span class="comment">// don't forget to convert to Unicode!</span>
openFile( <a class="codeRef" href="qfile.html#decodeName">QFile::decodeName</a>( args-><a class="code" href="classKCmdLineArgs.html#ae3c2372b95f7c25d4a9b4cb507f31014" title="Read out an argument.">arg</a>(i)));
<span class="comment">// Or more convenient:</span>
<span class="comment">// openURL( args->url(i));</span>
}
args-><a class="code" href="classKCmdLineArgs.html#a43c872b0c4c37aed1cba3be2603590b9" title="Clear all options and arguments.">clear</a>(); <span class="comment">// Free up some memory.</span>
....
}
</pre></div><p>The options that an application supports are configured using the <a class="el" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> class. An example is shown below:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> options[] =
{
{ <span class="stringliteral">"a"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A short binary option"</span>), 0 },
{ <span class="stringliteral">"b <file>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A short option which takes an argument"</span>), 0 },
{ <span class="stringliteral">"c <speed>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"As above but with a default value"</span>), <span class="stringliteral">"9600"</span> },
{ <span class="stringliteral">"option1"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A long binary option, off by default"</span>), 0 },
{ <span class="stringliteral">"nooption2"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A long binary option, on by default"</span>), 0 },
{ <span class="stringliteral">":"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Extra options:"</span>), 0 },
{ <span class="stringliteral">"option3 <file>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A long option which takes an argument"</span>), 0 },
{ <span class="stringliteral">"option4 <speed>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A long option which takes an argument, defaulting to 9600"</span>), <span class="stringliteral">"9600"</span> },
{ <span class="stringliteral">"d"</span>, 0, 0 },
{ <span class="stringliteral">"option5"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A long option which has a short option as alias"</span>), 0 },
{ <span class="stringliteral">"e"</span>, 0, 0 },
{ <span class="stringliteral">"nooption6"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Another long option with an alias"</span>), 0 },
{ <span class="stringliteral">"f"</span>, 0, 0 },
{ <span class="stringliteral">"option7 <speed>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"'--option7 speed' is the same as '-f speed'"</span>), 0 },
{ <span class="stringliteral">"!option8 <cmd>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"All options following this one will be treated as arguments"</span>), 0 },
{ <span class="stringliteral">"+file"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A required argument 'file'"</span>), 0 },
{ <span class="stringliteral">"+[arg1]"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"An optional argument 'arg1'"</span>), 0 },
{ <span class="stringliteral">"!+command"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"A required argument 'command', that can contain multiple words, even starting with '-'"</span>), 0 },
{ <span class="stringliteral">""</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Additional help text not associated with any particular option"</span>) 0 },
KCmdLineLastOption <span class="comment">// End of options.</span>
};
</pre></div><p>The I18N_NOOP macro is used to indicate that these strings should be marked for translation. The actual translation is done by <a class="el" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a>. You can't use <a class="el" href="classKLocale.html#a0eca0239d7b23eb40006d82d6210aa69">i18n()</a> here because we are setting up a static data structure and can't do translations at compile time.</p>
<p>Note that a program should define the options before any arguments.</p>
<p>When a long option has a short option as an alias, a program should only test for the long option.</p>
<p>With the above options a command line could look like: </p>
<div class="fragment"><pre class="fragment"> myapp -a -c 4800 --display localhost:0.0 --nooption5 -d /tmp/file
</pre></div><p>Long 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: </p>
<div class="fragment"><pre class="fragment"> myapp --nooption4 --option4 --nooption4
</pre></div><p> is the same as: </p>
<div class="fragment"><pre class="fragment"> myapp --nooption4
</pre></div><p>If an option value is provided multiple times, normally only the last value is used: </p>
<div class="fragment"><pre class="fragment"> myapp -c 1200 -c 2400 -c 4800
</pre></div><p> is usually the same as: </p>
<div class="fragment"><pre class="fragment"> myapp -c 4800
</pre></div><p>However, 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: </p>
<div class="fragment"><pre class="fragment"> myapp -I /usr/include -I /opt/kde/include -I /usr/X11/include
</pre></div><p> When an application does this it should mention this in the description of the option. To access these options, use <a class="el" href="classKCmdLineArgs.html#ae2d38b09a5729d15123f6a99ba22675a" title="Read out all occurrences of a string option.">getOptionList()</a></p>
<p>Tips for end-users:</p>
<ul>
<li>Single char options like "-a -b -c" may be combined into "-abc" </li>
<li>The option "--foo bar" may also be written "--foo=bar" </li>
<li>The option "-P lp1" may also be written "-P=lp1" or "-Plp1" </li>
<li>The option "--foo bar" may also be written "-foo bar"</li>
</ul>
<dl class="author"><dt><b>Author:</b></dt><dd>Waldo Bastian </dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd>0.0.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8h_source.html#l00222">222</a> of file <a class="el" href="kcmdlineargs_8h_source.html">kcmdlineargs.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a06e692130820c68a4959e2698843b213"></a><!-- doxytag: member="KCmdLineArgs::KCmdLineArgs" ref="a06e692130820c68a4959e2698843b213" args="(const KCmdLineOptions *_options, const char *_name, const char *_id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCmdLineArgs::KCmdLineArgs </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structKCmdLineOptions.html">KCmdLineOptions</a> * </td>
<td class="paramname"><em>_options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>The given arguments are assumed to be constants. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00989">989</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a106c07e1a504ac01a49bd5a97bb33740"></a><!-- doxytag: member="KCmdLineArgs::~KCmdLineArgs" ref="a106c07e1a504ac01a49bd5a97bb33740" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KCmdLineArgs::~KCmdLineArgs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01001">1001</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa27bb279d3b0f958dcc249dd42b90ce1"></a><!-- doxytag: member="KCmdLineArgs::addCmdLineOptions" ref="aa27bb279d3b0f958dcc249dd42b90ce1" args="(const KCmdLineOptions *options, const char *name=0, const char *id=0, const char *afterId=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::addCmdLineOptions </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structKCmdLineOptions.html">KCmdLineOptions</a> * </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>afterId</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add options to your application. </p>
<p>You must make sure that all possible options have been added before any class uses the command line arguments.</p>
<p>The list of options should look like this:</p>
<div class="fragment"><pre class="fragment"> <span class="keyword">static</span> <a class="code" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> options[] =
{
{ <span class="stringliteral">"option1 <argument>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Description 1"</span>), <span class="stringliteral">"my_extra_arg"</span> },
{ <span class="stringliteral">"o"</span>, 0, 0 },
{ <span class="stringliteral">"option2"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Description 2"</span>), 0 },
{ <span class="stringliteral">"nooption3"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Description 3"</span>), 0 },
KCmdLineLastOption
}
</pre></div><ul>
<li>"option1" is an option that requires an additional argument, but if one is not provided, it uses "my_extra_arg". </li>
<li>"option2" is an option that can be turned on. The default is off. </li>
<li>"option3" is an option that can be turned off. The default is on. </li>
<li>"o" does not have a description. It is an alias for the option that follows. In this case "option2". </li>
<li>"+file" specifies an argument. The '+' is removed. If your program doesn't specify that it can use arguments your program will abort when an argument is passed to it. Note that the reverse is not true. If required, you must check yourself the number of arguments specified by the user: <div class="fragment"><pre class="fragment"> <a class="code" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a> *args = <a class="code" href="classKCmdLineArgs.html#acd1cd75c0ac04930b0acec605a42cc54" title="Access parsed arguments.">KCmdLineArgs::parsedArgs</a>();
<span class="keywordflow">if</span> (args-><a class="code" href="classKCmdLineArgs.html#a9f1b8ca6c31221cafeaa138ee5188895" title="Read the number of arguments that aren't options (but, for example, filenames).">count</a>() == 0) <a class="code" href="classKCmdLineArgs.html#a9844bf641e4e74e6ce0fd226ba76c291" title="Print the usage help to stdout and exit.">KCmdLineArgs::usage</a>(i18n(<span class="stringliteral">"No file specified!"</span>));
</pre></div></li>
</ul>
<p>In BNF: </p>
<div class="fragment"><pre class="fragment"> cmd = myapp [options] file
options = (option)*
option = --option1 \<argument> |
(-o | --option2 | --nooption2) |
( --option3 | --nooption3 )
</pre></div><p>Instead of "--option3" one may also use "-option3"</p>
<p>Usage examples:</p>
<ul>
<li>"myapp --option1 test" </li>
<li>"myapp" (same as "myapp --option1 my_extra_arg") </li>
<li>"myapp --option2" </li>
<li>"myapp --nooption2" (same as "myapp", since it is off by default) </li>
<li>"myapp -o" (same as "myapp --option2") </li>
<li>"myapp --nooption3" </li>
<li>"myapp --option3 (same as "myapp", since it is on by default)
@li "myapp --option2 --nooption2" (same as "myapp", because it option2 is off by default, and the last usage applies) </li>
<li>"myapp /tmp/file"</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">options</td><td>A list of options that your code supplies. </td></tr>
<tr><td class="paramname">name</td><td>the name of the option, can be 0. </td></tr>
<tr><td class="paramname">id</td><td>A name with which these options can be identified, can be 0. </td></tr>
<tr><td class="paramname">afterId</td><td>The options are inserted after this set of options, can be 0. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00206">206</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a386bfcf0a0cccd43c81fde3a0490b275"></a><!-- doxytag: member="KCmdLineArgs::addTempFileOption" ref="a386bfcf0a0cccd43c81fde3a0490b275" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::addTempFileOption </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add standard option --tempfile. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01287">1287</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ade69c956977ab5e1879f65c6fba8485a"></a><!-- doxytag: member="KCmdLineArgs::appName" ref="ade69c956977ab5e1879f65c6fba8485a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * KCmdLineArgs::appName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the appname according to argv[0]. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the name of the application </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00199">199</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae3c2372b95f7c25d4a9b4cb507f31014"></a><!-- doxytag: member="KCmdLineArgs::arg" ref="ae3c2372b95f7c25d4a9b4cb507f31014" args="(int n) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * KCmdLineArgs::arg </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read out an argument. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The argument to read. 0 is the first argument. <a class="el" href="classKCmdLineArgs.html#a9f1b8ca6c31221cafeaa138ee5188895" title="Read the number of arguments that aren't options (but, for example, filenames).">count()</a>-1 is the last argument.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <code>const</code> <code>char</code> <code>*</code> pointer to the n'th argument. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01230">1230</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a43c872b0c4c37aed1cba3be2603590b9"></a><!-- doxytag: member="KCmdLineArgs::clear" ref="a43c872b0c4c37aed1cba3be2603590b9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clear all options and arguments. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01010">1010</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9f1b8ca6c31221cafeaa138ee5188895"></a><!-- doxytag: member="KCmdLineArgs::count" ref="a9f1b8ca6c31221cafeaa138ee5188895" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int KCmdLineArgs::count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read the number of arguments that aren't options (but, for example, filenames). </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of arguments that aren't options </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01222">1222</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5de15aae1292e79c1e05d5d079c5406e"></a><!-- doxytag: member="KCmdLineArgs::cwd" ref="a5de15aae1292e79c1e05d5d079c5406e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> KCmdLineArgs::cwd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the CWD (Current Working Directory) associated with the current command line arguments. </p>
<p>Typically this is needed in <a class="el" href="classKUniqueApplication.html#a6465cb42cbf9639ddf13a8296d95d2cf" title="Creates a new "instance" of the application.">KUniqueApplication::newInstance()</a> since the CWD of the process may be different from the CWD where the user started a second instance. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current working directory </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00194">194</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4e272306f5bfbc7f56931e7e4351f163"></a><!-- doxytag: member="KCmdLineArgs::enable_i18n" ref="a4e272306f5bfbc7f56931e7e4351f163" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::enable_i18n </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Enable i18n to be able to print a translated error message. </p>
<p>N.B.: This function leaks memory, therefore you are expected to exit afterwards (e.g., by calling <a class="el" href="classKCmdLineArgs.html#a9844bf641e4e74e6ce0fd226ba76c291" title="Print the usage help to stdout and exit.">usage()</a>). </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00743">743</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac82aded6dcc1f9446c4c578d7116bc52"></a><!-- doxytag: member="KCmdLineArgs::getOption" ref="ac82aded6dcc1f9446c4c578d7116bc52" args="(const char *option) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qcstring.html">QCString</a> KCmdLineArgs::getOption </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>option</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read out a string option. </p>
<p>The option must have a corresponding <a class="el" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> entry of the form: </p>
<div class="fragment"><pre class="fragment"> { <span class="stringliteral">"option <argument>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Description"</span>), <span class="stringliteral">"default"</span> }
</pre></div><p> You cannot test for the presence of an alias - you must always test for the full option.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">option</td><td>The name of the option without '-'.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>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. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01117">1117</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ae2d38b09a5729d15123f6a99ba22675a"></a><!-- doxytag: member="KCmdLineArgs::getOptionList" ref="ae2d38b09a5729d15123f6a99ba22675a" args="(const char *option) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qvaluelist.html">QCStringList</a> KCmdLineArgs::getOptionList </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>option</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read out all occurrences of a string option. </p>
<p>The option must have a corresponding <a class="el" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> entry of the form: </p>
<div class="fragment"><pre class="fragment"> { <span class="stringliteral">"option <argument>"</span>, <a class="code" href="klocale_8h.html#a7e252748294283c2db62bcf9ddbe8e35">I18N_NOOP</a>(<span class="stringliteral">"Description"</span>), <span class="stringliteral">"default"</span> }
</pre></div><p> You cannot test for the presence of an alias - you must always test for the full option.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">option</td><td>The name of the option, without '-' or '-no'.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A list of all option values. If no option was present on the command line, an empty list is returned. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01149">1149</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6fc0ecc5385a924cdbe0e2e668e52517"></a><!-- doxytag: member="KCmdLineArgs::init" ref="a6fc0ecc5385a924cdbe0e2e668e52517" args="(int _argc, char **_argv, const char *_appname, const char *programName, const char *_description, const char *_version, bool noKApp=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::init </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>_argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>_argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_appname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>programName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>noKApp</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize class. </p>
<p>This function should be called as the very first thing in your application. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">_argc</td><td>As passed to <code>main</code>(...). </td></tr>
<tr><td class="paramname">_argv</td><td>As passed to <code>main</code>(...). </td></tr>
<tr><td class="paramname">_appname</td><td>The untranslated name of your application. This should match with <code>argv</code>[0]. </td></tr>
<tr><td class="paramname">programName</td><td>A program name string to be used for display purposes. This string should be marked for translation. Example: I18N_NOOP("KEdit") </td></tr>
<tr><td class="paramname">_description</td><td>A short description of what your application is about. </td></tr>
<tr><td class="paramname">_version</td><td>A version. </td></tr>
<tr><td class="paramname">noKApp</td><td>Set this true to not add commandline options for <a class="elRef" href="qapplication.html">QApplication</a> / <a class="el" href="classKApplication.html" title="Controls and provides information to all KDE applications.">KApplication</a></td></tr>
</table>
</dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00127">127</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a61a0387bdaadfa85f30b2e112a982426"></a><!-- doxytag: member="KCmdLineArgs::init" ref="a61a0387bdaadfa85f30b2e112a982426" args="(const KAboutData *about)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::init </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKAboutData.html">KAboutData</a> * </td>
<td class="paramname"><em>about</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize Class. </p>
<p>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 <a class="el" href="classKAboutData.html" title="This class is used to store information about a program.">KAboutData</a> information. This method is exactly the same as calling init(0,0, const KAboutData *about, true).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">about</td><td>the about data. </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classKAboutData.html" title="This class is used to store information about a program.">KAboutData</a> </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00153">153</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac3267bcb4248969dbc1c6e0631e2da72"></a><!-- doxytag: member="KCmdLineArgs::init" ref="ac3267bcb4248969dbc1c6e0631e2da72" args="(int _argc, char **_argv, const char *_appname, const char *_description, const char *_version, bool noKApp=false) KDE_DEPRECATED" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::init </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>_argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>_argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_appname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>_version</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>noKApp</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated:</a></b></dt><dd>You should convert any calls to this method to use the one above, by adding in the program name to be used for display purposes.</dd></dl>
<p>Do not forget to mark it for translation using I18N_NOOP. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00136">136</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a207e2cb85d9230dc742f50a0bab8f88c"></a><!-- doxytag: member="KCmdLineArgs::init" ref="a207e2cb85d9230dc742f50a0bab8f88c" args="(int _argc, char **_argv, const KAboutData *about, bool noKApp=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::init </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>_argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>_argv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classKAboutData.html">KAboutData</a> * </td>
<td class="paramname"><em>about</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>noKApp</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize class. </p>
<p>This function should be called as the very first thing in your application. It uses <a class="el" href="classKAboutData.html" title="This class is used to store information about a program.">KAboutData</a> to replace some of the arguments that would otherwise be required.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">_argc</td><td>As passed to <code>main</code>(...). </td></tr>
<tr><td class="paramname">_argv</td><td>As passed to <code>main</code>(...). </td></tr>
<tr><td class="paramname">about</td><td>A <a class="el" href="classKAboutData.html" title="This class is used to store information about a program.">KAboutData</a> object describing your program. </td></tr>
<tr><td class="paramname">noKApp</td><td>Set this true to not add commandline options for <a class="elRef" href="qapplication.html">QApplication</a> / <a class="el" href="classKApplication.html" title="Controls and provides information to all KDE applications.">KApplication</a> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00162">162</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a4ed1605753de66b1c1d33b43ae99303f"></a><!-- doxytag: member="KCmdLineArgs::isSet" ref="a4ed1605753de66b1c1d33b43ae99303f" args="(const char *option) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KCmdLineArgs::isSet </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>option</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read out a boolean option or check for the presence of string option. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">option</td><td>The name of the option without '-' or '-no'.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>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 <a class="el" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> 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 <a class="el" href="structKCmdLineOptions.html" title="Structure that holds command line options.">KCmdLineOptions</a> list) and was not specifically turned on in the command line. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01179">1179</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6308627fb82b11e3789017f3800472c1"></a><!-- doxytag: member="KCmdLineArgs::isTempFileSet" ref="a6308627fb82b11e3789017f3800472c1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KCmdLineArgs::isTempFileSet </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if --tempfile was set </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.4 </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01292">1292</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aee26d40daeae0a32ac3a334de2b1c8da"></a><!-- doxytag: member="KCmdLineArgs::loadAppArgs" ref="aee26d40daeae0a32ac3a334de2b1c8da" args="(QDataStream &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::loadAppArgs </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qdatastream.html">QDataStream</a> & </td>
<td class="paramname"><em>ds</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load arguments from a stream. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00264">264</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2848023684a3c5ff11e5dff8e64ad6e4"></a><!-- doxytag: member="KCmdLineArgs::makeURL" ref="a2848023684a3c5ff11e5dff8e64ad6e4" args="(const char *urlArg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKURL.html">KURL</a> KCmdLineArgs::makeURL </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>urlArg</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used by <a class="el" href="classKCmdLineArgs.html#afee77b07abb349f5f042b8157d272ba0" title="Read out an argument representing a URL.">url()</a>. </p>
<p>Made public for apps that don't use <a class="el" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a> </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">urlArg</td><td>the argument </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the url. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01251">1251</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="acd1cd75c0ac04930b0acec605a42cc54"></a><!-- doxytag: member="KCmdLineArgs::parsedArgs" ref="acd1cd75c0ac04930b0acec605a42cc54" args="(const char *id=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKCmdLineArgs.html">KCmdLineArgs</a> * KCmdLineArgs::parsedArgs </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> = <code>0</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Access parsed arguments. </p>
<p>This function returns all command line arguments that your code handles. If unknown command-line arguments are encountered the program is aborted and usage information is shown.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The name of the options you are interested in, can be 0. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00310">310</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a33186091167847be78e875f128788c05"></a><!-- doxytag: member="KCmdLineArgs::reset" ref="a33186091167847be78e875f128788c05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset all option definitions, i.e. </p>
<p>cancel all addCmdLineOptions calls. Note that KApplication's options are removed too, you might want to call <a class="el" href="classKApplication.html#ae79b9bdc2652ea9b71e8dcad443fa215" title="Add Qt and KDE command line options to KCmdLineArgs.">KApplication::addCmdLineOptions</a> if you want them back.</p>
<p>You usually don't want to call this method. </p>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01019">1019</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9b0caf1af2d6ebc85ae7ab6f5a5d5d7e"></a><!-- doxytag: member="KCmdLineArgs::setCwd" ref="a9b0caf1af2d6ebc85ae7ab6f5a5d5d7e" args="(char *cwd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void KCmdLineArgs::setCwd </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>cwd</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Made public for apps that don't use <a class="el" href="classKCmdLineArgs.html" title="A class for command-line argument handling.">KCmdLineArgs</a> To be done before makeURL, to set the current working directory in case makeURL needs it. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cwd</td><td>the new working directory </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8h_source.html#l00516">516</a> of file <a class="el" href="kcmdlineargs_8h_source.html">kcmdlineargs.h</a>.</p>
</div>
</div>
<a class="anchor" id="afee77b07abb349f5f042b8157d272ba0"></a><!-- doxytag: member="KCmdLineArgs::url" ref="afee77b07abb349f5f042b8157d272ba0" args="(int n) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKURL.html">KURL</a> KCmdLineArgs::url </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>n</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Read out an argument representing a URL. </p>
<p>The argument can be </p>
<ul>
<li>an absolute filename </li>
<li>a relative filename </li>
<li>a URL</li>
</ul>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">n</td><td>The argument to read. 0 is the first argument. <a class="el" href="classKCmdLineArgs.html#a9f1b8ca6c31221cafeaa138ee5188895" title="Read the number of arguments that aren't options (but, for example, filenames).">count()</a>-1 is the last argument.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a URL representing the n'th argument. </dd></dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l01246">1246</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9844bf641e4e74e6ce0fd226ba76c291"></a><!-- doxytag: member="KCmdLineArgs::usage" ref="a9844bf641e4e74e6ce0fd226ba76c291" args="(const char *id=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::usage </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>id</em> = <code>0</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print the usage help to stdout and exit. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>if 0, print all options. If id is set, only print the option specified by id. The id is the value set by <a class="el" href="classKCmdLineArgs.html#aa27bb279d3b0f958dcc249dd42b90ce1" title="Add options to your application.">addCmdLineOptions()</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00772">772</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9a4e9628cf58aa7b62b97bddd2e0a555"></a><!-- doxytag: member="KCmdLineArgs::usage" ref="a9a4e9628cf58aa7b62b97bddd2e0a555" args="(const QString &error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KCmdLineArgs::usage </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>error</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print an error to stderr and the usage help to stdout and exit. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">error</td><td>the error to print </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="kcmdlineargs_8cpp_source.html#l00757">757</a> of file <a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kcmdlineargs_8h_source.html">kcmdlineargs.h</a></li>
<li><a class="el" href="kcmdlineargs_8cpp_source.html">kcmdlineargs.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kdecore</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="modules.html">Modules</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classKAboutData.html">kaboutdata</option>, <option value="classKAboutPerson.html">kaboutperson</option>, <option value="classKAboutTranslator.html">kabouttranslator</option>, <option value="classKAccel.html">kaccel</option>, <option value="classKAcceleratorManager.html">kacceleratormanager</option>, <option value="classKAccelManagerAlgorithm.html">kaccelmanageralgorithm</option>, <option value="classKAccelShortcutList.html">kaccelshortcutlist</option>, <option value="classKAccelString.html">kaccelstring</option>, <option value="classKAddressInfo.html">kaddressinfo</option>, <option value="classKAppDCOPInterface.html">kappdcopinterface</option>, <option value="classKApplication.html">kapplication</option>, <option value="classKAsyncIO.html">kasyncio</option>, <option value="classKAudioPlayer.html">kaudioplayer</option>, <option value="classKBufferedIO.html">kbufferedio</option>, <option value="classKCalendarSystem.html">kcalendarsystem</option>, <option value="classKCalendarSystemFactory.html">kcalendarsystemfactory</option>, <option value="classKCalendarSystemJalali.html">kcalendarsystemjalali</option>, <option value="classKCatalogue.html">kcatalogue</option>, <option value="classKCharMacroExpander.html">kcharmacroexpander</option>, <option value="classKCharsets.html">kcharsets</option>, <option value="classKClipboardSynchronizer.html">kclipboardsynchronizer</option>, <option value="classKCmdLineArgs.html">kcmdlineargs</option>, <option value="classKCodecs.html">kcodecs</option>, <option value="classKCompletion.html">kcompletion</option>, <option value="classKCompletionBase.html">kcompletionbase</option>, <option value="classKCompletionMatches.html">kcompletionmatches</option>, <option value="classKCompTreeNode.html">kcomptreenode</option>, <option value="classKConfig.html">kconfig</option>, <option value="classKConfigBackEnd.html">kconfigbackend</option>, <option value="classKConfigBase.html">kconfigbase</option>, <option value="classKConfigDialogManager.html">kconfigdialogmanager</option>, <option value="classKConfigGroup.html">kconfiggroup</option>, <option value="classKConfigGroupSaver.html">kconfiggroupsaver</option>, <option value="classKConfigINIBackEnd.html">kconfiginibackend</option>, <option value="classKConfigSkeleton.html">kconfigskeleton</option>, <option value="classKConfigSkeleton_1_1ItemBool.html">kconfigskeleton::itembool</option>, <option value="classKConfigSkeleton_1_1ItemColor.html">kconfigskeleton::itemcolor</option>, <option value="classKConfigSkeleton_1_1ItemDateTime.html">kconfigskeleton::itemdatetime</option>, <option value="classKConfigSkeleton_1_1ItemDouble.html">kconfigskeleton::itemdouble</option>, <option value="classKConfigSkeleton_1_1ItemEnum.html">kconfigskeleton::itemenum</option>, <option value="classKConfigSkeleton_1_1ItemFont.html">kconfigskeleton::itemfont</option>, <option value="classKConfigSkeleton_1_1ItemInt.html">kconfigskeleton::itemint</option>, <option value="classKConfigSkeleton_1_1ItemInt64.html">kconfigskeleton::itemint64</option>, <option value="classKConfigSkeleton_1_1ItemIntList.html">kconfigskeleton::itemintlist</option>, <option value="classKConfigSkeleton_1_1ItemLong.html">kconfigskeleton::itemlong</option>, <option value="classKConfigSkeleton_1_1ItemPassword.html">kconfigskeleton::itempassword</option>, <option value="classKConfigSkeleton_1_1ItemPath.html">kconfigskeleton::itempath</option>, <option value="classKConfigSkeleton_1_1ItemPathList.html">kconfigskeleton::itempathlist</option>, <option value="classKConfigSkeleton_1_1ItemPoint.html">kconfigskeleton::itempoint</option>, <option value="classKConfigSkeleton_1_1ItemProperty.html">kconfigskeleton::itemproperty</option>, <option value="classKConfigSkeleton_1_1ItemRect.html">kconfigskeleton::itemrect</option>, <option value="classKConfigSkeleton_1_1ItemSize.html">kconfigskeleton::itemsize</option>, <option value="classKConfigSkeleton_1_1ItemString.html">kconfigskeleton::itemstring</option>, <option value="classKConfigSkeleton_1_1ItemStringList.html">kconfigskeleton::itemstringlist</option>, <option value="classKConfigSkeleton_1_1ItemUInt.html">kconfigskeleton::itemuint</option>, <option value="classKConfigSkeleton_1_1ItemUInt64.html">kconfigskeleton::itemuint64</option>, <option value="classKConfigSkeleton_1_1ItemULong.html">kconfigskeleton::itemulong</option>, <option value="classKConfigSkeletonItem.html">kconfigskeletonitem</option>, <option value="classKCrash.html">kcrash</option>, <option value="classKDCOPPropertyProxy.html">kdcoppropertyproxy</option>, <option value="classKDebugDCOPIface.html">kdebugdcopiface</option>, <option value="classKDesktopFile.html">kdesktopfile</option>, <option value="classKExtendedSocket.html">kextendedsocket</option>, <option value="classKGenericFactory.html">kgenericfactory</option>, <option value="classKGenericFactory_3_01KTypeList_3_01Product_00_01ProductListTail_01_4_00_01KTypeList_3_01Pare1ed8d1e5a9847c99711cad3b12c7e96c.html">kgenericfactory< ktypelist< product, productlisttail >, ktypelist< pare1ed8d1e5a9847c99711cad3b12c7e96c</option>, <option value="classKGenericFactory_3_01KTypeList_3_01Product_00_01ProductListTail_01_4_00_01KTypeList_3_01Paref6a00f76851e0daa2cb662bb8a41fc7f.html">kgenericfactory< ktypelist< product, productlisttail >, ktypelist< paref6a00f76851e0daa2cb662bb8a41fc7f</option>, <option value="classKGenericFactory_3_01KTypeList_3_01Product_00_01ProductListTail_01_4_00_01QObject_01_4.html">kgenericfactory< ktypelist< product, productlisttail >, qobject ></option>, <option value="classKGlobal.html">kglobal</option>, <option value="classKGlobalAccel.html">kglobalaccel</option>, <option value="classKGlobalSettings.html">kglobalsettings</option>, <option value="classKIcon.html">kicon</option>, <option value="classKIconEffect.html">kiconeffect</option>, <option value="classKIconLoader.html">kiconloader</option>, <option value="classKIconTheme.html">kicontheme</option>, <option value="classKInetSocketAddress.html">kinetsocketaddress</option>, <option value="classKInstance.html">kinstance</option>, <option value="classKIOBufferBase.html">kiobufferbase</option>, <option value="classKIPC.html">kipc</option>, <option value="classKKey.html">kkey</option>, <option value="classKKeyNative.html">kkeynative</option>, <option value="classKKeySequence.html">kkeysequence</option>, <option value="classKLibFactory.html">klibfactory</option>, <option value="classKLibLoader.html">klibloader</option>, <option value="classKLibrary.html">klibrary</option>, <option value="classKLocale.html">klocale</option>, <option value="classKLockFile.html">klockfile</option>, <option value="classKMacroExpanderBase.html">kmacroexpanderbase</option>, <option value="classKMD4.html">kmd4</option>, <option value="classKMD5.html">kmd5</option>, <option value="classKMimeSourceFactory.html">kmimesourcefactory</option>, <option value="classKMountPoint.html">kmountpoint</option>, <option value="classKMultipleDrag.html">kmultipledrag</option>, <option value="classKNetwork_1_1KActiveSocketBase.html">knetwork::kactivesocketbase</option>, <option value="classKNetwork_1_1KBufferedSocket.html">knetwork::kbufferedsocket</option>, <option value="classKNetwork_1_1KClientSocketBase.html">knetwork::kclientsocketbase</option>, <option value="classKNetwork_1_1KDatagramPacket.html">knetwork::kdatagrampacket</option>, <option value="classKNetwork_1_1KDatagramSocket.html">knetwork::kdatagramsocket</option>, <option value="classKNetwork_1_1KHttpProxySocketDevice.html">knetwork::khttpproxysocketdevice</option>, <option value="classKNetwork_1_1KInetSocketAddress.html">knetwork::kinetsocketaddress</option>, <option value="classKNetwork_1_1KIpAddress.html">knetwork::kipaddress</option>, <option value="classKNetwork_1_1KMulticastSocket.html">knetwork::kmulticastsocket</option>, <option value="classKNetwork_1_1KMulticastSocketImpl.html">knetwork::kmulticastsocketimpl</option>, <option value="classKNetwork_1_1KNetworkInterface.html">knetwork::knetworkinterface</option>, <option value="classKNetwork_1_1KPassiveSocketBase.html">knetwork::kpassivesocketbase</option>, <option value="classKNetwork_1_1KResolver.html">knetwork::kresolver</option>, <option value="classKNetwork_1_1KResolverEntry.html">knetwork::kresolverentry</option>, <option value="classKNetwork_1_1KResolverResults.html">knetwork::kresolverresults</option>, <option value="classKNetwork_1_1KResolverWorkerBase_1_1ResolverLocker.html">knetwork::kresolverworkerbase::resolverlocker</option>, <option value="classKNetwork_1_1KReverseResolver.html">knetwork::kreverseresolver</option>, <option value="classKNetwork_1_1KServerSocket.html">knetwork::kserversocket</option>, <option value="classKNetwork_1_1KSocketAddress.html">knetwork::ksocketaddress</option>, <option value="classKNetwork_1_1KSocketBase.html">knetwork::ksocketbase</option>, <option value="classKNetwork_1_1KSocketDevice.html">knetwork::ksocketdevice</option>, <option value="classKNetwork_1_1KSocketDeviceFactory.html">knetwork::ksocketdevicefactory</option>, <option value="classKNetwork_1_1KSocksSocketDevice.html">knetwork::ksockssocketdevice</option>, <option value="classKNetwork_1_1KStreamSocket.html">knetwork::kstreamsocket</option>, <option value="classKNetwork_1_1KUnixSocketAddress.html">knetwork::kunixsocketaddress</option>, <option value="classKNotifyClient_1_1Instance.html">knotifyclient::instance</option>, <option value="classKPalette.html">kpalette</option>, <option value="classKPixmapProvider.html">kpixmapprovider</option>, <option value="classKPopupAccelManager.html">kpopupaccelmanager</option>, <option value="classKProcess.html">kprocess</option>, <option value="classKProcessController.html">kprocesscontroller</option>, <option value="classKProcIO.html">kprocio</option>, <option value="classKProtocolInfoFactory.html">kprotocolinfofactory</option>, <option value="classKPty.html">kpty</option>, <option value="classKRandomSequence.html">krandomsequence</option>, <option value="classKRegExp.html">kregexp</option>, <option value="classKRegExpPrivate.html">kregexpprivate</option>, <option value="classKRFCDate.html">krfcdate</option>, <option value="classKRootProp.html">krootprop</option>, <option value="classKSaveFile.html">ksavefile</option>, <option value="classKServerSocket.html">kserversocket</option>, <option value="classKSessionManaged.html">ksessionmanaged</option>, <option value="classKShared.html">kshared</option>, <option value="classKSharedConfig.html">ksharedconfig</option>, <option value="classKSharedPtr.html">ksharedptr</option>, <option value="classKShellProcess.html">kshellprocess</option>, <option value="classKShortcut.html">kshortcut</option>, <option value="classKShortcutList.html">kshortcutlist</option>, <option value="classKSimpleConfig.html">ksimpleconfig</option>, <option value="classKSocket.html">ksocket</option>, <option value="classKSocketAddress.html">ksocketaddress</option>, <option value="classKSocks.html">ksocks</option>, <option value="classKSortableItem.html">ksortableitem</option>, <option value="classKSortableValueList.html">ksortablevaluelist</option>, <option value="classKStandardDirs.html">kstandarddirs</option>, <option value="classKStaticDeleter.html">kstaticdeleter</option>, <option value="classKStaticDeleterBase.html">kstaticdeleterbase</option>, <option value="classKStdAccel_1_1ShortcutList.html">kstdaccel::shortcutlist</option>, <option value="classKStringHandler.html">kstringhandler</option>, <option value="classKSycocaEntry.html">ksycocaentry</option>, <option value="classKSycocaFactoryList.html">ksycocafactorylist</option>, <option value="classKTempDir.html">ktempdir</option>, <option value="classKTempFile.html">ktempfile</option>, <option value="classKTimezone.html">ktimezone</option>, <option value="classKTimezoneDetails.html">ktimezonedetails</option>, <option value="classKTimezones.html">ktimezones</option>, <option value="classKTimezoneSource.html">ktimezonesource</option>, <option value="classKUniqueApplication.html">kuniqueapplication</option>, <option value="classKUnixSocketAddress.html">kunixsocketaddress</option>, <option value="classKURL.html">kurl</option>, <option value="classKURL_1_1List.html">kurl::list</option>, <option value="classKURLDrag.html">kurldrag</option>, <option value="classKUser.html">kuser</option>, <option value="classKUserGroup.html">kusergroup</option>, <option value="classKVMAllocator.html">kvmallocator</option>, <option value="classKWin.html">kwin</option>, <option value="classKWin_1_1WindowInfo.html">kwin::windowinfo</option>, <option value="classKWinModule.html">kwinmodule</option>, <option value="classKWordMacroExpander.html">kwordmacroexpander</option>, <option value="classKXErrorHandler.html">kxerrorhandler</option>, <option value="classKZoneAllocator.html">kzoneallocator</option>, <option value="classNET.html">net</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
