Sophie

Sophie

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

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::boost_any_traits&lt; Type &gt; Struct Template 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="structWt_1_1boost__any__traits.html">boost_any_traits</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wt::boost_any_traits&lt; Type &gt; Struct Template Reference<div class="ingroups"><a class="el" href="group__modelview.html">Model/view system</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::boost_any_traits" -->
<p>A traits class for a type stored in a boost::any.  
 <a href="structWt_1_1boost__any__traits.html#details">More...</a></p>

<p><a href="structWt_1_1boost__any__traits-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="classWt_1_1WString.html">WString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1boost__any__traits.html#aa9746e57608889b491fe29a22b0a77e6">asString</a> (const Type &amp;value, const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;format)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a value to a string.  <a href="#aa9746e57608889b491fe29a22b0a77e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1boost__any__traits.html#ae64c24bc95485379a81410eb025f376e">asNumber</a> (const Type &amp;v)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a value to a number.  <a href="#ae64c24bc95485379a81410eb025f376e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structWt_1_1boost__any__traits.html#ad8c7fbf1e2c414828a595eea76d7bf00">compare</a> (const Type &amp;v1, const Type &amp;v2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Compares two values.  <a href="#ad8c7fbf1e2c414828a595eea76d7bf00"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Type&gt;<br/>
struct Wt::boost_any_traits&lt; Type &gt;</h3>

<p>A traits class for a type stored in a boost::any. </p>
<p>The traits are used by Wt's view classes (such as <a class="el" href="classWt_1_1WTableView.html" title="An MVC View widget for tabular data.">Wt::WTableView</a> <a class="el" href="classWt_1_1WTreeView.html" title="A view class that displays a model as a tree or tree table.">Wt::WTreeView</a>, <a class="el" href="classWt_1_1Chart_1_1WCartesianChart.html" title="A cartesian chart.">Wt::Chart::WCartesianChart</a>) to deal with values in a <a class="el" href="classWt_1_1WAbstractItemModel.html" title="An abstract model for use with Wt&#39;s view classes.">Wt::WAbstractItemModel</a>:</p>
<ul>
<li>conversion to a string by <a class="el" href="group__modelview.html#ga57b5cadd177847f51eaeb0cee23782c1" title="Interprets a boost::any as a string value.">Wt::asString()</a></li>
<li>conversion to a number by <a class="el" href="group__modelview.html#ga2494f8093b2b8f2f9c0aa7699e7bfc2a" title="Interprets a boost::any as a number value.">Wt::asNumber()</a></li>
<li>sorting by <a class="el" href="classWt_1_1WSortFilterProxyModel.html" title="A proxy model for Wt&#39;s item models that provides filtering and/or sorting.">Wt::WSortFilterProxyModel</a> or <a class="el" href="classWt_1_1WStandardItemModel.html" title="A standard data model, which stores its data in memory.">WStandardItemModel</a>.</li>
</ul>
<p>This traits class provides a default implementation for supporting values <em>value</em> of a custom type <em>Type</em> in Wt's MVC system, which relies on:</p>
<ul>
<li>serializing to a stream (std::ostream &lt;&lt; <em>value</em>) for converting the value to a string.</li>
<li>lexical interpretation as a number for converting the value to a number, using boost::lexical_cast&lt;double&gt;(value).</li>
<li>sorting using operator== and operator&lt;</li>
</ul>
<p>You can specialize these traits if you need to customize one or more of these operations. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae64c24bc95485379a81410eb025f376e"></a><!-- doxytag: member="Wt::boost_any_traits::asNumber" ref="ae64c24bc95485379a81410eb025f376e" args="(const Type &amp;v)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structWt_1_1boost__any__traits.html">Wt::boost_any_traits</a>&lt; Type &gt;::asNumber </td>
          <td>(</td>
          <td class="paramtype">const Type &amp;&#160;</td>
          <td class="paramname"><em>v</em></td><td>)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Converts a value to a number. </p>
<p>The default implementation returns: </p>
<div class="fragment"><pre class="fragment"> boost::lexical_cast&lt;<span class="keywordtype">double</span>&gt;(<a class="code" href="structWt_1_1boost__any__traits.html#aa9746e57608889b491fe29a22b0a77e6" title="Converts a value to a string.">asString</a>(v), <span class="stringliteral">&quot;&quot;</span>)
</pre></div> 
</div>
</div>
<a class="anchor" id="aa9746e57608889b491fe29a22b0a77e6"></a><!-- doxytag: member="Wt::boost_any_traits::asString" ref="aa9746e57608889b491fe29a22b0a77e6" args="(const Type &amp;value, const WString &amp;format)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classWt_1_1WString.html">WString</a> <a class="el" href="structWt_1_1boost__any__traits.html">Wt::boost_any_traits</a>&lt; Type &gt;::asString </td>
          <td>(</td>
          <td class="paramtype">const Type &amp;&#160;</td>
          <td class="paramname"><em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classWt_1_1WString.html">WString</a> &amp;&#160;</td>
          <td class="paramname"><em>format</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Converts a value to a string. </p>
<p>The default implementation uses a boost::lexical_cast, and thus an overloaded std::ostream&lt;&lt; operator for the value. </p>

</div>
</div>
<a class="anchor" id="ad8c7fbf1e2c414828a595eea76d7bf00"></a><!-- doxytag: member="Wt::boost_any_traits::compare" ref="ad8c7fbf1e2c414828a595eea76d7bf00" args="(const Type &amp;v1, const Type &amp;v2)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Type &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structWt_1_1boost__any__traits.html">Wt::boost_any_traits</a>&lt; Type &gt;::compare </td>
          <td>(</td>
          <td class="paramtype">const Type &amp;&#160;</td>
          <td class="paramname"><em>v1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Type &amp;&#160;</td>
          <td class="paramname"><em>v2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Compares two values. </p>
<p>The default implementation uses operator== and operator&lt;. </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>