<!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>libmusicbrainz3: MusicBrainz::User Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="main.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="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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">
<ul>
<li><a class="el" href="namespace_music_brainz.html">MusicBrainz</a> </li>
<li><a class="el" href="class_music_brainz_1_1_user.html">MusicBrainz::User</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>MusicBrainz::User Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="MusicBrainz::User" -->
<p>Represents a <a class="el" href="namespace_music_brainz.html">MusicBrainz</a> user.
<a href="#_details">More...</a></p>
<p><a href="class_music_brainz_1_1_user-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#a6ad485bfd15d7555f1d25d48a1af233d">User</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a6ad485bfd15d7555f1d25d48a1af233d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#acb58b97eabe10ab0e871985877f5392c">~User</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#acb58b97eabe10ab0e871985877f5392c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#ac59f784bdff80cb0c770a9b1c88db34e">getName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the user name. <a href="#ac59f784bdff80cb0c770a9b1c88db34e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#af517f8a7b1f35f7acbcb837b7b3ff0a2">setName</a> (const std::string &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the user name. <a href="#af517f8a7b1f35f7acbcb837b7b3ff0a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf">getTypes</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the types of this user. <a href="#aaada79b7230d65d22baf819f8244f7bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#a1746f221582cc67844d73338ac473ac3">getNumTypes</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns number of types. <a href="#a1746f221582cc67844d73338ac473ac3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#aaa7f18190801bf37f27cdbd5ec1a47e5">getType</a> (int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns an type specified by index. <a href="#aaa7f18190801bf37f27cdbd5ec1a47e5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#aed377677d6a230bec7a727243f2ee19d">addType</a> (const std::string &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a type to the list of types. <a href="#aed377677d6a230bec7a727243f2ee19d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#a488f9ab7cfe6ec5bb8ea5ea78c1f503b">getShowNag</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a nag screen should be displayed to the user. <a href="#a488f9ab7cfe6ec5bb8ea5ea78c1f503b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_user.html#aa8c16fff34e79092c1aef0e2a492d58b">setShowNag</a> (bool value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of the nag screen flag. <a href="#aa8c16fff34e79092c1aef0e2a492d58b"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Represents a <a class="el" href="namespace_music_brainz.html">MusicBrainz</a> user. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6ad485bfd15d7555f1d25d48a1af233d"></a><!-- doxytag: member="MusicBrainz::User::User" ref="a6ad485bfd15d7555f1d25d48a1af233d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MusicBrainz::User::User </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="acb58b97eabe10ab0e871985877f5392c"></a><!-- doxytag: member="MusicBrainz::User::~User" ref="acb58b97eabe10ab0e871985877f5392c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual MusicBrainz::User::~User </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aed377677d6a230bec7a727243f2ee19d"></a><!-- doxytag: member="MusicBrainz::User::addType" ref="aed377677d6a230bec7a727243f2ee19d" args="(const std::string &type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MusicBrainz::User::addType </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>type</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a type to the list of types. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>a string containing absolute URIs</td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf" title="Returns the types of this user.">getTypes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ac59f784bdff80cb0c770a9b1c88db34e"></a><!-- doxytag: member="MusicBrainz::User::getName" ref="ac59f784bdff80cb0c770a9b1c88db34e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string MusicBrainz::User::getName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the user name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string containing the user name </dd></dl>
</div>
</div>
<a class="anchor" id="a1746f221582cc67844d73338ac473ac3"></a><!-- doxytag: member="MusicBrainz::User::getNumTypes" ref="a1746f221582cc67844d73338ac473ac3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MusicBrainz::User::getNumTypes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns number of types. </p>
<p>This is equivalent to <code><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf" title="Returns the types of this user.">getTypes()</a></code>.size()</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>an int containing number of types</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf" title="Returns the types of this user.">getTypes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a488f9ab7cfe6ec5bb8ea5ea78c1f503b"></a><!-- doxytag: member="MusicBrainz::User::getShowNag" ref="a488f9ab7cfe6ec5bb8ea5ea78c1f503b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool MusicBrainz::User::getShowNag </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if a nag screen should be displayed to the user. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd><em>true</em> or <em>false</em> </dd></dl>
</div>
</div>
<a class="anchor" id="aaa7f18190801bf37f27cdbd5ec1a47e5"></a><!-- doxytag: member="MusicBrainz::User::getType" ref="aaa7f18190801bf37f27cdbd5ec1a47e5" args="(int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string MusicBrainz::User::getType </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns an type specified by index. </p>
<p>This is equivalent to <code><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf" title="Returns the types of this user.">getTypes()</a></code>[index]</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>a string containing the type</dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_music_brainz_1_1_user.html#aaada79b7230d65d22baf819f8244f7bf" title="Returns the types of this user.">getTypes</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aaada79b7230d65d22baf819f8244f7bf"></a><!-- doxytag: member="MusicBrainz::User::getTypes" ref="aaada79b7230d65d22baf819f8244f7bf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<std::string>& MusicBrainz::User::getTypes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the types of this user. </p>
<p>Most users' type list is empty. Currently, the following types are defined:</p>
<ul>
<li><em>"http://musicbrainz.org/ns/ext-1.0#AutoEditor"</em> </li>
<li><em>"http://musicbrainz.org/ns/ext-1.0#RelationshipEditor"</em> </li>
<li><em>"http://musicbrainz.org/ns/ext-1.0#Bot"</em> </li>
<li><em>"http://musicbrainz.org/ns/ext-1.0#NotNaggable"</em> </li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>a vector of strings containing absolute URIs </dd></dl>
</div>
</div>
<a class="anchor" id="af517f8a7b1f35f7acbcb837b7b3ff0a2"></a><!-- doxytag: member="MusicBrainz::User::setName" ref="af517f8a7b1f35f7acbcb837b7b3ff0a2" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MusicBrainz::User::setName </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the user name. </p>
<dl><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>a string containing the user name </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa8c16fff34e79092c1aef0e2a492d58b"></a><!-- doxytag: member="MusicBrainz::User::setShowNag" ref="aa8c16fff34e79092c1aef0e2a492d58b" args="(bool value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MusicBrainz::User::setShowNag </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the value of the nag screen flag. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td><em>true</em> or <em>false</em> </td></tr>
</table>
</dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_music_brainz_1_1_user.html#a488f9ab7cfe6ec5bb8ea5ea78c1f503b" title="Returns true if a nag screen should be displayed to the user.">getShowNag</a> </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
