1043 lines
54 KiB
HTML
1043 lines
54 KiB
HTML
<!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: FObject Class 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('classSteinberg_1_1FObject.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-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#pro-static-attribs">Static Protected Attributes</a> |
|
|
<a href="classSteinberg_1_1FObject-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">FObject Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Implements FUnknown and IDependent.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <fobject.h></code></p>
|
|
<div id="dynsection-0" onclick="return dynsection.toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
|
|
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for FObject:</div>
|
|
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
|
|
</div>
|
|
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
|
|
<div class="center"><img src="classSteinberg_1_1FObject__inherit__graph.png" border="0" usemap="#aFObject_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aFObject_inherit__map" id="aFObject_inherit__map">
|
|
<area shape="rect" title="Implements FUnknown and IDependent." alt="" coords="206,117,338,528"/>
|
|
<area shape="rect" href="classSteinberg_1_1FDynLibrary.html" title="Platform independent dynamic library loader." alt="" coords="5,663,144,842"/>
|
|
<area shape="poly" title=" " alt="" coords="202,482,118,664,113,662,197,479"/>
|
|
<area shape="rect" href="classSteinberg_1_1StringObject.html" title="StringObject implements IStringResult and IString methods." alt="" coords="168,624,269,881"/>
|
|
<area shape="poly" title=" " alt="" coords="248,543,237,625,232,624,242,542"/>
|
|
<area shape="rect" href="classSteinberg_1_1Timer.html" title="Timer is a class that allows you to receive triggers at regular intervals." alt="" coords="293,711,358,794"/>
|
|
<area shape="poly" title=" " alt="" coords="302,542,323,711,318,712,297,543"/>
|
|
<area shape="rect" href="classSteinberg_1_1UpdateHandler.html" title="UpdateHandler implements IUpdateManager and IUpdateHandler to handle dependencies between objects to ..." alt="" coords="382,576,538,929"/>
|
|
<area shape="poly" title=" " alt="" coords="346,486,386,575,381,577,342,488"/>
|
|
<area shape="rect" title=" " alt="" coords="235,5,310,69"/>
|
|
<area shape="poly" title=" " alt="" coords="275,84,275,117,270,117,270,84"/>
|
|
</map>
|
|
</div>
|
|
<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:a437422592a0d826d2c3962fb7fff8404" id="r_a437422592a0d826d2c3962fb7fff8404"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a437422592a0d826d2c3962fb7fff8404">FObject</a> ()=default</td></tr>
|
|
<tr class="memdesc:a437422592a0d826d2c3962fb7fff8404"><td class="mdescLeft"> </td><td class="mdescRight">default constructor... <br /></td></tr>
|
|
<tr class="separator:a437422592a0d826d2c3962fb7fff8404"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0df169f35093cd89cf30109783cc900b" id="r_a0df169f35093cd89cf30109783cc900b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0df169f35093cd89cf30109783cc900b">FObject</a> (const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> &)</td></tr>
|
|
<tr class="separator:a0df169f35093cd89cf30109783cc900b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3f93f4dfecbe838c658bf1425e1db908" id="r_a3f93f4dfecbe838c658bf1425e1db908"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3f93f4dfecbe838c658bf1425e1db908">operator=</a> (const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> &)</td></tr>
|
|
<tr class="memdesc:a3f93f4dfecbe838c658bf1425e1db908"><td class="mdescLeft"> </td><td class="mdescRight">overloads operator "=" as the reference assignment <br /></td></tr>
|
|
<tr class="separator:a3f93f4dfecbe838c658bf1425e1db908"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bd63fda63882c46b7c08409f68ad23b" id="r_a6bd63fda63882c46b7c08409f68ad23b"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6bd63fda63882c46b7c08409f68ad23b">~FObject</a> ()</td></tr>
|
|
<tr class="memdesc:a6bd63fda63882c46b7c08409f68ad23b"><td class="mdescLeft"> </td><td class="mdescRight">destructor... <br /></td></tr>
|
|
<tr class="separator:a6bd63fda63882c46b7c08409f68ad23b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae90f8c54876fd8f1a191a44144d66c7" id="r_aae90f8c54876fd8f1a191a44144d66c7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aae90f8c54876fd8f1a191a44144d66c7">isA</a> () const</td></tr>
|
|
<tr class="memdesc:aae90f8c54876fd8f1a191a44144d66c7"><td class="mdescLeft"> </td><td class="mdescRight">a local alternative to getFClassID () <br /></td></tr>
|
|
<tr class="separator:aae90f8c54876fd8f1a191a44144d66c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a472e34bafb6415ae1054b6e4ffd9e3f5" id="r_a472e34bafb6415ae1054b6e4ffd9e3f5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a472e34bafb6415ae1054b6e4ffd9e3f5">isA</a> (<a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> s) const</td></tr>
|
|
<tr class="memdesc:a472e34bafb6415ae1054b6e4ffd9e3f5"><td class="mdescLeft"> </td><td class="mdescRight">evaluates if the passed ID is of the <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> type <br /></td></tr>
|
|
<tr class="separator:a472e34bafb6415ae1054b6e4ffd9e3f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7828bf1972d5be433fdd6320e109f3be" id="r_a7828bf1972d5be433fdd6320e109f3be"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7828bf1972d5be433fdd6320e109f3be">isTypeOf</a> (<a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> s, bool=true) const</td></tr>
|
|
<tr class="memdesc:a7828bf1972d5be433fdd6320e109f3be"><td class="mdescLeft"> </td><td class="mdescRight">evaluates if the passed ID is of the <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> type <br /></td></tr>
|
|
<tr class="separator:a7828bf1972d5be433fdd6320e109f3be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a127b5517d355d7870c5bc96d52ef9ef0" id="r_a127b5517d355d7870c5bc96d52ef9ef0"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a127b5517d355d7870c5bc96d52ef9ef0">getRefCount</a> ()</td></tr>
|
|
<tr class="memdesc:a127b5517d355d7870c5bc96d52ef9ef0"><td class="mdescLeft"> </td><td class="mdescRight">returns the current interface reference count <br /></td></tr>
|
|
<tr class="separator:a127b5517d355d7870c5bc96d52ef9ef0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86bda2cc9670209c191358a3b9fcab67" id="r_a86bda2cc9670209c191358a3b9fcab67"><td class="memItemLeft" align="right" valign="top">FUnknown * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a86bda2cc9670209c191358a3b9fcab67">unknownCast</a> ()</td></tr>
|
|
<tr class="memdesc:a86bda2cc9670209c191358a3b9fcab67"><td class="mdescLeft"> </td><td class="mdescRight">get FUnknown interface from object <br /></td></tr>
|
|
<tr class="separator:a86bda2cc9670209c191358a3b9fcab67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a18a9f05017946de2dc6942fc7b55b0" id="r_a9a18a9f05017946de2dc6942fc7b55b0"><td class="memItemLeft" align="right" valign="top">tresult </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a18a9f05017946de2dc6942fc7b55b0">queryInterface</a> (const TUID _iid, void **obj) SMTG_OVERRIDE</td></tr>
|
|
<tr class="memdesc:a9a18a9f05017946de2dc6942fc7b55b0"><td class="mdescLeft"> </td><td class="mdescRight">please refer to FUnknown::queryInterface () <br /></td></tr>
|
|
<tr class="separator:a9a18a9f05017946de2dc6942fc7b55b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab71f235d96a97eb6e56272b090694878" id="r_ab71f235d96a97eb6e56272b090694878"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab71f235d96a97eb6e56272b090694878">addRef</a> () SMTG_OVERRIDE</td></tr>
|
|
<tr class="memdesc:ab71f235d96a97eb6e56272b090694878"><td class="mdescLeft"> </td><td class="mdescRight">please refer to FUnknown::addref () <br /></td></tr>
|
|
<tr class="separator:ab71f235d96a97eb6e56272b090694878"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a936c8aef3cc4614fc83ca91233e99521" id="r_a936c8aef3cc4614fc83ca91233e99521"><td class="memItemLeft" align="right" valign="top">uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a936c8aef3cc4614fc83ca91233e99521">release</a> () SMTG_OVERRIDE</td></tr>
|
|
<tr class="memdesc:a936c8aef3cc4614fc83ca91233e99521"><td class="mdescLeft"> </td><td class="mdescRight">please refer to FUnknown::release () <br /></td></tr>
|
|
<tr class="separator:a936c8aef3cc4614fc83ca91233e99521"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeeeb082a829ee7b136a730a2a4029103" id="r_aeeeb082a829ee7b136a730a2a4029103"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeeeb082a829ee7b136a730a2a4029103">update</a> (FUnknown *, int32) SMTG_OVERRIDE</td></tr>
|
|
<tr class="memdesc:aeeeb082a829ee7b136a730a2a4029103"><td class="mdescLeft"> </td><td class="mdescRight">empty virtual method that should be overridden by derived classes for data updates upon changes <br /></td></tr>
|
|
<tr class="separator:aeeeb082a829ee7b136a730a2a4029103"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aad64a1f592d31c920bc72505ab860576" id="r_aad64a1f592d31c920bc72505ab860576"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aad64a1f592d31c920bc72505ab860576">addDependent</a> (IDependent *dep)</td></tr>
|
|
<tr class="memdesc:aad64a1f592d31c920bc72505ab860576"><td class="mdescLeft"> </td><td class="mdescRight">adds dependency to the object <br /></td></tr>
|
|
<tr class="separator:aad64a1f592d31c920bc72505ab860576"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4a343976011506b85607300a4bd97832" id="r_a4a343976011506b85607300a4bd97832"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a343976011506b85607300a4bd97832">removeDependent</a> (IDependent *dep)</td></tr>
|
|
<tr class="memdesc:a4a343976011506b85607300a4bd97832"><td class="mdescLeft"> </td><td class="mdescRight">removes dependency from the object <br /></td></tr>
|
|
<tr class="separator:a4a343976011506b85607300a4bd97832"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72f44c7bf8ec3cab12b95dde13542194" id="r_a72f44c7bf8ec3cab12b95dde13542194"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a72f44c7bf8ec3cab12b95dde13542194">changed</a> (int32 msg=kChanged)</td></tr>
|
|
<tr class="memdesc:a72f44c7bf8ec3cab12b95dde13542194"><td class="mdescLeft"> </td><td class="mdescRight">Inform all dependents, that the object has changed. <br /></td></tr>
|
|
<tr class="separator:a72f44c7bf8ec3cab12b95dde13542194"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad0cb02215c1c6e44b53f177e7844a9f5" id="r_ad0cb02215c1c6e44b53f177e7844a9f5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0cb02215c1c6e44b53f177e7844a9f5">deferUpdate</a> (int32 msg=kChanged)</td></tr>
|
|
<tr class="memdesc:ad0cb02215c1c6e44b53f177e7844a9f5"><td class="mdescLeft"> </td><td class="mdescRight">Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). <br /></td></tr>
|
|
<tr class="separator:ad0cb02215c1c6e44b53f177e7844a9f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0be193466912191a8ebbd75354edd935" id="r_a0be193466912191a8ebbd75354edd935"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0be193466912191a8ebbd75354edd935">updateDone</a> (int32)</td></tr>
|
|
<tr class="memdesc:a0be193466912191a8ebbd75354edd935"><td class="mdescLeft"> </td><td class="mdescRight">empty virtual method that should be overridden by derived classes <br /></td></tr>
|
|
<tr class="separator:a0be193466912191a8ebbd75354edd935"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a7c5326199ffb542719387b078ed6da" id="r_a5a7c5326199ffb542719387b078ed6da"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5a7c5326199ffb542719387b078ed6da">isEqualInstance</a> (FUnknown *d)</td></tr>
|
|
<tr class="separator:a5a7c5326199ffb542719387b078ed6da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46041b248461358d403e6ced65aa007a" id="r_a46041b248461358d403e6ced65aa007a"><td class="memTemplParams" colspan="2">template<class C> </td></tr>
|
|
<tr class="memitem:a46041b248461358d403e6ced65aa007a"><td class="memTemplItemLeft" align="right" valign="top">IPtr< C > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a46041b248461358d403e6ced65aa007a">fromUnknown</a> (FUnknown *unknown)</td></tr>
|
|
<tr class="separator:a46041b248461358d403e6ced65aa007a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a61fe4989547b521dfcac968665c376d9" id="r_a61fe4989547b521dfcac968665c376d9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61fe4989547b521dfcac968665c376d9">getFClassID</a> ()</td></tr>
|
|
<tr class="memdesc:a61fe4989547b521dfcac968665c376d9"><td class="mdescLeft"> </td><td class="mdescRight">return Class ID as an ASCII string (statically) <br /></td></tr>
|
|
<tr class="separator:a61fe4989547b521dfcac968665c376d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf312648bf542a9d35fd34e1564b07cb" id="r_abf312648bf542a9d35fd34e1564b07cb"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="#abf312648bf542a9d35fd34e1564b07cb">setUpdateHandler</a> (IUpdateHandler *handler)</td></tr>
|
|
<tr class="memdesc:abf312648bf542a9d35fd34e1564b07cb"><td class="mdescLeft"> </td><td class="mdescRight">set method for the local attribute <br /></td></tr>
|
|
<tr class="separator:abf312648bf542a9d35fd34e1564b07cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a603a8093a1d2e99527a89d3a15e5504a" id="r_a603a8093a1d2e99527a89d3a15e5504a"><td class="memItemLeft" align="right" valign="top">static IUpdateHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a603a8093a1d2e99527a89d3a15e5504a">getUpdateHandler</a> ()</td></tr>
|
|
<tr class="memdesc:a603a8093a1d2e99527a89d3a15e5504a"><td class="mdescLeft"> </td><td class="mdescRight">get method for the local attribute <br /></td></tr>
|
|
<tr class="separator:a603a8093a1d2e99527a89d3a15e5504a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af59fc037df86c95566a2f9874be552a4" id="r_af59fc037df86c95566a2f9874be552a4"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#af59fc037df86c95566a2f9874be552a4">classIDsEqual</a> (<a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> ci1, <a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> ci2)</td></tr>
|
|
<tr class="memdesc:af59fc037df86c95566a2f9874be552a4"><td class="mdescLeft"> </td><td class="mdescRight">compares (evaluates) 2 class IDs <br /></td></tr>
|
|
<tr class="separator:af59fc037df86c95566a2f9874be552a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a25d706b3e3dabc9e4c0d026f925d73" id="r_a0a25d706b3e3dabc9e4c0d026f925d73"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a25d706b3e3dabc9e4c0d026f925d73">unknownToObject</a> (FUnknown *unknown)</td></tr>
|
|
<tr class="memdesc:a0a25d706b3e3dabc9e4c0d026f925d73"><td class="mdescLeft"> </td><td class="mdescRight">pointer conversion from FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> <br /></td></tr>
|
|
<tr class="separator:a0a25d706b3e3dabc9e4c0d026f925d73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ca01e2c40b3e5c5d6bcc995c123b768" id="r_a6ca01e2c40b3e5c5d6bcc995c123b768"><td class="memTemplParams" colspan="2">template<class Class> </td></tr>
|
|
<tr class="memitem:a6ca01e2c40b3e5c5d6bcc995c123b768"><td class="memTemplItemLeft" align="right" valign="top">static IPtr< Class > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6ca01e2c40b3e5c5d6bcc995c123b768">fromUnknown</a> (FUnknown *unknown)</td></tr>
|
|
<tr class="memdesc:a6ca01e2c40b3e5c5d6bcc995c123b768"><td class="mdescLeft"> </td><td class="mdescRight">convert from FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> <br /></td></tr>
|
|
<tr class="separator:a6ca01e2c40b3e5c5d6bcc995c123b768"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ae78a44399218c930be44d3aa46521d0e" id="r_ae78a44399218c930be44d3aa46521d0e"><td class="memItemLeft" align="right" valign="top">static const FUID </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae78a44399218c930be44d3aa46521d0e">iid</a></td></tr>
|
|
<tr class="memdesc:ae78a44399218c930be44d3aa46521d0e"><td class="mdescLeft"> </td><td class="mdescRight">Special UID that is used to cast an FUnknown pointer to a <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>. <br /></td></tr>
|
|
<tr class="separator:ae78a44399218c930be44d3aa46521d0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:abc6aaa0595fa788544c4b18e9bf93850" id="r_abc6aaa0595fa788544c4b18e9bf93850"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#abc6aaa0595fa788544c4b18e9bf93850">refCount</a> = 1</td></tr>
|
|
<tr class="memdesc:abc6aaa0595fa788544c4b18e9bf93850"><td class="mdescLeft"> </td><td class="mdescRight">COM-model local reference count. <br /></td></tr>
|
|
<tr class="separator:abc6aaa0595fa788544c4b18e9bf93850"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-attribs" name="pro-static-attribs"></a>
|
|
Static Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:acee1b675f92ac47a457fc7692dfd3a67" id="r_acee1b675f92ac47a457fc7692dfd3a67"><td class="memItemLeft" align="right" valign="top">static IUpdateHandler * </td><td class="memItemRight" valign="bottom"><a class="el" href="#acee1b675f92ac47a457fc7692dfd3a67">gUpdateHandler</a> = nullptr</td></tr>
|
|
<tr class="separator:acee1b675f92ac47a457fc7692dfd3a67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Implements FUnknown and IDependent. </p>
|
|
<p><a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> is a polymorphic class that implements IDependent (of SKI module) and therefore derived from FUnknown, which is the most abstract base class of all.</p>
|
|
<p>All COM-like virtual methods of FUnknown such as <a class="el" href="#a9a18a9f05017946de2dc6942fc7b55b0" title="please refer to FUnknown::queryInterface ()">queryInterface()</a>, <a class="el" href="#ab71f235d96a97eb6e56272b090694878" title="please refer to FUnknown::addref ()">addRef()</a>, <a class="el" href="#a936c8aef3cc4614fc83ca91233e99521" title="please refer to FUnknown::release ()">release()</a> are implemented here. On top of that, dependency-related methods are implemented too.</p>
|
|
<p>Pointer casting is done via the template methods FCast, either <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> or FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>.</p>
|
|
<p><a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> supports a new singleton concept, therefore these objects are deleted automatically upon program termination.</p>
|
|
<ul>
|
|
<li>Runtime type information: An object can be queried at runtime, of what class it is. To do this correctly, every class must override some methods. This is simplified by using the OBJ_METHODS macros</li>
|
|
</ul>
|
|
<dl class="section see"><dt>See also</dt><dd><ul>
|
|
<li>FUnknown</li>
|
|
<li>IDependent</li>
|
|
<li>IUpdateHandler </li>
|
|
</ul>
|
|
</dd></dl>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a437422592a0d826d2c3962fb7fff8404" name="a437422592a0d826d2c3962fb7fff8404"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a437422592a0d826d2c3962fb7fff8404">◆ </a></span>FObject() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSteinberg_1_1FObject.html">FObject</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 default">default</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>default constructor... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0df169f35093cd89cf30109783cc900b" name="a0df169f35093cd89cf30109783cc900b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0df169f35093cd89cf30109783cc900b">◆ </a></span>FObject() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a> </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> &</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">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6bd63fda63882c46b7c08409f68ad23b" name="a6bd63fda63882c46b7c08409f68ad23b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bd63fda63882c46b7c08409f68ad23b">◆ </a></span>~FObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">~<a class="el" href="classSteinberg_1_1FObject.html">FObject</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 virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>destructor... </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3f93f4dfecbe838c658bf1425e1db908" name="a3f93f4dfecbe838c658bf1425e1db908"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f93f4dfecbe838c658bf1425e1db908">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a> & operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classSteinberg_1_1FObject.html">FObject</a> &</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>overloads operator "=" as the reference assignment </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61fe4989547b521dfcac968665c376d9" name="a61fe4989547b521dfcac968665c376d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61fe4989547b521dfcac968665c376d9">◆ </a></span>getFClassID()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> getFClassID </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 class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>return Class ID as an ASCII string (statically) </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae90f8c54876fd8f1a191a44144d66c7" name="aae90f8c54876fd8f1a191a44144d66c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae90f8c54876fd8f1a191a44144d66c7">◆ </a></span>isA() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a> isA </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>a local alternative to getFClassID () </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a472e34bafb6415ae1054b6e4ffd9e3f5" name="a472e34bafb6415ae1054b6e4ffd9e3f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a472e34bafb6415ae1054b6e4ffd9e3f5">◆ </a></span>isA() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool isA </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a></td> <td class="paramname"><span class="paramname"><em>s</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>evaluates if the passed ID is of the <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> type </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7828bf1972d5be433fdd6320e109f3be" name="a7828bf1972d5be433fdd6320e109f3be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7828bf1972d5be433fdd6320e109f3be">◆ </a></span>isTypeOf()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool isTypeOf </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a></td> <td class="paramname"><span class="paramname"><em>s</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em></em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>evaluates if the passed ID is of the <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> type </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a127b5517d355d7870c5bc96d52ef9ef0" name="a127b5517d355d7870c5bc96d52ef9ef0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a127b5517d355d7870c5bc96d52ef9ef0">◆ </a></span>getRefCount()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 getRefCount </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>returns the current interface reference count </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86bda2cc9670209c191358a3b9fcab67" name="a86bda2cc9670209c191358a3b9fcab67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86bda2cc9670209c191358a3b9fcab67">◆ </a></span>unknownCast()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FUnknown * unknownCast </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>get FUnknown interface from object </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a18a9f05017946de2dc6942fc7b55b0" name="a9a18a9f05017946de2dc6942fc7b55b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a18a9f05017946de2dc6942fc7b55b0">◆ </a></span>queryInterface()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">tresult queryInterface </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const TUID</td> <td class="paramname"><span class="paramname"><em>_iid</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void **</td> <td class="paramname"><span class="paramname"><em>obj</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>please refer to FUnknown::queryInterface () </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab71f235d96a97eb6e56272b090694878" name="ab71f235d96a97eb6e56272b090694878"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab71f235d96a97eb6e56272b090694878">◆ </a></span>addRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32 addRef </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>please refer to FUnknown::addref () </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a936c8aef3cc4614fc83ca91233e99521" name="a936c8aef3cc4614fc83ca91233e99521"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a936c8aef3cc4614fc83ca91233e99521">◆ </a></span>release()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32 release </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>please refer to FUnknown::release () </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeeeb082a829ee7b136a730a2a4029103" name="aeeeb082a829ee7b136a730a2a4029103"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeeeb082a829ee7b136a730a2a4029103">◆ </a></span>update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FUnknown *</td> <td class="paramname"><span class="paramname"><em></em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em></em></span> )</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>empty virtual method that should be overridden by derived classes for data updates upon changes </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aad64a1f592d31c920bc72505ab860576" name="aad64a1f592d31c920bc72505ab860576"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aad64a1f592d31c920bc72505ab860576">◆ </a></span>addDependent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void addDependent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">IDependent *</td> <td class="paramname"><span class="paramname"><em>dep</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>adds dependency to the object </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classSteinberg_1_1UpdateHandler.html#aad64a1f592d31c920bc72505ab860576">UpdateHandler</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4a343976011506b85607300a4bd97832" name="a4a343976011506b85607300a4bd97832"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4a343976011506b85607300a4bd97832">◆ </a></span>removeDependent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void removeDependent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">IDependent *</td> <td class="paramname"><span class="paramname"><em>dep</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>removes dependency from the object </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classSteinberg_1_1UpdateHandler.html#a4a343976011506b85607300a4bd97832">UpdateHandler</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72f44c7bf8ec3cab12b95dde13542194" name="a72f44c7bf8ec3cab12b95dde13542194"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72f44c7bf8ec3cab12b95dde13542194">◆ </a></span>changed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void changed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>msg</em></span><span class="paramdefsep"> = </span><span class="paramdefval">kChanged</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Inform all dependents, that the object has changed. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad0cb02215c1c6e44b53f177e7844a9f5" name="ad0cb02215c1c6e44b53f177e7844a9f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad0cb02215c1c6e44b53f177e7844a9f5">◆ </a></span>deferUpdate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void deferUpdate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>msg</em></span><span class="paramdefsep"> = </span><span class="paramdefval">kChanged</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classSteinberg_1_1UpdateHandler.html#ad0cb02215c1c6e44b53f177e7844a9f5">UpdateHandler</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0be193466912191a8ebbd75354edd935" name="a0be193466912191a8ebbd75354edd935"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0be193466912191a8ebbd75354edd935">◆ </a></span>updateDone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void updateDone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</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 class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>empty virtual method that should be overridden by derived classes </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a7c5326199ffb542719387b078ed6da" name="a5a7c5326199ffb542719387b078ed6da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a7c5326199ffb542719387b078ed6da">◆ </a></span>isEqualInstance()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool isEqualInstance </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FUnknown *</td> <td class="paramname"><span class="paramname"><em>d</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf312648bf542a9d35fd34e1564b07cb" name="abf312648bf542a9d35fd34e1564b07cb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf312648bf542a9d35fd34e1564b07cb">◆ </a></span>setUpdateHandler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void setUpdateHandler </td>
|
|
<td>(</td>
|
|
<td class="paramtype">IUpdateHandler *</td> <td class="paramname"><span class="paramname"><em>handler</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set method for the local attribute </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a603a8093a1d2e99527a89d3a15e5504a" name="a603a8093a1d2e99527a89d3a15e5504a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a603a8093a1d2e99527a89d3a15e5504a">◆ </a></span>getUpdateHandler()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static IUpdateHandler * getUpdateHandler </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 class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get method for the local attribute </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af59fc037df86c95566a2f9874be552a4" name="af59fc037df86c95566a2f9874be552a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af59fc037df86c95566a2f9874be552a4">◆ </a></span>classIDsEqual()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool classIDsEqual </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a></td> <td class="paramname"><span class="paramname"><em>ci1</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespaceSteinberg.html#ab36f267af0b3dc88ce9135a0c3b4f170">FClassID</a></td> <td class="paramname"><span class="paramname"><em>ci2</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>compares (evaluates) 2 class IDs </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0a25d706b3e3dabc9e4c0d026f925d73" name="a0a25d706b3e3dabc9e4c0d026f925d73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0a25d706b3e3dabc9e4c0d026f925d73">◆ </a></span>unknownToObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classSteinberg_1_1FObject.html">FObject</a> * unknownToObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FUnknown *</td> <td class="paramname"><span class="paramname"><em>unknown</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>pointer conversion from FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ca01e2c40b3e5c5d6bcc995c123b768" name="a6ca01e2c40b3e5c5d6bcc995c123b768"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ca01e2c40b3e5c5d6bcc995c123b768">◆ </a></span>fromUnknown() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class Class> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static IPtr< Class > fromUnknown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FUnknown *</td> <td class="paramname"><span class="paramname"><em>unknown</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>convert from FUnknown to <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46041b248461358d403e6ced65aa007a" name="a46041b248461358d403e6ced65aa007a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46041b248461358d403e6ced65aa007a">◆ </a></span>fromUnknown() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class C> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IPtr< C > fromUnknown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FUnknown *</td> <td class="paramname"><span class="paramname"><em>unknown</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">
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ae78a44399218c930be44d3aa46521d0e" name="ae78a44399218c930be44d3aa46521d0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae78a44399218c930be44d3aa46521d0e">◆ </a></span>iid</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const FUID iid</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Special UID that is used to cast an FUnknown pointer to a <a class="el" href="classSteinberg_1_1FObject.html" title="Implements FUnknown and IDependent.">FObject</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc6aaa0595fa788544c4b18e9bf93850" name="abc6aaa0595fa788544c4b18e9bf93850"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc6aaa0595fa788544c4b18e9bf93850">◆ </a></span>refCount</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 refCount = 1</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel protected">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>COM-model local reference count. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acee1b675f92ac47a457fc7692dfd3a67" name="acee1b675f92ac47a457fc7692dfd3a67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acee1b675f92ac47a457fc7692dfd3a67">◆ </a></span>gUpdateHandler</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IUpdateHandler * gUpdateHandler = nullptr</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel protected">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</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>
|