<!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::LabelIncludes Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libmusicbrainz3 <span id="projectnumber">3.0.3</span></div> </td> </tr> </tbody> </table> </div> <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="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 id="searchli"> <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="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> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('class_music_brainz_1_1_label_includes.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <h1>MusicBrainz::LabelIncludes Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="MusicBrainz::LabelIncludes" --><!-- doxytag: inherits="MusicBrainz::IIncludes" --> <p>A specification on how much data to return with a label. <a href="#_details">More...</a></p> <div class="dynheader"> Inheritance diagram for MusicBrainz::LabelIncludes:</div> <div class="dyncontent"> <div class="center"> <img src="class_music_brainz_1_1_label_includes.png" usemap="#MusicBrainz::LabelIncludes_map" alt=""/> <map id="MusicBrainz::LabelIncludes_map" name="MusicBrainz::LabelIncludes_map"> <area href="class_music_brainz_1_1_i_includes.html" alt="MusicBrainz::IIncludes" shape="rect" coords="0,0,166,24"/> </map> </div></div> <p><a href="class_music_brainz_1_1_label_includes-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="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a149952d79d2d2e24ad6b720e5174c2a0">aliases</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include aliases. <a href="#a149952d79d2d2e24ad6b720e5174c2a0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#af8cf5b64d49c785f5ca250942159a53c">artistRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include artist relations. <a href="#af8cf5b64d49c785f5ca250942159a53c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a27d64aba9371e19bd0c9f59dfafd1d47">labelRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include label relations. <a href="#a27d64aba9371e19bd0c9f59dfafd1d47"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#ac1c66a2ebd8cabe5ba8ace58bb20e914">releaseRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include release relations. <a href="#ac1c66a2ebd8cabe5ba8ace58bb20e914"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a5c34446925dd2f7c2e2a0f35eae652e9">trackRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include track relations. <a href="#a5c34446925dd2f7c2e2a0f35eae652e9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a6f0fee356af2490da954a2a995ede75c">urlRelations</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include URL relations. <a href="#a6f0fee356af2490da954a2a995ede75c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a8b8765247627487042deb38cd45c6076">ratings</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include ratings. <a href="#a8b8765247627487042deb38cd45c6076"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#aae4c1ab0db25aac95426781a47ddba87">tags</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Include tags. <a href="#aae4c1ab0db25aac95426781a47ddba87"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_music_brainz_1_1_i_includes.html#afecd9a28c3be5892ec4ce11bcb4fd66e">IncludeList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_music_brainz_1_1_label_includes.html#a1af2a1bbf8e5adc1af070e3fbc9f0c40">createIncludeTags</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of strings containing include parameters for the <a class="el" href="class_music_brainz_1_1_web_service.html" title="An interface to the MusicBrainz XML web service via HTTP.">WebService</a>. <a href="#a1af2a1bbf8e5adc1af070e3fbc9f0c40"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A specification on how much data to return with a label. </p> <p>This implementation uses <em>method</em> <em>chaining</em> to define list of includes.</p> <p>Example usage: </p> <div class="fragment"><pre class="fragment"> LabelIncludes inc = LabelIncludes().aliases().urlRelations(); </pre></div> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a149952d79d2d2e24ad6b720e5174c2a0"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::aliases" ref="a149952d79d2d2e24ad6b720e5174c2a0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::aliases </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include aliases. </p> </div> </div> <a class="anchor" id="af8cf5b64d49c785f5ca250942159a53c"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::artistRelations" ref="af8cf5b64d49c785f5ca250942159a53c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::artistRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include artist relations. </p> </div> </div> <a class="anchor" id="a1af2a1bbf8e5adc1af070e3fbc9f0c40"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::createIncludeTags" ref="a1af2a1bbf8e5adc1af070e3fbc9f0c40" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_i_includes.html#afecd9a28c3be5892ec4ce11bcb4fd66e">IncludeList</a> MusicBrainz::LabelIncludes::createIncludeTags </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a list of strings containing include parameters for the <a class="el" href="class_music_brainz_1_1_web_service.html" title="An interface to the MusicBrainz XML web service via HTTP.">WebService</a>. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>a list of strings </dd></dl> <p>Implements <a class="el" href="class_music_brainz_1_1_i_includes.html#abb1b62f7882ada1f52f09c044f8f0a0c">MusicBrainz::IIncludes</a>.</p> </div> </div> <a class="anchor" id="a27d64aba9371e19bd0c9f59dfafd1d47"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::labelRelations" ref="a27d64aba9371e19bd0c9f59dfafd1d47" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::labelRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include label relations. </p> </div> </div> <a class="anchor" id="a8b8765247627487042deb38cd45c6076"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::ratings" ref="a8b8765247627487042deb38cd45c6076" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::ratings </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include ratings. </p> </div> </div> <a class="anchor" id="ac1c66a2ebd8cabe5ba8ace58bb20e914"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::releaseRelations" ref="ac1c66a2ebd8cabe5ba8ace58bb20e914" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::releaseRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include release relations. </p> </div> </div> <a class="anchor" id="aae4c1ab0db25aac95426781a47ddba87"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::tags" ref="aae4c1ab0db25aac95426781a47ddba87" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::tags </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include tags. </p> </div> </div> <a class="anchor" id="a5c34446925dd2f7c2e2a0f35eae652e9"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::trackRelations" ref="a5c34446925dd2f7c2e2a0f35eae652e9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::trackRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include track relations. </p> </div> </div> <a class="anchor" id="a6f0fee356af2490da954a2a995ede75c"></a><!-- doxytag: member="MusicBrainz::LabelIncludes::urlRelations" ref="a6f0fee356af2490da954a2a995ede75c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a>& MusicBrainz::LabelIncludes::urlRelations </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Include URL relations. </p> </div> </div> </div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespace_music_brainz.html">MusicBrainz</a> </li> <li class="navelem"><a class="el" href="class_music_brainz_1_1_label_includes.html">LabelIncludes</a> </li> <li class="footer">Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li> </ul> </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><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </body> </html>