<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Wt: Wt::Dbo::FieldInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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="modules.html"><span>Modules</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="namespaceWt_1_1Dbo.html">Dbo</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html">FieldInfo</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::Dbo::FieldInfo Class Reference<div class="ingroups"><a class="el" href="group__dbo.html">Database Objects (Wt::Dbo)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Dbo::FieldInfo" -->
<p>Description of a field.
<a href="classWt_1_1Dbo_1_1FieldInfo.html#details">More...</a></p>
<p><code>#include <Wt/Dbo/SqlTraits></code></p>
<p><a href="classWt_1_1Dbo_1_1FieldInfo-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74">Flags</a> { <br/>
  <a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74abd29aed6e83cfe4f2c9aca8f46052930">SurrogateId</a> = 0x1,
<a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74aa95fc942e42250a677339c2efc7e62dc">NaturalId</a> = 0x2,
<a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74a39166c38abd9ccbd99e2d2f88906d814">Version</a> = 0x4,
<a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74a5d34fad0e176750e3851bc76151075d1">Mutable</a> = 0x8,
<br/>
  <a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74a90f8c5e95d174ba0837a42c43a23ac39">NeedsQuotes</a> = 0x10,
<a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74afa28af86726e73177e8ed03e5fdaa9d5">ForeignKey</a> = 0x20
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flags. <a href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74">More...</a><br/></td></tr>
<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="anchor" id="a2ac38659a204f772c8dd4bffa6550c2b"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::FieldInfo" ref="a2ac38659a204f772c8dd4bffa6550c2b" args="(const std::string &name, const std::type_info *type, const std::string &sqlType, int flags)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a2ac38659a204f772c8dd4bffa6550c2b">FieldInfo</a> (const std::string &name, const std::type_info *type, const std::string &sqlType, int flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a field description. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a010c03cba8dc01a2b86443f839d4e220"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::FieldInfo" ref="a010c03cba8dc01a2b86443f839d4e220" args="(const std::string &name, const std::type_info *type, const std::string &sqlType, const std::string &foreignKeyTable, const std::string &foreignKeyName, int flags, int fkConstraints)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a010c03cba8dc01a2b86443f839d4e220">FieldInfo</a> (const std::string &name, const std::type_info *type, const std::string &sqlType, const std::string &foreignKeyTable, const std::string &foreignKeyName, int flags, int fkConstraints)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a field description. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c9b9be3aeb53d07c98d7199fc97e965"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::setQualifier" ref="a1c9b9be3aeb53d07c98d7199fc97e965" args="(const std::string &qualifier, bool firstQualified=false)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a1c9b9be3aeb53d07c98d7199fc97e965">setQualifier</a> (const std::string &qualifier, bool firstQualified=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets a qualifier for the field. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a641378ec94a44b31dc269003b6e3c1b8"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::name" ref="a641378ec94a44b31dc269003b6e3c1b8" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a641378ec94a44b31dc269003b6e3c1b8">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the field name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad70e6a952ee5482fef69f2f715fc80c9"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::sqlType" ref="ad70e6a952ee5482fef69f2f715fc80c9" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#ad70e6a952ee5482fef69f2f715fc80c9">sqlType</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the field SQL type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ca5488b2fc88986d678ab8981184c28"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::qualifier" ref="a4ca5488b2fc88986d678ab8981184c28" args="() const " -->
const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a4ca5488b2fc88986d678ab8981184c28">qualifier</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the field qualifier. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee2d002fe01db8d9a2417bfd256e19b7"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::type" ref="aee2d002fe01db8d9a2417bfd256e19b7" args="() const " -->
const std::type_info * </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#aee2d002fe01db8d9a2417bfd256e19b7">type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the field type. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae3e1485bb497489a0b82252ba290042"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isIdField" ref="aae3e1485bb497489a0b82252ba290042" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#aae3e1485bb497489a0b82252ba290042">isIdField</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is an Id field. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a64e890f80b63b40fcdbf581eec4bdf54"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isNaturalIdField" ref="a64e890f80b63b40fcdbf581eec4bdf54" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a64e890f80b63b40fcdbf581eec4bdf54">isNaturalIdField</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is a Natural Id field. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac52d9c1f1bf71b8d30d7050bc2379732"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isSurrogateIdField" ref="ac52d9c1f1bf71b8d30d7050bc2379732" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#ac52d9c1f1bf71b8d30d7050bc2379732">isSurrogateIdField</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is a Surroaget Id field. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04f79cb89127236fc1aab798c5dff75a"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isVersionField" ref="a04f79cb89127236fc1aab798c5dff75a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#a04f79cb89127236fc1aab798c5dff75a">isVersionField</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is a Version field. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1fb411e5e5f2391832016b5d3e07d3b"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isMutable" ref="ae1fb411e5e5f2391832016b5d3e07d3b" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#ae1fb411e5e5f2391832016b5d3e07d3b">isMutable</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is mutable. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6cee958dab8c234954d6f418aec1979"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::needsQuotes" ref="ae6cee958dab8c234954d6f418aec1979" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#ae6cee958dab8c234954d6f418aec1979">needsQuotes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field name needs to be quoted. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee0ef9bf2e28793ba414d03b3912fd81"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::isForeignKey" ref="aee0ef9bf2e28793ba414d03b3912fd81" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#aee0ef9bf2e28793ba414d03b3912fd81">isForeignKey</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the field is part of a foreign key. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Description of a field. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structWt_1_1Dbo_1_1query__result__traits.html#a15021d5b70cb03ee08b39f0c45b02572" title="Obtains the list of fields in this result.">query_result_traits::getFields()</a>, <a class="el" href="classWt_1_1Dbo_1_1Query.html#a9b08b4f6aa7b59ff2fe0282eb1f07192" title="Returns the result fields.">Query::fields()</a> </dd></dl>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74"></a><!-- doxytag: member="Wt::Dbo::FieldInfo::Flags" ref="abbf8a1584332b33920b8e74f8f07ed74" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classWt_1_1Dbo_1_1FieldInfo.html#abbf8a1584332b33920b8e74f8f07ed74">Wt::Dbo::FieldInfo::Flags</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Flags. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74abd29aed6e83cfe4f2c9aca8f46052930"></a><!-- doxytag: member="SurrogateId" ref="abbf8a1584332b33920b8e74f8f07ed74abd29aed6e83cfe4f2c9aca8f46052930" args="" -->SurrogateId</em> </td><td>
<p>Field is a surrogate id. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74aa95fc942e42250a677339c2efc7e62dc"></a><!-- doxytag: member="NaturalId" ref="abbf8a1584332b33920b8e74f8f07ed74aa95fc942e42250a677339c2efc7e62dc" args="" -->NaturalId</em> </td><td>
<p>Field is (part of) a natural id. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74a39166c38abd9ccbd99e2d2f88906d814"></a><!-- doxytag: member="Version" ref="abbf8a1584332b33920b8e74f8f07ed74a39166c38abd9ccbd99e2d2f88906d814" args="" -->Version</em> </td><td>
<p>Field is an optimistic concurrency version field. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74a5d34fad0e176750e3851bc76151075d1"></a><!-- doxytag: member="Mutable" ref="abbf8a1584332b33920b8e74f8f07ed74a5d34fad0e176750e3851bc76151075d1" args="" -->Mutable</em> </td><td>
<p>Field can be edited. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74a90f8c5e95d174ba0837a42c43a23ac39"></a><!-- doxytag: member="NeedsQuotes" ref="abbf8a1584332b33920b8e74f8f07ed74a90f8c5e95d174ba0837a42c43a23ac39" args="" -->NeedsQuotes</em> </td><td>
<p>Field name needs quotes when using in SQL. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="abbf8a1584332b33920b8e74f8f07ed74afa28af86726e73177e8ed03e5fdaa9d5"></a><!-- doxytag: member="ForeignKey" ref="abbf8a1584332b33920b8e74f8f07ed74afa28af86726e73177e8ed03e5fdaa9d5" args="" -->ForeignKey</em> </td><td>
<p>Field is (part of) a foreign key. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
