Initial release
This commit is contained in:
@@ -0,0 +1,804 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||||
<meta name="generator" content="Doxygen 1.13.2"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>Base Module: fstdmethods.h File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
<script type="text/javascript" src="dynsections.js"></script>
|
||||
<script type="text/javascript" src="clipboard.js"></script>
|
||||
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="navtreedata.js"></script>
|
||||
<script type="text/javascript" src="navtree.js"></script>
|
||||
<script type="text/javascript" src="resize.js"></script>
|
||||
<script type="text/javascript" src="cookie.js"></script>
|
||||
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="search/searchdata.js"></script>
|
||||
<script type="text/javascript" src="search/search.js"></script>
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||||
<link href="smtg_extra.css" rel="stylesheet" type="text/css"/>
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr id="projectrow">
|
||||
<td id="projectalign">
|
||||
<div id="projectname">Base Module<span id="projectnumber"> VST 3.8</span>
|
||||
</div>
|
||||
<div id="projectbrief">SDK for developing VST plug-in</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.13.2 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() { codefold.init(0); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function() {
|
||||
initMenu('',true,false,'search.php','Search',true);
|
||||
$(function() { init_search(); });
|
||||
});
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
</div><!-- top -->
|
||||
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||||
<div id="nav-tree">
|
||||
<div id="nav-tree-contents">
|
||||
<div id="nav-sync" class="sync"></div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="splitbar" style="-moz-user-select:none;"
|
||||
class="ui-resizable-handle">
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
$(function(){initNavTree('fstdmethods_8h.html',''); initResizable(true); });
|
||||
/* @license-end */
|
||||
</script>
|
||||
<div id="doc-content">
|
||||
<!-- window showing the filter options -->
|
||||
<div id="MSearchSelectWindow"
|
||||
onmouseover="return searchBox.OnSearchSelectShow()"
|
||||
onmouseout="return searchBox.OnSearchSelectHide()"
|
||||
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||||
</div>
|
||||
|
||||
<!-- iframe showing the search results (closed by default) -->
|
||||
<div id="MSearchResultsWindow">
|
||||
<div id="MSearchResults">
|
||||
<div class="SRPage">
|
||||
<div id="SRIndex">
|
||||
<div id="SRResults"></div>
|
||||
<div class="SRStatus" id="Loading">Loading...</div>
|
||||
<div class="SRStatus" id="Searching">Searching...</div>
|
||||
<div class="SRStatus" id="NoMatches">No Matches</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#define-members">Macros</a> </div>
|
||||
<div class="headertitle"><div class="title">fstdmethods.h File Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Convenient macros to create setter and getter methods.
|
||||
<a href="#details">More...</a></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
||||
Macros</h2></td></tr>
|
||||
<tr class="memitem:ac7b33405a809656816db90c2e08874fc" id="r_ac7b33405a809656816db90c2e08874fc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7b33405a809656816db90c2e08874fc">DEFINE_VARIABLE</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="separator:ac7b33405a809656816db90c2e08874fc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a1ca15419dc50b5ec2cc22adad87ed510" id="r_a1ca15419dc50b5ec2cc22adad87ed510"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ca15419dc50b5ec2cc22adad87ed510">DEFINE_POINTER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="separator:a1ca15419dc50b5ec2cc22adad87ed510"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7bdc96c0dcfb2b23658d8f985a83048b" id="r_a7bdc96c0dcfb2b23658d8f985a83048b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7bdc96c0dcfb2b23658d8f985a83048b">DEFINE_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="separator:a7bdc96c0dcfb2b23658d8f985a83048b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aca2d3c80e58016d970e75479136fe8bf" id="r_aca2d3c80e58016d970e75479136fe8bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#aca2d3c80e58016d970e75479136fe8bf">COMPARE_BY_MEMBER_METHODS</a>(className, memberName)</td></tr>
|
||||
<tr class="separator:aca2d3c80e58016d970e75479136fe8bf"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a236e4ee9734fadabedc1f4d6e877e2ab" id="r_a236e4ee9734fadabedc1f4d6e877e2ab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a236e4ee9734fadabedc1f4d6e877e2ab">COMPARE_BY_MEMORY_METHODS</a>(className)</td></tr>
|
||||
<tr class="separator:a236e4ee9734fadabedc1f4d6e877e2ab"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad013585d1ece4615f652ec6bf5929cef" id="r_ad013585d1ece4615f652ec6bf5929cef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad013585d1ece4615f652ec6bf5929cef">COMPARE_BY_COMPARE_METHOD</a>(className, methodName)</td></tr>
|
||||
<tr class="separator:ad013585d1ece4615f652ec6bf5929cef"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr><td colspan="2"><div class="groupHeader">Methods for flags.</div></td></tr>
|
||||
<tr><td colspan="2"><div class="groupText"><p>Macros to create setter and getter methods for flags.</p>
|
||||
<p>Usage example with DEFINE_STATE: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyClass</div>
|
||||
<div class="line">{</div>
|
||||
<div class="line"><span class="keyword">public</span>:</div>
|
||||
<div class="line"> MyClass () : flags (0) {}</div>
|
||||
<div class="line"> <a class="code hl_define" href="#ad2fa6d3fa7d143009198b5b4d744c2dc">DEFINE_FLAG</a> (flags, isFlagged, 1<<0)</div>
|
||||
<div class="line"> <a class="code hl_define" href="#ad2fa6d3fa7d143009198b5b4d744c2dc">DEFINE_FLAG</a> (flags, isMine, 1<<1)</div>
|
||||
<div class="line">private:</div>
|
||||
<div class="line"> uint32 flags;</div>
|
||||
<div class="line">};</div>
|
||||
<div class="line"><span class="keywordtype">void</span> someFunction ()</div>
|
||||
<div class="line">{</div>
|
||||
<div class="line"> MyClass c;</div>
|
||||
<div class="line"> <span class="keywordflow">if</span> (c.isFlagged ()) <span class="comment">// check the flag</span></div>
|
||||
<div class="line"> c.isFlagged (<span class="keyword">false</span>); <span class="comment">// set the flag</span></div>
|
||||
<div class="line">}</div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_ad2fa6d3fa7d143009198b5b4d744c2dc"><div class="ttname"><a href="#ad2fa6d3fa7d143009198b5b4d744c2dc">DEFINE_FLAG</a></div><div class="ttdeci">#define DEFINE_FLAG(flagVar, methodName, value)</div><div class="ttdoc">Create Methods.</div><div class="ttdef"><b>Definition</b> fstdmethods.h:62</div></div>
|
||||
</div><!-- fragment --> </div></td></tr>
|
||||
<tr class="memitem:a3aa7211bde6c894d83fb000e32667c45" id="r_a3aa7211bde6c894d83fb000e32667c45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3aa7211bde6c894d83fb000e32667c45">DEFINE_STATE</a>(flagVar, methodName, value)</td></tr>
|
||||
<tr class="memdesc:a3aa7211bde6c894d83fb000e32667c45"><td class="mdescLeft"> </td><td class="mdescRight">Create Methods with <code>get</code> and <code>set</code> prefix. <br /></td></tr>
|
||||
<tr class="separator:a3aa7211bde6c894d83fb000e32667c45"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8eaa236016023ebe7fc553a03529d4b9" id="r_a8eaa236016023ebe7fc553a03529d4b9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8eaa236016023ebe7fc553a03529d4b9">DEFINE_GETSTATE</a>(flagVar, methodName, value)</td></tr>
|
||||
<tr class="memdesc:a8eaa236016023ebe7fc553a03529d4b9"><td class="mdescLeft"> </td><td class="mdescRight">Create Methods with <code>get</code> prefix. <br /></td></tr>
|
||||
<tr class="separator:a8eaa236016023ebe7fc553a03529d4b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad2fa6d3fa7d143009198b5b4d744c2dc" id="r_ad2fa6d3fa7d143009198b5b4d744c2dc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad2fa6d3fa7d143009198b5b4d744c2dc">DEFINE_FLAG</a>(flagVar, methodName, value)</td></tr>
|
||||
<tr class="memdesc:ad2fa6d3fa7d143009198b5b4d744c2dc"><td class="mdescLeft"> </td><td class="mdescRight">Create Methods. <br /></td></tr>
|
||||
<tr class="separator:ad2fa6d3fa7d143009198b5b4d744c2dc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8095ab68981a9e2ab6e471a6f1b515f6" id="r_a8095ab68981a9e2ab6e471a6f1b515f6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8095ab68981a9e2ab6e471a6f1b515f6">DEFINE_GETFLAG</a>(flagVar, methodName, value)</td></tr>
|
||||
<tr class="memdesc:a8095ab68981a9e2ab6e471a6f1b515f6"><td class="mdescLeft"> </td><td class="mdescRight">Create Methods. <br /></td></tr>
|
||||
<tr class="separator:a8095ab68981a9e2ab6e471a6f1b515f6"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5d0a2bb91ac8f0fc96153c610f872a92" id="r_a5d0a2bb91ac8f0fc96153c610f872a92"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5d0a2bb91ac8f0fc96153c610f872a92">DEFINE_FLAG_STATIC</a>(flagVar, methodName, value)</td></tr>
|
||||
<tr class="memdesc:a5d0a2bb91ac8f0fc96153c610f872a92"><td class="mdescLeft"> </td><td class="mdescRight">Create <code>static</code> Methods. <br /></td></tr>
|
||||
<tr class="separator:a5d0a2bb91ac8f0fc96153c610f872a92"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr><td colspan="2"><div class="groupHeader">Methods for data members.</div></td></tr>
|
||||
<tr><td colspan="2"><div class="groupText"><p>Macros to create setter and getter methods for class members.</p>
|
||||
<p><b>Examples:</b> </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyClass</div>
|
||||
<div class="line">{</div>
|
||||
<div class="line"><span class="keyword">public</span>:</div>
|
||||
<div class="line"> <a class="code hl_define" href="#a796d97a5cd47b9a00411cf71ab6ebf71">DATA_MEMBER</a> (<span class="keywordtype">double</span>, distance, Distance)</div>
|
||||
<div class="line"> <a class="code hl_define" href="#a0efb389fce03cc1bc8190565a8adaa0a">STRING_MEMBER</a> (<a class="code hl_class" href="classSteinberg_1_1String.html">Steinberg::String</a>, name, Name)</div>
|
||||
<div class="line"> <a class="code hl_define" href="#a9fe746aafac5178bf27bf6ac3fcaca4c">SHARED_MEMBER</a> (FUnknown, userData, UserData)</div>
|
||||
<div class="line"> <a class="code hl_define" href="#a8bc055fe95609ed757fbc5f03b5c28c1">CLASS_MEMBER</a> (<a class="code hl_class" href="classSteinberg_1_1Buffer.html">Steinberg::Buffer</a>, bufferData, BufferData)</div>
|
||||
<div class="line"> <a class="code hl_define" href="#a894c0fe14fa8fad008264abe4a3660b1">POINTER_MEMBER</a> (<a class="code hl_class" href="classSteinberg_1_1FObject.html">Steinberg::FObject</a>, refOnly, RefOnly) </div>
|
||||
<div class="line">};</div>
|
||||
<div class="ttc" id="aclassSteinberg_1_1Buffer_html"><div class="ttname"><a href="classSteinberg_1_1Buffer.html">Steinberg::Buffer</a></div><div class="ttdoc">Buffer.</div><div class="ttdef"><b>Definition</b> fbuffer.h:36</div></div>
|
||||
<div class="ttc" id="aclassSteinberg_1_1FObject_html"><div class="ttname"><a href="classSteinberg_1_1FObject.html">Steinberg::FObject</a></div><div class="ttdoc">Implements FUnknown and IDependent.</div><div class="ttdef"><b>Definition</b> fobject.h:65</div></div>
|
||||
<div class="ttc" id="aclassSteinberg_1_1String_html"><div class="ttname"><a href="classSteinberg_1_1String.html">Steinberg::String</a></div><div class="ttdoc">String.</div><div class="ttdef"><b>Definition</b> fstring.h:298</div></div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a0efb389fce03cc1bc8190565a8adaa0a"><div class="ttname"><a href="#a0efb389fce03cc1bc8190565a8adaa0a">STRING_MEMBER</a></div><div class="ttdeci">#define STRING_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:130</div></div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a796d97a5cd47b9a00411cf71ab6ebf71"><div class="ttname"><a href="#a796d97a5cd47b9a00411cf71ab6ebf71">DATA_MEMBER</a></div><div class="ttdeci">#define DATA_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:100</div></div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a894c0fe14fa8fad008264abe4a3660b1"><div class="ttname"><a href="#a894c0fe14fa8fad008264abe4a3660b1">POINTER_MEMBER</a></div><div class="ttdeci">#define POINTER_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:112</div></div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a8bc055fe95609ed757fbc5f03b5c28c1"><div class="ttname"><a href="#a8bc055fe95609ed757fbc5f03b5c28c1">CLASS_MEMBER</a></div><div class="ttdeci">#define CLASS_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:106</div></div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a9fe746aafac5178bf27bf6ac3fcaca4c"><div class="ttname"><a href="#a9fe746aafac5178bf27bf6ac3fcaca4c">SHARED_MEMBER</a></div><div class="ttdeci">#define SHARED_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:118</div></div>
|
||||
</div><!-- fragment --> </div></td></tr>
|
||||
<tr class="memitem:a796d97a5cd47b9a00411cf71ab6ebf71" id="r_a796d97a5cd47b9a00411cf71ab6ebf71"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a796d97a5cd47b9a00411cf71ab6ebf71">DATA_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a796d97a5cd47b9a00411cf71ab6ebf71"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a796d97a5cd47b9a00411cf71ab6ebf71"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8bc055fe95609ed757fbc5f03b5c28c1" id="r_a8bc055fe95609ed757fbc5f03b5c28c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8bc055fe95609ed757fbc5f03b5c28c1">CLASS_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a8bc055fe95609ed757fbc5f03b5c28c1"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a8bc055fe95609ed757fbc5f03b5c28c1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a894c0fe14fa8fad008264abe4a3660b1" id="r_a894c0fe14fa8fad008264abe4a3660b1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a894c0fe14fa8fad008264abe4a3660b1">POINTER_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a894c0fe14fa8fad008264abe4a3660b1"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a894c0fe14fa8fad008264abe4a3660b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9fe746aafac5178bf27bf6ac3fcaca4c" id="r_a9fe746aafac5178bf27bf6ac3fcaca4c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9fe746aafac5178bf27bf6ac3fcaca4c">SHARED_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a9fe746aafac5178bf27bf6ac3fcaca4c"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a9fe746aafac5178bf27bf6ac3fcaca4c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a5c19e8bb326e36e0ffd0ec5447c38dd4" id="r_a5c19e8bb326e36e0ffd0ec5447c38dd4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c19e8bb326e36e0ffd0ec5447c38dd4">OWNED_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a5c19e8bb326e36e0ffd0ec5447c38dd4"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a5c19e8bb326e36e0ffd0ec5447c38dd4"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a0efb389fce03cc1bc8190565a8adaa0a" id="r_a0efb389fce03cc1bc8190565a8adaa0a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0efb389fce03cc1bc8190565a8adaa0a">STRING_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a0efb389fce03cc1bc8190565a8adaa0a"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a0efb389fce03cc1bc8190565a8adaa0a"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a7f1231ffc827e3c4244a9b30c43ed5e2" id="r_a7f1231ffc827e3c4244a9b30c43ed5e2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7f1231ffc827e3c4244a9b30c43ed5e2">STRING8_MEMBER</a>(type, varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a7f1231ffc827e3c4244a9b30c43ed5e2"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a7f1231ffc827e3c4244a9b30c43ed5e2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a19e11906d2147132f158e03e253398a1" id="r_a19e11906d2147132f158e03e253398a1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#a19e11906d2147132f158e03e253398a1">STRING_MEMBER_STD</a>(varName, methodName)</td></tr>
|
||||
<tr class="memdesc:a19e11906d2147132f158e03e253398a1"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:a19e11906d2147132f158e03e253398a1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac846c65c8e67ae789595f6dd95cba54c" id="r_ac846c65c8e67ae789595f6dd95cba54c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac846c65c8e67ae789595f6dd95cba54c">STRING8_MEMBER_STD</a>(varName, methodName)</td></tr>
|
||||
<tr class="memdesc:ac846c65c8e67ae789595f6dd95cba54c"><td class="mdescLeft"> </td><td class="mdescRight">Build-in member (pass by value). <br /></td></tr>
|
||||
<tr class="separator:ac846c65c8e67ae789595f6dd95cba54c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>Convenient macros to create setter and getter methods. </p>
|
||||
</div><h2 class="groupheader">Macro Definition Documentation</h2>
|
||||
<a id="a3aa7211bde6c894d83fb000e32667c45" name="a3aa7211bde6c894d83fb000e32667c45"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a3aa7211bde6c894d83fb000e32667c45">◆ </a></span>DEFINE_STATE</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_STATE</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>flagVar</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> set##methodName (<span class="keywordtype">bool</span> state) { <span class="keywordflow">if</span> (state) flagVar |= (value); <span class="keywordflow">else</span> flagVar &= ~(value); }\</div>
|
||||
<div class="line"><span class="keywordtype">bool</span> get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> (flagVar & (value)) != 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Create Methods with <code>get</code> and <code>set</code> prefix. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a8eaa236016023ebe7fc553a03529d4b9" name="a8eaa236016023ebe7fc553a03529d4b9"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a8eaa236016023ebe7fc553a03529d4b9">◆ </a></span>DEFINE_GETSTATE</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_GETSTATE</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>flagVar</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">bool</span> get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> (flagVar & (value)) != 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Create Methods with <code>get</code> prefix. </p>
|
||||
<p>There is only a 'get' method. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad2fa6d3fa7d143009198b5b4d744c2dc" name="ad2fa6d3fa7d143009198b5b4d744c2dc"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad2fa6d3fa7d143009198b5b4d744c2dc">◆ </a></span>DEFINE_FLAG</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_FLAG</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>flagVar</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">void</span> methodName (<span class="keywordtype">bool</span> state) { <span class="keywordflow">if</span> (state) flagVar |= (value); <span class="keywordflow">else</span> flagVar &= ~(value); }\</div>
|
||||
<div class="line"><span class="keywordtype">bool</span> methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> (flagVar & (value)) != 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Create Methods. </p>
|
||||
<p>Same name for the getter and setter. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a8095ab68981a9e2ab6e471a6f1b515f6" name="a8095ab68981a9e2ab6e471a6f1b515f6"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a8095ab68981a9e2ab6e471a6f1b515f6">◆ </a></span>DEFINE_GETFLAG</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_GETFLAG</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>flagVar</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordtype">bool</span> methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> (flagVar & (value)) != 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Create Methods. </p>
|
||||
<p>There is only a 'get' method. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a5d0a2bb91ac8f0fc96153c610f872a92" name="a5d0a2bb91ac8f0fc96153c610f872a92"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5d0a2bb91ac8f0fc96153c610f872a92">◆ </a></span>DEFINE_FLAG_STATIC</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_FLAG_STATIC</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>flagVar</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>value</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> methodName (<span class="keywordtype">bool</span> __state) { <span class="keywordflow">if</span> (__state) flagVar |= (value); <span class="keywordflow">else</span> flagVar &= ~(value); }\</div>
|
||||
<div class="line"><span class="keyword">static</span> <span class="keywordtype">bool</span> methodName () { <span class="keywordflow">return</span> (flagVar & (value)) != 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Create <code>static</code> Methods. </p>
|
||||
<p>Same name for the getter and setter. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a796d97a5cd47b9a00411cf71ab6ebf71" name="a796d97a5cd47b9a00411cf71ab6ebf71"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a796d97a5cd47b9a00411cf71ab6ebf71">◆ </a></span>DATA_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DATA_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (type v) { varName = v;}\</div>
|
||||
<div class="line">type get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">protected</span>: type varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a8bc055fe95609ed757fbc5f03b5c28c1" name="a8bc055fe95609ed757fbc5f03b5c28c1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a8bc055fe95609ed757fbc5f03b5c28c1">◆ </a></span>CLASS_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define CLASS_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (<span class="keyword">const</span> type& v){ varName = v;}\</div>
|
||||
<div class="line"><span class="keyword">const</span> type& get##methodName ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">protected</span>: type varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a894c0fe14fa8fad008264abe4a3660b1" name="a894c0fe14fa8fad008264abe4a3660b1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a894c0fe14fa8fad008264abe4a3660b1">◆ </a></span>POINTER_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define POINTER_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (type* ptr){ varName = ptr;}\</div>
|
||||
<div class="line">type* get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">private</span>: type* varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a9fe746aafac5178bf27bf6ac3fcaca4c" name="a9fe746aafac5178bf27bf6ac3fcaca4c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a9fe746aafac5178bf27bf6ac3fcaca4c">◆ </a></span>SHARED_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define SHARED_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (type* v){ varName = v;}\</div>
|
||||
<div class="line">type* get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">private</span>: IPtr<type> varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a5c19e8bb326e36e0ffd0ec5447c38dd4" name="a5c19e8bb326e36e0ffd0ec5447c38dd4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a5c19e8bb326e36e0ffd0ec5447c38dd4">◆ </a></span>OWNED_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define OWNED_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (type* v){ varName = v;}\</div>
|
||||
<div class="line">type* get##methodName ()<span class="keyword">const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">private</span>: OPtr<type> varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a0efb389fce03cc1bc8190565a8adaa0a" name="a0efb389fce03cc1bc8190565a8adaa0a"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a0efb389fce03cc1bc8190565a8adaa0a">◆ </a></span>STRING_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define STRING_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (<span class="keyword">const</span> tchar* v){ varName = v;}\</div>
|
||||
<div class="line"><span class="keyword">const</span> type& get##methodName ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">protected</span>: type varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7f1231ffc827e3c4244a9b30c43ed5e2" name="a7f1231ffc827e3c4244a9b30c43ed5e2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7f1231ffc827e3c4244a9b30c43ed5e2">◆ </a></span>STRING8_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define STRING8_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><span class="keyword">public</span>:<span class="keywordtype">void</span> set##methodName (<span class="keyword">const</span> char8* v){ varName = v;}\</div>
|
||||
<div class="line"><span class="keyword">const</span> type& get##methodName ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> varName; }\</div>
|
||||
<div class="line"><span class="keyword">protected</span>: type varName; <span class="keyword">public</span>:</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a19e11906d2147132f158e03e253398a1" name="a19e11906d2147132f158e03e253398a1"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a19e11906d2147132f158e03e253398a1">◆ </a></span>STRING_MEMBER_STD</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define STRING_MEMBER_STD</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a0efb389fce03cc1bc8190565a8adaa0a">STRING_MEMBER</a>(<a class="code hl_class" href="classSteinberg_1_1String.html">Steinberg::String</a>,varName,methodName)</div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac846c65c8e67ae789595f6dd95cba54c" name="ac846c65c8e67ae789595f6dd95cba54c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac846c65c8e67ae789595f6dd95cba54c">◆ </a></span>STRING8_MEMBER_STD</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define STRING8_MEMBER_STD</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a7f1231ffc827e3c4244a9b30c43ed5e2">STRING8_MEMBER</a>(<a class="code hl_class" href="classSteinberg_1_1String.html">Steinberg::String</a>,varName,methodName)</div>
|
||||
<div class="ttc" id="afstdmethods_8h_html_a7f1231ffc827e3c4244a9b30c43ed5e2"><div class="ttname"><a href="#a7f1231ffc827e3c4244a9b30c43ed5e2">STRING8_MEMBER</a></div><div class="ttdeci">#define STRING8_MEMBER(type, varName, methodName)</div><div class="ttdoc">Build-in member (pass by value).</div><div class="ttdef"><b>Definition</b> fstdmethods.h:136</div></div>
|
||||
</div><!-- fragment -->
|
||||
<p>Build-in member (pass by value). </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ac7b33405a809656816db90c2e08874fc" name="ac7b33405a809656816db90c2e08874fc"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ac7b33405a809656816db90c2e08874fc">◆ </a></span>DEFINE_VARIABLE</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_VARIABLE</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a796d97a5cd47b9a00411cf71ab6ebf71">DATA_MEMBER</a>(type,varName,methodName)</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1ca15419dc50b5ec2cc22adad87ed510" name="a1ca15419dc50b5ec2cc22adad87ed510"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1ca15419dc50b5ec2cc22adad87ed510">◆ </a></span>DEFINE_POINTER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_POINTER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a894c0fe14fa8fad008264abe4a3660b1">POINTER_MEMBER</a>(type,varName,methodName)</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a7bdc96c0dcfb2b23658d8f985a83048b" name="a7bdc96c0dcfb2b23658d8f985a83048b"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a7bdc96c0dcfb2b23658d8f985a83048b">◆ </a></span>DEFINE_MEMBER</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define DEFINE_MEMBER</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>varName</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"><a class="code hl_define" href="#a8bc055fe95609ed757fbc5f03b5c28c1">CLASS_MEMBER</a>(type,varName,methodName)</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="aca2d3c80e58016d970e75479136fe8bf" name="aca2d3c80e58016d970e75479136fe8bf"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aca2d3c80e58016d970e75479136fe8bf">◆ </a></span>COMPARE_BY_MEMBER_METHODS</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define COMPARE_BY_MEMBER_METHODS</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>className</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>memberName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> operator == (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName == other.memberName);} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator != (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName != other.memberName);} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator < (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName < other.memberName);} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator > (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName > other.memberName);} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator <= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName <= other.memberName);} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator >= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> (memberName >= other.memberName);}</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a236e4ee9734fadabedc1f4d6e877e2ab" name="a236e4ee9734fadabedc1f4d6e877e2ab"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a236e4ee9734fadabedc1f4d6e877e2ab">◆ </a></span>COMPARE_BY_MEMORY_METHODS</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define COMPARE_BY_MEMORY_METHODS</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>className</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> operator == (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) == 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator != (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) != 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator < (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) < 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator > (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) > 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator <= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) <= 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator >= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> memcmp (<span class="keyword">this</span>, &other, <span class="keyword">sizeof</span> (className)) >= 0;}</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad013585d1ece4615f652ec6bf5929cef" name="ad013585d1ece4615f652ec6bf5929cef"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad013585d1ece4615f652ec6bf5929cef">◆ </a></span>COMPARE_BY_COMPARE_METHOD</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">#define COMPARE_BY_COMPARE_METHOD</td>
|
||||
<td>(</td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>className</em></span>, </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="paramkey"></td>
|
||||
<td></td>
|
||||
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>methodName</em></span> )</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Value:</b><div class="fragment"><div class="line"> <span class="keywordtype">bool</span> operator == (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) == 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator != (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) != 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator < (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) < 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator > (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) > 0;} \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator <= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) <= 0; } \</div>
|
||||
<div class="line"> <span class="keywordtype">bool</span> operator >= (<span class="keyword">const</span> className& other)<span class="keyword"> const </span>{<span class="keywordflow">return</span> methodName (other) >= 0; }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
</div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<html>
|
||||
<head>
|
||||
<title>Empty</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
||||
<meta name="Author" content="Steinberg">
|
||||
</head>
|
||||
<body>
|
||||
<br/>
|
||||
<hr width="100%" size="2" align="left" />
|
||||
<div align=right>
|
||||
Copyright ©<span id="year"></span> <a href="http://www.steinberg.net" target="_blank"><u>Steinberg Media Technologies GmbH</u></a>.
|
||||
All Rights Reserved. This documentation is under this <a href="http://www.steinberg.net/sdklicenses" target="_blank"><u>license</u></a>.
|
||||
</div>
|
||||
<script>
|
||||
document.querySelector("#year").textContent = new Date().getFullYear();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user