<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csCommandLineHelper Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csCommandLineHelper Class Reference</h1><!-- doxytag: class="csCommandLineHelper" -->This class can be used to help parsing the commandline.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="cmdhelp_8h-source.html">csutil/cmdhelp.h</a>></code>
<p>
<p>
<a href="classcsCommandLineHelper-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommandLineHelper.html#782e62335aa5eebef6c6ce081701ea10">CheckHelp</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="structiCommandLineParser.html">iCommandLineParser</a> *cmdline=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if -help is given on the commandline and return true. <a href="#782e62335aa5eebef6c6ce081701ea10"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsCommandLineHelper.html#8082d602f14ea7f4376e7c811204f737">Help</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *object_reg, <a class="el" href="structiCommandLineParser.html">iCommandLineParser</a> *cmdline=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ask for Help. <a href="#8082d602f14ea7f4376e7c811204f737"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class can be used to help parsing the commandline.
<p>
One of the functionalities it gives is the ability to have commandline help. To do that it will look at all plugins and see if they implement iConfig. This class requires the <a class="el" href="structiPluginManager.html" title="This is the plugin manager.">iPluginManager</a> and <a class="el" href="structiCommandLineParser.html" title="A utility class that makes it easier to parse the command line.">iCommandLineParser</a> to be in the object registry (or else you give it as a parameter).
<p>Definition at line <a class="el" href="cmdhelp_8h-source.html#l00039">39</a> of file <a class="el" href="cmdhelp_8h-source.html">cmdhelp.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="782e62335aa5eebef6c6ce081701ea10"></a><!-- doxytag: member="csCommandLineHelper::CheckHelp" ref="782e62335aa5eebef6c6ce081701ea10" args="(iObjectRegistry *object_reg, iCommandLineParser *cmdline=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool csCommandLineHelper::CheckHelp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiCommandLineParser.html">iCommandLineParser</a> * </td>
<td class="paramname"> <em>cmdline</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if -help is given on the commandline and return true.
<p>
</div>
</div><p>
<a class="anchor" name="8082d602f14ea7f4376e7c811204f737"></a><!-- doxytag: member="csCommandLineHelper::Help" ref="8082d602f14ea7f4376e7c811204f737" args="(iObjectRegistry *object_reg, iCommandLineParser *cmdline=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void csCommandLineHelper::Help </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"> <em>object_reg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiCommandLineParser.html">iCommandLineParser</a> * </td>
<td class="paramname"> <em>cmdline</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask for Help.
<p>
This function will first send a broadcast message of type csevCommandLineHelp and then it will check all plugins and see if they implement iConfig. If the commandline parser is not given then the default commandline parser from the registry will be used.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="cmdhelp_8h-source.html">cmdhelp.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
344
