/usr/share/doc/libjuce/apiref/classScopedPointer.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 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | <!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: ScopedPointer< 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="classScopedPointer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ScopedPointer< ObjectType > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class holds a pointer which is automatically deleted when this object goes out of scope.
<a href="classScopedPointer.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:ac187958296e33aa057dd37478ea70400"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac187958296e33aa057dd37478ea70400">ScopedPointer</a> () noexcept</td></tr>
<tr class="memdesc:ac187958296e33aa057dd37478ea70400"><td class="mdescLeft"> </td><td class="mdescRight">Creates 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> containing a null pointer. <a href="#ac187958296e33aa057dd37478ea70400">More...</a><br /></td></tr>
<tr class="separator:ac187958296e33aa057dd37478ea70400"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32e3396a5a530aba0c6109d709c549b0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a32e3396a5a530aba0c6109d709c549b0">ScopedPointer</a> (decltype(nullptr)) noexcept</td></tr>
<tr class="memdesc:a32e3396a5a530aba0c6109d709c549b0"><td class="mdescLeft"> </td><td class="mdescRight">Creates 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> containing a null pointer. <a href="#a32e3396a5a530aba0c6109d709c549b0">More...</a><br /></td></tr>
<tr class="separator:a32e3396a5a530aba0c6109d709c549b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a7843e49c3ff719f06607b6e908f7d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a44a7843e49c3ff719f06607b6e908f7d">ScopedPointer</a> (ObjectType *const objectToTakePossessionOf) noexcept</td></tr>
<tr class="memdesc:a44a7843e49c3ff719f06607b6e908f7d"><td class="mdescLeft"> </td><td class="mdescRight">Creates 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> that owns the specified object. <a href="#a44a7843e49c3ff719f06607b6e908f7d">More...</a><br /></td></tr>
<tr class="separator:a44a7843e49c3ff719f06607b6e908f7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a04688b1561dd9d861ca80c6deb63a233"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a04688b1561dd9d861ca80c6deb63a233">ScopedPointer</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &objectToTransferFrom) noexcept</td></tr>
<tr class="memdesc:a04688b1561dd9d861ca80c6deb63a233"><td class="mdescLeft"> </td><td class="mdescRight">Creates 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> that takes its pointer from another <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>. <a href="#a04688b1561dd9d861ca80c6deb63a233">More...</a><br /></td></tr>
<tr class="separator:a04688b1561dd9d861ca80c6deb63a233"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c540f0121065aafa5f9607362fc1450"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a3c540f0121065aafa5f9607362fc1450">~ScopedPointer</a> ()</td></tr>
<tr class="memdesc:a3c540f0121065aafa5f9607362fc1450"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a3c540f0121065aafa5f9607362fc1450">More...</a><br /></td></tr>
<tr class="separator:a3c540f0121065aafa5f9607362fc1450"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afefc7940828d72c056e03804cd6bea9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#afefc7940828d72c056e03804cd6bea9f">operator=</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &objectToTransferFrom)</td></tr>
<tr class="memdesc:afefc7940828d72c056e03804cd6bea9f"><td class="mdescLeft"> </td><td class="mdescRight">Changes this <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> to point to a new object. <a href="#afefc7940828d72c056e03804cd6bea9f">More...</a><br /></td></tr>
<tr class="separator:afefc7940828d72c056e03804cd6bea9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a88ee7f038e57471539d3181141c0390e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a88ee7f038e57471539d3181141c0390e">operator=</a> (ObjectType *const newObjectToTakePossessionOf)</td></tr>
<tr class="memdesc:a88ee7f038e57471539d3181141c0390e"><td class="mdescLeft"> </td><td class="mdescRight">Changes this <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> to point to a new object. <a href="#a88ee7f038e57471539d3181141c0390e">More...</a><br /></td></tr>
<tr class="separator:a88ee7f038e57471539d3181141c0390e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a331080bd9920f0e479094f3250552b14"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a331080bd9920f0e479094f3250552b14">ScopedPointer</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &&other) noexcept</td></tr>
<tr class="separator:a331080bd9920f0e479094f3250552b14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8113d3daa273388cc0e6b0bad4f581c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classScopedPointer.html">ScopedPointer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a8113d3daa273388cc0e6b0bad4f581c2">operator=</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a> &&other) noexcept</td></tr>
<tr class="separator:a8113d3daa273388cc0e6b0bad4f581c2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7c241c736d79754fd6f8d305cce8bc3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#af7c241c736d79754fd6f8d305cce8bc3">operator ObjectType *</a> () const noexcept</td></tr>
<tr class="memdesc:af7c241c736d79754fd6f8d305cce8bc3"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this <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> refers to. <a href="#af7c241c736d79754fd6f8d305cce8bc3">More...</a><br /></td></tr>
<tr class="separator:af7c241c736d79754fd6f8d305cce8bc3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740">get</a> () const noexcept</td></tr>
<tr class="memdesc:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this <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> refers to. <a href="#ac65fb45b9eb2d53773489fcfbc6fd740">More...</a><br /></td></tr>
<tr class="separator:ac65fb45b9eb2d53773489fcfbc6fd740"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memItemLeft" align="right" valign="top">ObjectType & </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a2f48458a1656a6ef1bd35cb8452eed35">operator*</a> () const noexcept</td></tr>
<tr class="memdesc:a2f48458a1656a6ef1bd35cb8452eed35"><td class="mdescLeft"> </td><td class="mdescRight">Returns the object that this <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> refers to. <a href="#a2f48458a1656a6ef1bd35cb8452eed35">More...</a><br /></td></tr>
<tr class="separator:a2f48458a1656a6ef1bd35cb8452eed35"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a6eedc84349cbe629cc1abb79ffa74e87">operator-></a> () const noexcept</td></tr>
<tr class="memdesc:a6eedc84349cbe629cc1abb79ffa74e87"><td class="mdescLeft"> </td><td class="mdescRight">Lets you access methods and properties of the object that this <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> refers to. <a href="#a6eedc84349cbe629cc1abb79ffa74e87">More...</a><br /></td></tr>
<tr class="separator:a6eedc84349cbe629cc1abb79ffa74e87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10c8f696fec0cca763b067ec3e469199"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199">release</a> () noexcept</td></tr>
<tr class="memdesc:a10c8f696fec0cca763b067ec3e469199"><td class="mdescLeft"> </td><td class="mdescRight">Removes the current object from this <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> without deleting it. <a href="#a10c8f696fec0cca763b067ec3e469199">More...</a><br /></td></tr>
<tr class="separator:a10c8f696fec0cca763b067ec3e469199"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a362cd8d5a212df0ee08691b75a4ba3de">swapWith</a> (<a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType > &other) noexcept</td></tr>
<tr class="memdesc:a362cd8d5a212df0ee08691b75a4ba3de"><td class="mdescLeft"> </td><td class="mdescRight">Swaps this object with that of another <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>. <a href="#a362cd8d5a212df0ee08691b75a4ba3de">More...</a><br /></td></tr>
<tr class="separator:a362cd8d5a212df0ee08691b75a4ba3de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c72746c9ac7fd311d3c7aaa1f226f85"><td class="memItemLeft" align="right" valign="top">ObjectType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedPointer.html#a5c72746c9ac7fd311d3c7aaa1f226f85">createCopy</a> () const</td></tr>
<tr class="memdesc:a5c72746c9ac7fd311d3c7aaa1f226f85"><td class="mdescLeft"> </td><td class="mdescRight">If the pointer is non-null, this will attempt to return a new copy of the object that is pointed to. <a href="#a5c72746c9ac7fd311d3c7aaa1f226f85">More...</a><br /></td></tr>
<tr class="separator:a5c72746c9ac7fd311d3c7aaa1f226f85"><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 ScopedPointer< ObjectType ></h3>
<p>This class holds a pointer which is automatically deleted when this object goes out of scope. </p>
<p>Once a pointer has been passed to 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>, it will make sure that the pointer gets deleted when the <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> is deleted. Using the <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> on the stack or as member variables is a good way to use RAII to avoid accidentally leaking dynamically created objects.</p>
<p>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> can be used in pretty much the same way that you'd use a normal pointer to an object. If you use the assignment operator to assign a different object to 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>, the old one will be automatically deleted.</p>
<p>Important note: The class is designed to hold a pointer to an object, NOT to an array! It calls delete on its payload, not delete[], so do not give it an array to hold! For that kind of purpose, you should be using <a class="el" href="classHeapBlock.html" title="Very simple container class to hold a pointer to some data on the heap. ">HeapBlock</a> or <a class="el" href="classArray.html" title="Holds a resizable array of primitive or copy-by-value objects. ">Array</a> instead.</p>
<p>A const <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> is guaranteed not to lose ownership of its object or change the object to which it points during its lifetime. This means that making a copy of a const <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> is impossible, as that would involve the new copy taking ownership from the old one.</p>
<p>If you need to get a pointer out of 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> without it being deleted, you can use the <a class="el" href="classScopedPointer.html#a10c8f696fec0cca763b067ec3e469199" title="Removes the current object from this ScopedPointer without deleting it. ">release()</a> method.</p>
<p>Something to note is the main difference between this class and the std::auto_ptr class, which is that <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> provides a cast-to-object operator, whereas std::auto_ptr requires that you always call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740" title="Returns the object that this ScopedPointer refers to. ">get()</a> to retrieve the pointer. The advantages of providing the cast is that you don't need to call <a class="el" href="classScopedPointer.html#ac65fb45b9eb2d53773489fcfbc6fd740" title="Returns the object that this ScopedPointer refers to. ">get()</a>, so can use the <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> in pretty much exactly the same way as a raw pointer. The disadvantage is that the compiler is free to use the cast in unexpected and sometimes dangerous ways - in particular, it becomes difficult to return 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> as the result of a function. To avoid this causing errors, <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> contains an overloaded constructor that should cause a syntax error in these circumstances, but it does mean that instead of returning 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> from a function, you'd need to return a raw pointer (or use a std::auto_ptr instead). </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ac187958296e33aa057dd37478ea70400"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac187958296e33aa057dd37478ea70400">§ </a></span>ScopedPointer() <span class="overload">[1/5]</span></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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </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>Creates 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> containing a null pointer. </p>
</div>
</div>
<a id="a32e3396a5a530aba0c6109d709c549b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a32e3396a5a530aba0c6109d709c549b0">§ </a></span>ScopedPointer() <span class="overload">[2/5]</span></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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>
<td>(</td>
<td class="paramtype">decltype(nullptr) </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>Creates 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> containing a null pointer. </p>
</div>
</div>
<a id="a44a7843e49c3ff719f06607b6e908f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44a7843e49c3ff719f06607b6e908f7d">§ </a></span>ScopedPointer() <span class="overload">[3/5]</span></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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>
<td>(</td>
<td class="paramtype">ObjectType *const </td>
<td class="paramname"><em>objectToTakePossessionOf</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>Creates 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> that owns the specified object. </p>
</div>
</div>
<a id="a04688b1561dd9d861ca80c6deb63a233"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04688b1561dd9d861ca80c6deb63a233">§ </a></span>ScopedPointer() <span class="overload">[4/5]</span></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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType > & </td>
<td class="paramname"><em>objectToTransferFrom</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>Creates 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> that takes its pointer from another <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>. </p>
<p>Because a pointer can only belong to one <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>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer. </p>
</div>
</div>
<a id="a3c540f0121065aafa5f9607362fc1450"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c540f0121065aafa5f9607362fc1450">§ </a></span>~ScopedPointer()</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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::~<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>This will delete the object that this <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> currently refers to. </p>
</div>
</div>
<a id="a331080bd9920f0e479094f3250552b14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a331080bd9920f0e479094f3250552b14">§ </a></span>ScopedPointer() <span class="overload">[5/5]</span></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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::<a class="el" href="classScopedPointer.html">ScopedPointer</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="afefc7940828d72c056e03804cd6bea9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afefc7940828d72c056e03804cd6bea9f">§ </a></span>operator=() <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="classScopedPointer.html">ScopedPointer</a>& <a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType >::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType > & </td>
<td class="paramname"><em>objectToTransferFrom</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes this <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> to point to a new object. </p>
<p>Because a pointer can only belong to one <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>, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer.</p>
<p>If this <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> already points to an object, that object will first be deleted. </p>
</div>
</div>
<a id="a88ee7f038e57471539d3181141c0390e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88ee7f038e57471539d3181141c0390e">§ </a></span>operator=() <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="classScopedPointer.html">ScopedPointer</a>& <a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType >::operator= </td>
<td>(</td>
<td class="paramtype">ObjectType *const </td>
<td class="paramname"><em>newObjectToTakePossessionOf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes this <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> to point to a new object. </p>
<p>If this <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> already points to an object, that object will first be deleted.</p>
<p>The pointer that you pass in may be a nullptr. </p>
</div>
</div>
<a id="a8113d3daa273388cc0e6b0bad4f581c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8113d3daa273388cc0e6b0bad4f581c2">§ </a></span>operator=() <span class="overload">[3/3]</span></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="classScopedPointer.html">ScopedPointer</a>& <a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType >::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</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">
</div>
</div>
<a id="af7c241c736d79754fd6f8d305cce8bc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7c241c736d79754fd6f8d305cce8bc3">§ </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="classScopedPointer.html">ScopedPointer</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 <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> refers to. </p>
</div>
</div>
<a id="ac65fb45b9eb2d53773489fcfbc6fd740"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac65fb45b9eb2d53773489fcfbc6fd740">§ </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="classScopedPointer.html">ScopedPointer</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 <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> refers to. </p>
</div>
</div>
<a id="a2f48458a1656a6ef1bd35cb8452eed35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f48458a1656a6ef1bd35cb8452eed35">§ </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="classScopedPointer.html">ScopedPointer</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 <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> refers to. </p>
</div>
</div>
<a id="a6eedc84349cbe629cc1abb79ffa74e87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eedc84349cbe629cc1abb79ffa74e87">§ </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="classScopedPointer.html">ScopedPointer</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 <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> refers to. </p>
</div>
</div>
<a id="a10c8f696fec0cca763b067ec3e469199"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10c8f696fec0cca763b067ec3e469199">§ </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="classScopedPointer.html">ScopedPointer</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="classScopedPointer.html" title="This class holds a pointer which is automatically deleted when this object goes out of scope...">ScopedPointer</a> without deleting it. </p>
<p>This will return the current object, and set the <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> to a null pointer. </p>
<p>Referenced by <a class="el" href="classOwnedArray.html#a383de41801934f65b720a7019ed6ac8a">OwnedArray< MidiBuffer >::set()</a>.</p>
</div>
</div>
<a id="a362cd8d5a212df0ee08691b75a4ba3de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a362cd8d5a212df0ee08691b75a4ba3de">§ </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="classScopedPointer.html">ScopedPointer</a>< ObjectType >::swapWith </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classScopedPointer.html">ScopedPointer</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 that of another <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>. </p>
<p>The two objects simply exchange their pointers. </p>
</div>
</div>
<a id="a5c72746c9ac7fd311d3c7aaa1f226f85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c72746c9ac7fd311d3c7aaa1f226f85">§ </a></span>createCopy()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class ObjectType> </div>
<table class="memname">
<tr>
<td class="memname">ObjectType* <a class="el" href="classScopedPointer.html">ScopedPointer</a>< ObjectType >::createCopy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>If the pointer is non-null, this will attempt to return a new copy of the object that is pointed to. </p>
<p>If the pointer is null, this will safely return a nullptr. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ScopedPointer_8h.html">juce_ScopedPointer.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|