<!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::Json::Object 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_1Json.html">Json</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> </div>
<div class="headertitle">
<div class="title">Wt::Json::Object Class Reference<div class="ingroups"><a class="el" href="group__json.html">JSON Library (Wt::Json)</a></div></div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::Json::Object" --><!-- doxytag: inherits="std::map" -->
<p>A JSON object.
<a href="classWt_1_1Json_1_1Object.html#details">More...</a></p>
<p>Inherits std::map< K, T >.</p>
<p><a href="classWt_1_1Json_1_1Object-members.html">List of all members.</a></p>
<table class="memberdecls">
<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="a2abb77d33f8b911fefabdd4021754014"></a><!-- doxytag: member="Wt::Json::Object::Object" ref="a2abb77d33f8b911fefabdd4021754014" args="()" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a2abb77d33f8b911fefabdd4021754014">Object</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f99813d64aa25323f36eddf6c70e07c"></a><!-- doxytag: member="Wt::Json::Object::Object" ref="a6f99813d64aa25323f36eddf6c70e07c" args="(const Object &other)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a6f99813d64aa25323f36eddf6c70e07c">Object</a> (const <a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a1f6f6959695bb37e6b724aae2edb524f">swap</a> (<a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Swap operation. <a href="#a1f6f6959695bb37e6b724aae2edb524f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a04e8dc96a9a0fc90b5a20be0a2d105f9"></a><!-- doxytag: member="Wt::Json::Object::operator=" ref="a04e8dc96a9a0fc90b5a20be0a2d105f9" args="(const Object &other)" -->
<a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a04e8dc96a9a0fc90b5a20be0a2d105f9">operator=</a> (const <a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::set< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#af6ff020df1112b0ef7342f74bd8005cd">names</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the key set. <a href="#af6ff020df1112b0ef7342f74bd8005cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#aa22f05575d455c0147f760d96095d44d">contains</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a member exists. <a href="#aa22f05575d455c0147f760d96095d44d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__json.html#ga9952f308537fd1bea762f1bd114fd5c0">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a69a3b51acc6f3d98624d3f4a4fe429f0">type</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type of a given member. <a href="#a69a3b51acc6f3d98624d3f4a4fe429f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#a13307e8344f415455e249c9dd4d52561">isNull</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the value for a member is null (or not defined). <a href="#a13307e8344f415455e249c9dd4d52561"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classWt_1_1Json_1_1Value.html">Value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#aa3360213643a522c4049fe8010b0b09c">get</a> (const std::string &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value for a member (or null if not defined). <a href="#aa3360213643a522c4049fe8010b0b09c"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec3396b45321e6d8ec34127d9a5f0ded"></a><!-- doxytag: member="Wt::Json::Object::Empty" ref="aec3396b45321e6d8ec34127d9a5f0ded" args="" -->
static <a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1Json_1_1Object.html#aec3396b45321e6d8ec34127d9a5f0ded">Empty</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Empty object constant. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A JSON object. </p>
<p>This class represents a JSON object, which defines a value map. It is implemented as a <code>std::map<std::string,<a class="el" href="classWt_1_1Json_1_1Value.html" title="A JSON value.">Json::Value</a>></code>. It is therefore possible to use the std::map API to deal with it.</p>
<p>However, a number of additional methods have been added to more conveniently query the existence and the type of contained objects. A <a class="el" href="classWt_1_1Json_1_1Object.html#aa3360213643a522c4049fe8010b0b09c" title="Returns the value for a member (or null if not defined).">get()</a> method can be used to return a member value, which returns <a class="el" href="classWt_1_1Json_1_1Value.html#a344e20a378d9e91effbf91772b409942" title="Null constant.">Value::Null</a> if the member is not defined. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa22f05575d455c0147f760d96095d44d"></a><!-- doxytag: member="Wt::Json::Object::contains" ref="aa22f05575d455c0147f760d96095d44d" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Json::Object::contains </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether a member exists. </p>
<p>This returns whether the <code>name</code> is in the <a class="el" href="classWt_1_1Json_1_1Object.html#af6ff020df1112b0ef7342f74bd8005cd" title="Returns the key set.">names()</a> set. </p>
</div>
</div>
<a class="anchor" id="aa3360213643a522c4049fe8010b0b09c"></a><!-- doxytag: member="Wt::Json::Object::get" ref="aa3360213643a522c4049fe8010b0b09c" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classWt_1_1Json_1_1Value.html">Value</a> & Wt::Json::Object::get </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value for a member (or null if not defined). </p>
<p>Returns the value associated with member <code>name</code> or null if no value has been associated with this member name. </p>
</div>
</div>
<a class="anchor" id="a13307e8344f415455e249c9dd4d52561"></a><!-- doxytag: member="Wt::Json::Object::isNull" ref="a13307e8344f415455e249c9dd4d52561" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Wt::Json::Object::isNull </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the value for a member is null (or not defined). </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classWt_1_1Json_1_1Object.html#aa3360213643a522c4049fe8010b0b09c" title="Returns the value for a member (or null if not defined).">get()</a>, <a class="el" href="classWt_1_1Json_1_1Value.html#a6c7d31fe979c766c13276ade8dc8fff7" title="Returns whether the value is Null.">Value::isNull()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="af6ff020df1112b0ef7342f74bd8005cd"></a><!-- doxytag: member="Wt::Json::Object::names" ref="af6ff020df1112b0ef7342f74bd8005cd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::set< std::string > Wt::Json::Object::names </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the key set. </p>
<p>This returns the member names: these are the members for which values have been associated in this object.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>This may include members with explicit <a class="el" href="classWt_1_1Json_1_1Value.html#a344e20a378d9e91effbf91772b409942" title="Null constant.">Value::Null</a> values. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f6f6959695bb37e6b724aae2edb524f"></a><!-- doxytag: member="Wt::Json::Object::swap" ref="a1f6f6959695bb37e6b724aae2edb524f" args="(Object &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Wt::Json::Object::swap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWt_1_1Json_1_1Object.html">Object</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Swap operation. </p>
<p>This swaps the contents of two objects. </p>
</div>
</div>
<a class="anchor" id="a69a3b51acc6f3d98624d3f4a4fe429f0"></a><!-- doxytag: member="Wt::Json::Object::type" ref="a69a3b51acc6f3d98624d3f4a4fe429f0" args="(const std::string &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__json.html#ga9952f308537fd1bea762f1bd114fd5c0">Type</a> Wt::Json::Object::type </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the type of a given member. </p>
<p>This method returns the type of the value for members that are included, or returns <a class="el" href="group__json.html#gga9952f308537fd1bea762f1bd114fd5c0ad9f53f81b36049511b71b094f6f1ed33">Json::NullType</a> for when no value is associated with <code>name</code>. </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"> </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>
