Initial release
This commit is contained in:
@@ -0,0 +1,241 @@
|
||||
<!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: FBooleanSetter< T > Struct Template 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('structSteinberg_1_1FBooleanSetter.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="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-attribs">Public Attributes</a> |
|
||||
<a href="structSteinberg_1_1FBooleanSetter-members.html">List of all members</a> </div>
|
||||
<div class="headertitle"><div class="title">FBooleanSetter< T > Struct Template Reference</div></div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p>Class definition for objects that help resetting boolean variables.
|
||||
<a href="#details">More...</a></p>
|
||||
|
||||
<p><code>#include <fcleanup.h></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a184b4f0acbd0515534b0a8c161f9ee38" id="r_a184b4f0acbd0515534b0a8c161f9ee38"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a184b4f0acbd0515534b0a8c161f9ee38">FBooleanSetter</a> (T &_toSet)</td></tr>
|
||||
<tr class="memdesc:a184b4f0acbd0515534b0a8c161f9ee38"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
|
||||
<tr class="separator:a184b4f0acbd0515534b0a8c161f9ee38"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ab457975e1c24aeed9865251280280ca2" id="r_ab457975e1c24aeed9865251280280ca2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab457975e1c24aeed9865251280280ca2">~FBooleanSetter</a> ()</td></tr>
|
||||
<tr class="memdesc:ab457975e1c24aeed9865251280280ca2"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. Resets the at construction time passed boolean to FALSE. <br /></td></tr>
|
||||
<tr class="separator:ab457975e1c24aeed9865251280280ca2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
||||
Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:ad3d8bf7a93c1977f4c20dd6f66bd1f7c" id="r_ad3d8bf7a93c1977f4c20dd6f66bd1f7c"><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3d8bf7a93c1977f4c20dd6f66bd1f7c">toSet</a></td></tr>
|
||||
<tr class="memdesc:ad3d8bf7a93c1977f4c20dd6f66bd1f7c"><td class="mdescLeft"> </td><td class="mdescRight">Remembers the boolean that is to be reset during destruction. <br /></td></tr>
|
||||
<tr class="separator:ad3d8bf7a93c1977f4c20dd6f66bd1f7c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><div class="compoundTemplParams">template<class T><br />
|
||||
struct Steinberg::FBooleanSetter< T ></div><p>Class definition for objects that help resetting boolean variables. </p>
|
||||
<p>A stack allocated object of this type automatically sets an at construction time passed boolean variable immediately to TRUE and resets the same variable to FALSE when it reaches the end of its own scope. <br />
|
||||
<br />
|
||||
Intended usage: </p><div class="fragment"><div class="line"><span class="keywordtype">bool</span> theBoolean = <span class="keyword">false</span>;</div>
|
||||
<div class="line">{</div>
|
||||
<div class="line"> <a class="code hl_typedef" href="namespaceSteinberg.html#aac248a0d0bf4446d45f2539bc61f6c23">Steinberg::FBoolSetter</a> theBoolSetter (theBoolean);</div>
|
||||
<div class="line"> <span class="comment">// Here the constructor of theBoolSetter sets theBoolean to TRUE.</span></div>
|
||||
<div class="line"> </div>
|
||||
<div class="line"> <span class="comment">// Do something.</span></div>
|
||||
<div class="line"> </div>
|
||||
<div class="line">} <span class="comment">// Here the destructor of theBoolSetter resets theBoolean to FALSE.</span></div>
|
||||
<div class="ttc" id="anamespaceSteinberg_html_aac248a0d0bf4446d45f2539bc61f6c23"><div class="ttname"><a href="namespaceSteinberg.html#aac248a0d0bf4446d45f2539bc61f6c23">Steinberg::FBoolSetter</a></div><div class="ttdeci">FBooleanSetter< bool > FBoolSetter</div><div class="ttdef"><b>Definition</b> fcleanup.h:170</div></div>
|
||||
</div><!-- fragment --> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
<a id="a184b4f0acbd0515534b0a8c161f9ee38" name="a184b4f0acbd0515534b0a8c161f9ee38"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a184b4f0acbd0515534b0a8c161f9ee38">◆ </a></span>FBooleanSetter()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class T> </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname"><a class="el" href="structSteinberg_1_1FBooleanSetter.html">FBooleanSetter</a> </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">T &</td> <td class="paramname"><span class="paramname"><em>_toSet</em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Constructor. </p>
|
||||
<p>_toSet is a reference to the boolean that is set to TRUE immediately in this constructor call and gets reset to FALSE when this <a class="el" href="namespaceSteinberg.html#aac248a0d0bf4446d45f2539bc61f6c23">FBoolSetter</a> object's destructor is executed. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ab457975e1c24aeed9865251280280ca2" name="ab457975e1c24aeed9865251280280ca2"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ab457975e1c24aeed9865251280280ca2">◆ </a></span>~FBooleanSetter()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class T> </div>
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">~<a class="el" href="structSteinberg_1_1FBooleanSetter.html">FBooleanSetter</a> </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Destructor. Resets the at construction time passed boolean to FALSE. </p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Member Data Documentation</h2>
|
||||
<a id="ad3d8bf7a93c1977f4c20dd6f66bd1f7c" name="ad3d8bf7a93c1977f4c20dd6f66bd1f7c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad3d8bf7a93c1977f4c20dd6f66bd1f7c">◆ </a></span>toSet</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<div class="memtemplate">
|
||||
template<class T> </div>
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">T& toSet</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Remembers the boolean that is to be reset during destruction. </p>
|
||||
|
||||
</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