<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
"http://www.w3.org/TR/REC-html40/loose.dtd">
<html lang="en" dir="LTR">
<head>
<!-- $Id: header.html,v 1.5 2004/06/12 01:58:25 sbooth Exp $ -->
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>cgicc: cgicc::FormEntry Class Reference</title>
<link rev="made" href="mailto:bug-cgicc@gnu.org" />
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="cgicc-doc.css" rel="stylesheet" type="text/css" />
</head>
<body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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>
<div class="navpath"><a class="el" href="namespacecgicc.html">cgicc</a>::<a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a>
</div>
</div>
<div class="contents">
<h1>cgicc::FormEntry Class Reference</h1><!-- doxytag: class="cgicc::FormEntry" -->Class representing a single HTML form entry.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="FormEntry_8h_source.html">cgicc/FormEntry.h</a>></code>
<p>
<p>
<a href="classcgicc_1_1FormEntry-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructors and Destructor</div></td></tr>
<tr><td colspan="2"><div class="groupText"><br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#4fe98ef071864400d758eca907cef970">FormEntry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#4fe98ef071864400d758eca907cef970"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#bf89b26203879825966b658b82e035c8">FormEntry</a> (const std::string &name, const std::string &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a>. <a href="#bf89b26203879825966b658b82e035c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#51306a47774c09a95007749f93628f62">FormEntry</a> (const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> &entry)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#51306a47774c09a95007749f93628f62"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#2a95ff5eb17b7d565d43acb25dd78c4f">~FormEntry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#2a95ff5eb17b7d565d43acb25dd78c4f"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Overloaded Operators</div></td></tr>
<tr><td colspan="2"><div class="groupText"><br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#b21ccc5c526908917d82ef7b0f7a8464">operator==</a> (const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> &entry) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two FormEntrys for equality. <a href="#b21ccc5c526908917d82ef7b0f7a8464"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#86cf849d036749e2cb4722ee502df068">operator!=</a> (const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> &entry) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare two FormEntrys for inequality. <a href="#86cf849d036749e2cb4722ee502df068"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#a80c77bda97081c0e20368319b3bfbb7">operator=</a> (const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> &entry)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assign one <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to another. <a href="#a80c77bda97081c0e20368319b3bfbb7"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Accessor Methods</div></td></tr>
<tr><td colspan="2"><div class="groupText">Information on the form element <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#4d70968c8f54c6485121dacb5f629c36">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the form element. <a href="#4d70968c8f54c6485121dacb5f629c36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#48516a8bfb2e0fd45213fd9343ac4631">getValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a string. <a href="#48516a8bfb2e0fd45213fd9343ac4631"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#478bd6404ed6f33c70774cdc31cfbcd0">operator*</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a string. <a href="#478bd6404ed6f33c70774cdc31cfbcd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#d9c4e04f65aab2161aa3cedb64f4b390">getValue</a> (std::string::size_type maxChars) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a string. <a href="#d9c4e04f65aab2161aa3cedb64f4b390"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#72a8808d78ba5227a87a7acf24e2911b">getStrippedValue</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a string. <a href="#72a8808d78ba5227a87a7acf24e2911b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#9b3f165094c4e158f212b871cc3e9d2a">getStrippedValue</a> (std::string::size_type maxChars) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a string. <a href="#9b3f165094c4e158f212b871cc3e9d2a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#f3ca229ad4f97ea8ecf1fa207834c1c4">getIntegerValue</a> (long min=LONG_MIN, long max=LONG_MAX) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as an integer. <a href="#f3ca229ad4f97ea8ecf1fa207834c1c4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#5c1fe5779c3891f9bf4d1f33d4154fe4">getIntegerValue</a> (long min, long max, bool &bounded) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as an integer. <a href="#5c1fe5779c3891f9bf4d1f33d4154fe4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#1d8b01c96059d4f159270f4636be81d5">getDoubleValue</a> (double min=-DBL_MAX, double max=DBL_MAX) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a double. <a href="#1d8b01c96059d4f159270f4636be81d5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#d3af15996a2a329aa10f01cb45e44309">getDoubleValue</a> (double min, double max, bool &bounded) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the form element as a double. <a href="#d3af15996a2a329aa10f01cb45e44309"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string::size_type </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#7c5a604bd278a2db2fa3ba818146b827">length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of characters in the value of the form element. <a href="#7c5a604bd278a2db2fa3ba818146b827"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcgicc_1_1FormEntry.html#a08d7843e43977b31efda50d689d8ab6">isEmpty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determine if this form element is empty. <a href="#a08d7843e43977b31efda50d689d8ab6"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class representing a single HTML form entry.
<p>
<a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> is an immutable class representing a single user entry in an HTML form element such as a text field, radio button, or a checkbox. A <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> is essentially a name/value pair, where the name is the name of the form element as specified in the HTML form itself, and the value is the user-entered or user-selected value.<p>
If a <code>QUERY_STRING</code> contained the fragment <code>cgicc=yes</code> the corresponding <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> would have a name of <code><a class="el" href="namespacecgicc.html" title="The namespace containing the cgicc library.">cgicc</a></code> and a value of <code>yes</code> <p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcgicc_1_1FormFile.html" title="Class representing a file submitted via an HTML form.">FormFile</a> </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00070">70</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4fe98ef071864400d758eca907cef970"></a><!-- doxytag: member="cgicc::FormEntry::FormEntry" ref="4fe98ef071864400d758eca907cef970" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::FormEntry::FormEntry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
Shouldn't be used.
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00085">85</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bf89b26203879825966b658b82e035c8"></a><!-- doxytag: member="cgicc::FormEntry::FormEntry" ref="bf89b26203879825966b658b82e035c8" args="(const std::string &name, const std::string &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::FormEntry::FormEntry </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a>.
<p>
This is usually not called directly, but by <a class="el" href="classcgicc_1_1Cgicc.html" title="The main class of the GNU cgicc library.">Cgicc</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the form element </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>The value of the form element </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00096">96</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="51306a47774c09a95007749f93628f62"></a><!-- doxytag: member="cgicc::FormEntry::FormEntry" ref="51306a47774c09a95007749f93628f62" args="(const FormEntry &entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::FormEntry::FormEntry </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> & </td>
<td class="paramname"> <em>entry</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Copy constructor.
<p>
Sets the name and value of this <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to those of <code>entry</code>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>The <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to copy. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00108">108</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2a95ff5eb17b7d565d43acb25dd78c4f"></a><!-- doxytag: member="cgicc::FormEntry::~FormEntry" ref="2a95ff5eb17b7d565d43acb25dd78c4f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cgicc::FormEntry::~FormEntry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
Delete this <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> object
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00117">117</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d3af15996a2a329aa10f01cb45e44309"></a><!-- doxytag: member="cgicc::FormEntry::getDoubleValue" ref="d3af15996a2a329aa10f01cb45e44309" args="(double min, double max, bool &bounded) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double cgicc::FormEntry::getDoubleValue </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>bounded</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a double.
<p>
No syntax checking is performed on the string value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>The minimum value to return. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>The maximum value to return. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bounded</em> </td><td>Set to <code>true</code> if the value was originally outside the limits, <code>false</code> otherwise </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The double value of the form element. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1d8b01c96059d4f159270f4636be81d5"></a><!-- doxytag: member="cgicc::FormEntry::getDoubleValue" ref="1d8b01c96059d4f159270f4636be81d5" args="(double min=-DBL_MAX, double max=DBL_MAX) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double cgicc::FormEntry::getDoubleValue </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>min</em> = <code>-DBL_MAX</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>max</em> = <code>DBL_MAX</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a double.
<p>
No syntax checking is performed on the string value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>The minimum value to return (optional). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>The maximum value to return (optional). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The double value of the form element. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5c1fe5779c3891f9bf4d1f33d4154fe4"></a><!-- doxytag: member="cgicc::FormEntry::getIntegerValue" ref="5c1fe5779c3891f9bf4d1f33d4154fe4" args="(long min, long max, bool &bounded) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long cgicc::FormEntry::getIntegerValue </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>max</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool & </td>
<td class="paramname"> <em>bounded</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as an integer.
<p>
No syntax checking is performed on the string value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>The minimum value to return. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>The maximum value to return. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bounded</em> </td><td>Set to <code>true</code> if the value was originally outside the limits, <code>false</code> otherwise </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The integer value of the form element. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f3ca229ad4f97ea8ecf1fa207834c1c4"></a><!-- doxytag: member="cgicc::FormEntry::getIntegerValue" ref="f3ca229ad4f97ea8ecf1fa207834c1c4" args="(long min=LONG_MIN, long max=LONG_MAX) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long cgicc::FormEntry::getIntegerValue </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"> <em>min</em> = <code>LONG_MIN</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>max</em> = <code>LONG_MAX</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as an integer.
<p>
No syntax checking is performed on the string value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>The minimum value to return (optional). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>The maximum value to return (optional). </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The integer value of the form element. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d70968c8f54c6485121dacb5f629c36"></a><!-- doxytag: member="cgicc::FormEntry::getName" ref="4d70968c8f54c6485121dacb5f629c36" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::getName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of the form element.
<p>
The name of the form element is specified in the HTML form that called the CGI application. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the form element. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00181">181</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9b3f165094c4e158f212b871cc3e9d2a"></a><!-- doxytag: member="cgicc::FormEntry::getStrippedValue" ref="9b3f165094c4e158f212b871cc3e9d2a" args="(std::string::size_type maxChars) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::getStrippedValue </td>
<td>(</td>
<td class="paramtype">std::string::size_type </td>
<td class="paramname"> <em>maxChars</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a string.
<p>
The value returned will be stripped of all line breaks and truncated to a specific length. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>maxChars</em> </td><td>The maximum number of characters to return. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the form element, stripped of all line breaks and truncated to the specified length. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00236">236</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="72a8808d78ba5227a87a7acf24e2911b"></a><!-- doxytag: member="cgicc::FormEntry::getStrippedValue" ref="72a8808d78ba5227a87a7acf24e2911b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::getStrippedValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a string.
<p>
The value returned will be stripped of all line breaks. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the form element, stripped of all line breaks. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00223">223</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
<p>References <a class="el" href="FormEntry_8h_source.html#l00223">getStrippedValue()</a>.</p>
<p>Referenced by <a class="el" href="FormEntry_8h_source.html#l00223">getStrippedValue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9c4e04f65aab2161aa3cedb64f4b390"></a><!-- doxytag: member="cgicc::FormEntry::getValue" ref="d9c4e04f65aab2161aa3cedb64f4b390" args="(std::string::size_type maxChars) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::getValue </td>
<td>(</td>
<td class="paramtype">std::string::size_type </td>
<td class="paramname"> <em>maxChars</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a string.
<p>
The value returned will be truncated to a specific length. The value may contain line breaks. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>maxChars</em> </td><td>The maximum number of characters to return. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the form element, truncated to the specified length. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00213">213</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="48516a8bfb2e0fd45213fd9343ac4631"></a><!-- doxytag: member="cgicc::FormEntry::getValue" ref="48516a8bfb2e0fd45213fd9343ac4631" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::getValue </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a string.
<p>
The value returned may contain line breaks. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the form element. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00191">191</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a08d7843e43977b31efda50d689d8ab6"></a><!-- doxytag: member="cgicc::FormEntry::isEmpty" ref="a08d7843e43977b31efda50d689d8ab6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::FormEntry::isEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Determine if this form element is empty.
<p>
In an empty form element, <a class="el" href="classcgicc_1_1FormEntry.html#7c5a604bd278a2db2fa3ba818146b827" title="Get the number of characters in the value of the form element.">length()</a> == 0. <dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if this form element is empty, <code>false</code> otherwise. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00311">311</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c5a604bd278a2db2fa3ba818146b827"></a><!-- doxytag: member="cgicc::FormEntry::length" ref="7c5a604bd278a2db2fa3ba818146b827" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string::size_type cgicc::FormEntry::length </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of characters in the value of the form element.
<p>
Note that a character may or may not equal one byte. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The length of the value of the form element </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00301">301</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="86cf849d036749e2cb4722ee502df068"></a><!-- doxytag: member="cgicc::FormEntry::operator!=" ref="86cf849d036749e2cb4722ee502df068" args="(const FormEntry &entry) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::FormEntry::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> & </td>
<td class="paramname"> <em>entry</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two FormEntrys for inequality.
<p>
FormEntrys are equal if they have the same name and value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>The <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to compare to this one. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>false</code> if the two FormEntrys are equal, <code>true</code> otherwise. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00145">145</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="478bd6404ed6f33c70774cdc31cfbcd0"></a><!-- doxytag: member="cgicc::FormEntry::operator*" ref="478bd6404ed6f33c70774cdc31cfbcd0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string cgicc::FormEntry::operator* </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the value of the form element as a string.
<p>
The value returned may contain line breaks. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The value of the form element. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00201">201</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
<p>References <a class="el" href="cardgame_8cpp_source.html#l00245">CardGameTools::getValue()</a>.</p>
</div>
</div><p>
<a class="anchor" name="a80c77bda97081c0e20368319b3bfbb7"></a><!-- doxytag: member="cgicc::FormEntry::operator=" ref="a80c77bda97081c0e20368319b3bfbb7" args="(const FormEntry &entry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a>& cgicc::FormEntry::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> & </td>
<td class="paramname"> <em>entry</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Assign one <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to another.
<p>
Sets the name and value of this <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to those of <code>entry</code>. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>The <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to copy. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A reference to this. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b21ccc5c526908917d82ef7b0f7a8464"></a><!-- doxytag: member="cgicc::FormEntry::operator==" ref="b21ccc5c526908917d82ef7b0f7a8464" args="(const FormEntry &entry) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool cgicc::FormEntry::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcgicc_1_1FormEntry.html">FormEntry</a> & </td>
<td class="paramname"> <em>entry</em> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compare two FormEntrys for equality.
<p>
FormEntrys are equal if they have the same name and value. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>entry</em> </td><td>The <a class="el" href="classcgicc_1_1FormEntry.html" title="Class representing a single HTML form entry.">FormEntry</a> to compare to this one. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if the two FormEntrys are equal, <code>false</code> otherwise. </dd></dl>
<p>Definition at line <a class="el" href="FormEntry_8h_source.html#l00134">134</a> of file <a class="el" href="FormEntry_8h_source.html">FormEntry.h</a>.</p>
<p>References <a class="el" href="namespacecgicc.html#355209b76eb905b0ae9ea3521976f8de">cgicc::stringsAreEqual()</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FormEntry_8h_source.html">FormEntry.h</a></ul>
</div>
<!-- $Id: footer.html,v 1.7 2004/06/12 01:58:25 sbooth Exp $ -->
<hr>
<address><small>
<a href="http://www.cgicc.org">GNU cgicc</a> - A C++ class library for
writing CGI applications<br />
Copyright © 1996 - 2004
<a href="mailto:sboothATgnuDOTorg">Stephen F. Booth</a><br />
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front Cover Texts, and with no Back-Cover
Texts.<br />
Documentation generated Tue Jun 9 15:03:49 2009 for cgicc by
<a HREF="http://www.doxygen.org/index.html">doxygen</a> 1.5.9
</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
82bf76c75b44c3e54c5dc9d8c4b11ab5
>
files
>
122
