/usr/share/doc/libjuce/apiref/classOptionalScopedPointer.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: OptionalScopedPointer< ObjectType > Class 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>
<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" />
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOptionalScopedPointer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OptionalScopedPointer< ObjectType > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope.
<a href="classOptionalScopedPointer.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a8b96c6f59b68c8fe8880bc986fe90458"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a8b96c6f59b68c8fe8880bc986fe90458">OptionalScopedPointer</a> ()</td></tr>
<tr class="memdesc:a8b96c6f59b68c8fe8880bc986fe90458"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a>. <a href="#a8b96c6f59b68c8fe8880bc986fe90458">More...</a><br /></td></tr>
<tr class="separator:a8b96c6f59b68c8fe8880bc986fe90458"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ea2cd6ce97953c223ac0ab3789f9127"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a3ea2cd6ce97953c223ac0ab3789f9127">OptionalScopedPointer</a> (ObjectType *objectToHold, bool takeOwnership)</td></tr>
<tr class="memdesc:a3ea2cd6ce97953c223ac0ab3789f9127"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> to point to a given object, and specifying whether the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will delete it. <a href="#a3ea2cd6ce97953c223ac0ab3789f9127">More...</a><br /></td></tr>
<tr class="separator:a3ea2cd6ce97953c223ac0ab3789f9127"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c0f0be46c674d4b4082ed6c56ad41d8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a3c0f0be46c674d4b4082ed6c56ad41d8">OptionalScopedPointer</a> (<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> &objectToTransferFrom)</td></tr>
<tr class="memdesc:a3c0f0be46c674d4b4082ed6c56ad41d8"><td class="mdescLeft"> </td><td class="mdescRight">Takes ownership of the object that another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> holds. <a href="#a3c0f0be46c674d4b4082ed6c56ad41d8">More...</a><br /></td></tr>
<tr class="separator:a3c0f0be46c674d4b4082ed6c56ad41d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f773129ee4e44990551b34faf5d0dd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a8f773129ee4e44990551b34faf5d0dd5">operator=</a> (<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> &objectToTransferFrom)</td></tr>
<tr class="memdesc:a8f773129ee4e44990551b34faf5d0dd5"><td class="mdescLeft"> </td><td class="mdescRight">Takes ownership of the object that another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> holds. <a href="#a8f773129ee4e44990551b34faf5d0dd5">More...</a><br /></td></tr>
<tr class="separator:a8f773129ee4e44990551b34faf5d0dd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e0508d3dc7dd9603e001cb72191ad56"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a0e0508d3dc7dd9603e001cb72191ad56">~OptionalScopedPointer</a> ()</td></tr>
<tr class="memdesc:a0e0508d3dc7dd9603e001cb72191ad56"><td class="mdescLeft"> </td><td class="mdescRight">The destructor may or may not delete the object that is being held, depending on the takeOwnership flag that was specified when the object was first passed into an <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> constructor. <a href="#a0e0508d3dc7dd9603e001cb72191ad56">More...</a><br /></td></tr>
<tr class="separator:a0e0508d3dc7dd9603e001cb72191ad56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45f1f538ffab217fabca41e5271593cc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a45f1f538ffab217fabca41e5271593cc">operator ObjectType *</a> () const noexcept</td></tr>
<tr class="memdesc:a45f1f538ffab217fabca41e5271593cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this pointer is managing. <a href="#a45f1f538ffab217fabca41e5271593cc">More...</a><br /></td></tr>
<tr class="separator:a45f1f538ffab217fabca41e5271593cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0424e95b5edea332aadada60cb1296ed"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a0424e95b5edea332aadada60cb1296ed">get</a> () const noexcept</td></tr>
<tr class="memdesc:a0424e95b5edea332aadada60cb1296ed"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this pointer is managing. <a href="#a0424e95b5edea332aadada60cb1296ed">More...</a><br /></td></tr>
<tr class="separator:a0424e95b5edea332aadada60cb1296ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af1d540a292b283a1c72cba4e59d11a19"><td class="memItemLeft" align="right" valign="top">ObjectType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#af1d540a292b283a1c72cba4e59d11a19">operator*</a> () const noexcept</td></tr>
<tr class="memdesc:af1d540a292b283a1c72cba4e59d11a19"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this pointer is managing. <a href="#af1d540a292b283a1c72cba4e59d11a19">More...</a><br /></td></tr>
<tr class="separator:af1d540a292b283a1c72cba4e59d11a19"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f713a23c5a7c8ee6d668109441d0d09"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a0f713a23c5a7c8ee6d668109441d0d09">operator-></a> () const noexcept</td></tr>
<tr class="memdesc:a0f713a23c5a7c8ee6d668109441d0d09"><td class="mdescLeft"> </td><td class="mdescRight">Lets you access methods and properties of the object that this pointer is holding. <a href="#a0f713a23c5a7c8ee6d668109441d0d09">More...</a><br /></td></tr>
<tr class="separator:a0f713a23c5a7c8ee6d668109441d0d09"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf99bfb609b72988d875d1091af6cb42"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#acf99bfb609b72988d875d1091af6cb42">release</a> () noexcept</td></tr>
<tr class="memdesc:acf99bfb609b72988d875d1091af6cb42"><td class="mdescLeft"> </td><td class="mdescRight">Removes the current object from this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> without deleting it. <a href="#acf99bfb609b72988d875d1091af6cb42">More...</a><br /></td></tr>
<tr class="separator:acf99bfb609b72988d875d1091af6cb42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae30fe3a7e3ff51f427056ab155dbafd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#ae30fe3a7e3ff51f427056ab155dbafd0">clear</a> ()</td></tr>
<tr class="memdesc:ae30fe3a7e3ff51f427056ab155dbafd0"><td class="mdescLeft"> </td><td class="mdescRight">Resets this pointer to null, possibly deleting the object that it holds, if it has ownership of it. <a href="#ae30fe3a7e3ff51f427056ab155dbafd0">More...</a><br /></td></tr>
<tr class="separator:ae30fe3a7e3ff51f427056ab155dbafd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae526986fb0292d7b3623687e52b96fb7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#ae526986fb0292d7b3623687e52b96fb7">set</a> (ObjectType *newObject, bool takeOwnership)</td></tr>
<tr class="memdesc:ae526986fb0292d7b3623687e52b96fb7"><td class="mdescLeft"> </td><td class="mdescRight">Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, specifying whether the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will take ownership of the object. <a href="#ae526986fb0292d7b3623687e52b96fb7">More...</a><br /></td></tr>
<tr class="separator:ae526986fb0292d7b3623687e52b96fb7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44d17e536c3584231f3ded73499cf09b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a44d17e536c3584231f3ded73499cf09b">setOwned</a> (ObjectType *newObject)</td></tr>
<tr class="memdesc:a44d17e536c3584231f3ded73499cf09b"><td class="mdescLeft"> </td><td class="mdescRight">Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, and take ownership of that object. <a href="#a44d17e536c3584231f3ded73499cf09b">More...</a><br /></td></tr>
<tr class="separator:a44d17e536c3584231f3ded73499cf09b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad002438efbea088d4114470c78cf77da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#ad002438efbea088d4114470c78cf77da">setNonOwned</a> (ObjectType *newObject)</td></tr>
<tr class="memdesc:ad002438efbea088d4114470c78cf77da"><td class="mdescLeft"> </td><td class="mdescRight">Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, but will not take ownership of that object. <a href="#ad002438efbea088d4114470c78cf77da">More...</a><br /></td></tr>
<tr class="separator:ad002438efbea088d4114470c78cf77da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0eb696aae75b039bc1309dc7125bda7a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a0eb696aae75b039bc1309dc7125bda7a">willDeleteObject</a> () const noexcept</td></tr>
<tr class="memdesc:a0eb696aae75b039bc1309dc7125bda7a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the target object will be deleted when this pointer object is deleted. <a href="#a0eb696aae75b039bc1309dc7125bda7a">More...</a><br /></td></tr>
<tr class="separator:a0eb696aae75b039bc1309dc7125bda7a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a378381bc4cb56b452de6eb198a796fbb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOptionalScopedPointer.html#a378381bc4cb56b452de6eb198a796fbb">swapWith</a> (<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType > &other) noexcept</td></tr>
<tr class="memdesc:a378381bc4cb56b452de6eb198a796fbb"><td class="mdescLeft"> </td><td class="mdescRight">Swaps this object with another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a>. <a href="#a378381bc4cb56b452de6eb198a796fbb">More...</a><br /></td></tr>
<tr class="separator:a378381bc4cb56b452de6eb198a796fbb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class ObjectType><br />
class OptionalScopedPointer< ObjectType ></h3>
<p>Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope. </p>
<p>This acts in many ways like a <a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a>, but allows you to specify whether or not the object is deleted.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8b96c6f59b68c8fe8880bc986fe90458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b96c6f59b68c8fe8880bc986fe90458">§ </a></span>OptionalScopedPointer() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a>. </p>
</div>
</div>
<a id="a3ea2cd6ce97953c223ac0ab3789f9127"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ea2cd6ce97953c223ac0ab3789f9127">§ </a></span>OptionalScopedPointer() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> </td>
<td>(</td>
<td class="paramtype">ObjectType * </td>
<td class="paramname"><em>objectToHold</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>takeOwnership</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> to point to a given object, and specifying whether the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will delete it. </p>
<p>If takeOwnership is true, then the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will act like a <a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a>, deleting the object when it is itself deleted. If this parameter is false, then the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> just holds a normal pointer to the object, and won't delete it. </p>
</div>
</div>
<a id="a3c0f0be46c674d4b4082ed6c56ad41d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c0f0be46c674d4b4082ed6c56ad41d8">§ </a></span>OptionalScopedPointer() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType > & </td>
<td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes ownership of the object that another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> holds. </p>
<p>Like a normal <a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a>, the objectToTransferFrom object will become null, as ownership of the managed object is transferred to this object.</p>
<p>The flag to indicate whether or not to delete the managed object is also copied from the source object. </p>
</div>
</div>
<a id="a0e0508d3dc7dd9603e001cb72191ad56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e0508d3dc7dd9603e001cb72191ad56">§ </a></span>~OptionalScopedPointer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::~<a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor may or may not delete the object that is being held, depending on the takeOwnership flag that was specified when the object was first passed into an <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a8f773129ee4e44990551b34faf5d0dd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f773129ee4e44990551b34faf5d0dd5">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>& <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType > & </td>
<td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes ownership of the object that another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> holds. </p>
<p>Like a normal <a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a>, the objectToTransferFrom object will become null, as ownership of the managed object is transferred to this object.</p>
<p>The ownership flag that says whether or not to delete the managed object is also copied from the source object. </p>
</div>
</div>
<a id="a45f1f538ffab217fabca41e5271593cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45f1f538ffab217fabca41e5271593cc">§ </a></span>operator ObjectType *()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::operator ObjectType * </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the object that this pointer is managing. </p>
</div>
</div>
<a id="a0424e95b5edea332aadada60cb1296ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0424e95b5edea332aadada60cb1296ed">§ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ObjectType* <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the object that this pointer is managing. </p>
</div>
</div>
<a id="af1d540a292b283a1c72cba4e59d11a19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1d540a292b283a1c72cba4e59d11a19">§ </a></span>operator*()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ObjectType& <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the object that this pointer is managing. </p>
</div>
</div>
<a id="a0f713a23c5a7c8ee6d668109441d0d09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f713a23c5a7c8ee6d668109441d0d09">§ </a></span>operator->()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ObjectType* <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::operator-> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Lets you access methods and properties of the object that this pointer is holding. </p>
</div>
</div>
<a id="acf99bfb609b72988d875d1091af6cb42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf99bfb609b72988d875d1091af6cb42">§ </a></span>release()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ObjectType* <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the current object from this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> without deleting it. </p>
<p>This will return the current object, and set this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> to a null pointer. </p>
</div>
</div>
<a id="ae30fe3a7e3ff51f427056ab155dbafd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae30fe3a7e3ff51f427056ab155dbafd0">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets this pointer to null, possibly deleting the object that it holds, if it has ownership of it. </p>
<p>Referenced by <a class="el" href="classOptionalScopedPointer.html#a8f773129ee4e44990551b34faf5d0dd5">OptionalScopedPointer< OutputStream >::operator=()</a>, <a class="el" href="classOptionalScopedPointer.html#ae526986fb0292d7b3623687e52b96fb7">OptionalScopedPointer< OutputStream >::set()</a>, and <a class="el" href="classOptionalScopedPointer.html#a0e0508d3dc7dd9603e001cb72191ad56">OptionalScopedPointer< OutputStream >::~OptionalScopedPointer()</a>.</p>
</div>
</div>
<a id="ae526986fb0292d7b3623687e52b96fb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae526986fb0292d7b3623687e52b96fb7">§ </a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::set </td>
<td>(</td>
<td class="paramtype">ObjectType * </td>
<td class="paramname"><em>newObject</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>takeOwnership</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, specifying whether the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will take ownership of the object. </p>
<p>If takeOwnership is true, then the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> will act like a <a class="el" href="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a>, deleting the object when it is itself deleted. If this parameter is false, then the <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> just holds a normal pointer to the object, and won't delete it. </p>
</div>
</div>
<a id="a44d17e536c3584231f3ded73499cf09b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44d17e536c3584231f3ded73499cf09b">§ </a></span>setOwned()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::setOwned </td>
<td>(</td>
<td class="paramtype">ObjectType * </td>
<td class="paramname"><em>newObject</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, and take ownership of that object. </p>
<p>Referenced by <a class="el" href="classStandalonePluginHolder.html#a5e24139925518f20b67a3d6f74bfb00c">StandalonePluginHolder::showAudioSettingsDialog()</a>, and <a class="el" href="classOptionalScopedPointer.html#a378381bc4cb56b452de6eb198a796fbb">OptionalScopedPointer< OutputStream >::swapWith()</a>.</p>
</div>
</div>
<a id="ad002438efbea088d4114470c78cf77da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad002438efbea088d4114470c78cf77da">§ </a></span>setNonOwned()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::setNonOwned </td>
<td>(</td>
<td class="paramtype">ObjectType * </td>
<td class="paramname"><em>newObject</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes this <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a> point at a new object, but will not take ownership of that object. </p>
</div>
</div>
<a id="a0eb696aae75b039bc1309dc7125bda7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0eb696aae75b039bc1309dc7125bda7a">§ </a></span>willDeleteObject()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::willDeleteObject </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the target object will be deleted when this pointer object is deleted. </p>
</div>
</div>
<a id="a378381bc4cb56b452de6eb198a796fbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a378381bc4cb56b452de6eb198a796fbb">§ </a></span>swapWith()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType >::swapWith </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOptionalScopedPointer.html">OptionalScopedPointer</a>< ObjectType > & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Swaps this object with another <a class="el" href="classOptionalScopedPointer.html" title="Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope...">OptionalScopedPointer</a>. </p>
<p>The two objects simply exchange their states. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__OptionalScopedPointer_8h.html">juce_OptionalScopedPointer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|