Sophie

Sophie

distrib > Fedora > 18 > x86_64 > by-pkgid > b3a1f4d91c26f535919e39e25606614a > files > 3068

wt-doc-3.2.3-1.fc18.noarch.rpm

<!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::dbo_default_traits 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
   &#160;<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;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="structWt_1_1Dbo_1_1dbo__default__traits.html">dbo_default_traits</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wt::Dbo::dbo_default_traits 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::dbo_default_traits" -->
<p>Default traits for a class mapped with Wt::Dbo.  
 <a href="structWt_1_1Dbo_1_1dbo__default__traits.html#details">More...</a></p>

<p><code>#include &lt;Wt/Dbo/Dbo&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Wt::Dbo::dbo_default_traits:</div>
<div class="dyncontent">
<div class="center"><img src="structWt_1_1Dbo_1_1dbo__default__traits__inherit__graph.png" border="0" usemap="#Wt_1_1Dbo_1_1dbo__default__traits_inherit__map" alt="Inheritance graph"/></div>
<map name="Wt_1_1Dbo_1_1dbo__default__traits_inherit__map" id="Wt_1_1Dbo_1_1dbo__default__traits_inherit__map">
<area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; AuthIdentity\&lt; AuthInfoType \&gt; \&gt;" alt="" coords="236,5,561,32"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; AuthInfo\&lt; UserType \&gt; \&gt;" alt="" coords="257,56,540,83"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; AuthInfoType \&gt;" alt="" coords="283,107,515,133"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; AuthToken\&lt; AuthInfoType \&gt; \&gt;" alt="" coords="240,157,557,184"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; DboType \&gt;" alt="" coords="295,208,503,235"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Wt::Dbo::dbo_traits\&lt; UserType \&gt;" alt="" coords="292,259,505,285"/><area shape="rect" href="structWt_1_1Dbo_1_1dbo__traits.html" title="Traits for a class mapped with Wt::Dbo." alt="" coords="315,309,483,336"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classWt_1_1Dbo_1_1dbo__default__traits-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">typedef long long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a89170e677a75348ef6913d9f4ba496ae">IdType</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of the primary key.  <a href="#a89170e677a75348ef6913d9f4ba496ae"></a><br/></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 <a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a89170e677a75348ef6913d9f4ba496ae">IdType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a6bb01d0dc6a5bbd25481fa16b642b996">invalidId</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the sentinel value for a <code>null</code> id.  <a href="#a6bb01d0dc6a5bbd25481fa16b642b996"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a0c092c6b045f77d4fc04b5360b762b7f">surrogateIdField</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the database field name for the surrogate primary key.  <a href="#a0c092c6b045f77d4fc04b5360b762b7f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#af4da1fde75771c5f2e707827e2a885c4">versionField</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the optimistic concurrency version field.  <a href="#af4da1fde75771c5f2e707827e2a885c4"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Default traits for a class mapped with Wt::Dbo. </p>
<p>This class provides the default traits. It is convenient (and future proof) to inherit these default traits when customizing the traits for one particular class. </p>
</div><hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="a89170e677a75348ef6913d9f4ba496ae"></a><!-- doxytag: member="Wt::Dbo::dbo_default_traits::IdType" ref="a89170e677a75348ef6913d9f4ba496ae" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef long long <a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a89170e677a75348ef6913d9f4ba496ae">Wt::Dbo::dbo_default_traits::IdType</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Type of the primary key. </p>
<p>The default corresponds to a surrogate key, which is <code>long long</code>. </p>

<p>Reimplemented in <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; C &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; AuthToken&lt; AuthInfoType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; UserType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; DboType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; AuthInfo&lt; UserType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; AuthIdentity&lt; AuthInfoType &gt; &gt;</a>, and <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#afb62c3f28967b0b14b13360d47cd37dc">Wt::Dbo::dbo_traits&lt; AuthInfoType &gt;</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6bb01d0dc6a5bbd25481fa16b642b996"></a><!-- doxytag: member="Wt::Dbo::dbo_default_traits::invalidId" ref="a6bb01d0dc6a5bbd25481fa16b642b996" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="structWt_1_1Dbo_1_1dbo__default__traits.html#a89170e677a75348ef6913d9f4ba496ae">IdType</a> Wt::Dbo::dbo_default_traits::invalidId </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the sentinel value for a <code>null</code> id. </p>
<p>The default implementation returns -1. </p>

<p>Reimplemented in <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; C &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; AuthToken&lt; AuthInfoType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; UserType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; DboType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; AuthInfo&lt; UserType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; AuthIdentity&lt; AuthInfoType &gt; &gt;</a>, and <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#aae2a13a4ca038f5bad337fbc2d70d37c">Wt::Dbo::dbo_traits&lt; AuthInfoType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="a0c092c6b045f77d4fc04b5360b762b7f"></a><!-- doxytag: member="Wt::Dbo::dbo_default_traits::surrogateIdField" ref="a0c092c6b045f77d4fc04b5360b762b7f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* Wt::Dbo::dbo_default_traits::surrogateIdField </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the database field name for the surrogate primary key. </p>
<p>The default surrogate id database field name is <code>"id"</code>. </p>

<p>Reimplemented in <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; C &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; AuthToken&lt; AuthInfoType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; UserType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; DboType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; AuthInfo&lt; UserType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; AuthIdentity&lt; AuthInfoType &gt; &gt;</a>, and <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a44c5455df89390fae082aadf7cf1bc13">Wt::Dbo::dbo_traits&lt; AuthInfoType &gt;</a>.</p>

</div>
</div>
<a class="anchor" id="af4da1fde75771c5f2e707827e2a885c4"></a><!-- doxytag: member="Wt::Dbo::dbo_default_traits::versionField" ref="af4da1fde75771c5f2e707827e2a885c4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static const char* Wt::Dbo::dbo_default_traits::versionField </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Configures the optimistic concurrency version field. </p>
<p>By default, optimistic concurrency locking is enabled using a <code>"version"</code> field. </p>

<p>Reimplemented in <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; C &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; AuthToken&lt; AuthInfoType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; UserType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; DboType &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; AuthInfo&lt; UserType &gt; &gt;</a>, <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; AuthIdentity&lt; AuthInfoType &gt; &gt;</a>, and <a class="el" href="structWt_1_1Dbo_1_1dbo__traits.html#a701b53b0401836a7c966c619f3c9656d">Wt::Dbo::dbo_traits&lt; AuthInfoType &gt;</a>.</p>

</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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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&nbsp;<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>