/usr/share/doc/libjuce/apiref/classStringRef.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 | <!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: StringRef 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>
<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="#pub-attribs">Public Attributes</a> |
<a href="classStringRef-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">StringRef Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A simple class for holding temporary references to a string literal or <a class="el" href="classString.html" title="The JUCE String class! ">String</a>.
<a href="classStringRef.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:afdd484f4bdb44927ffc3ae24292f0cd6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#afdd484f4bdb44927ffc3ae24292f0cd6">StringRef</a> (const char *stringLiteral) noexcept</td></tr>
<tr class="memdesc:afdd484f4bdb44927ffc3ae24292f0cd6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a raw string literal. <a href="#afdd484f4bdb44927ffc3ae24292f0cd6">More...</a><br /></td></tr>
<tr class="separator:afdd484f4bdb44927ffc3ae24292f0cd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c1e86162550a9fa7f3f9aa65b9cc74a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a4c1e86162550a9fa7f3f9aa65b9cc74a">StringRef</a> (<a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> stringLiteral) noexcept</td></tr>
<tr class="memdesc:a4c1e86162550a9fa7f3f9aa65b9cc74a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a raw char pointer. <a href="#a4c1e86162550a9fa7f3f9aa65b9cc74a">More...</a><br /></td></tr>
<tr class="separator:a4c1e86162550a9fa7f3f9aa65b9cc74a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47ea3e1c936ecf660bf9f98b7f75d28e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a47ea3e1c936ecf660bf9f98b7f75d28e">StringRef</a> (const <a class="el" href="classString.html">String</a> &string) noexcept</td></tr>
<tr class="memdesc:a47ea3e1c936ecf660bf9f98b7f75d28e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. <a href="#a47ea3e1c936ecf660bf9f98b7f75d28e">More...</a><br /></td></tr>
<tr class="separator:a47ea3e1c936ecf660bf9f98b7f75d28e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ed3eed766b7dac3eaad6e7fe0f6a920"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a7ed3eed766b7dac3eaad6e7fe0f6a920">StringRef</a> () noexcept</td></tr>
<tr class="memdesc:a7ed3eed766b7dac3eaad6e7fe0f6a920"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> pointer to an empty string. <a href="#a7ed3eed766b7dac3eaad6e7fe0f6a920">More...</a><br /></td></tr>
<tr class="separator:a7ed3eed766b7dac3eaad6e7fe0f6a920"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fdf0812da686c16598871b20ae7bab8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a9fdf0812da686c16598871b20ae7bab8">operator const String::CharPointerType::CharType *</a> () const noexcept</td></tr>
<tr class="memdesc:a9fdf0812da686c16598871b20ae7bab8"><td class="mdescLeft"> </td><td class="mdescRight">Returns a raw pointer to the underlying string data. <a href="#a9fdf0812da686c16598871b20ae7bab8">More...</a><br /></td></tr>
<tr class="separator:a9fdf0812da686c16598871b20ae7bab8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad55d30afe25364e21e2f3a69c65de747"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#ad55d30afe25364e21e2f3a69c65de747">operator String::CharPointerType</a> () const noexcept</td></tr>
<tr class="memdesc:ad55d30afe25364e21e2f3a69c65de747"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to the underlying string data as a char pointer object. <a href="#ad55d30afe25364e21e2f3a69c65de747">More...</a><br /></td></tr>
<tr class="separator:ad55d30afe25364e21e2f3a69c65de747"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a767c25863e7e107f6dc465fa88ebf1f4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a767c25863e7e107f6dc465fa88ebf1f4">isEmpty</a> () const noexcept</td></tr>
<tr class="memdesc:a767c25863e7e107f6dc465fa88ebf1f4"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the string is empty. <a href="#a767c25863e7e107f6dc465fa88ebf1f4">More...</a><br /></td></tr>
<tr class="separator:a767c25863e7e107f6dc465fa88ebf1f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a289e7892dc5a52aa19dcb47127b0154d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a289e7892dc5a52aa19dcb47127b0154d">isNotEmpty</a> () const noexcept</td></tr>
<tr class="memdesc:a289e7892dc5a52aa19dcb47127b0154d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the string is not empty. <a href="#a289e7892dc5a52aa19dcb47127b0154d">More...</a><br /></td></tr>
<tr class="separator:a289e7892dc5a52aa19dcb47127b0154d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab566908106a7a19c17d45bbfbbd5849"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#aab566908106a7a19c17d45bbfbbd5849">length</a> () const noexcept</td></tr>
<tr class="memdesc:aab566908106a7a19c17d45bbfbbd5849"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of characters in the string. <a href="#aab566908106a7a19c17d45bbfbbd5849">More...</a><br /></td></tr>
<tr class="separator:aab566908106a7a19c17d45bbfbbd5849"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af48c6d8e1ca7c27911922e13a87096a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__CharacterFunctions_8h.html#a7d83261f3888884bbf04a58edc2672da">juce_wchar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#af48c6d8e1ca7c27911922e13a87096a9">operator[]</a> (int index) const noexcept</td></tr>
<tr class="memdesc:af48c6d8e1ca7c27911922e13a87096a9"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a character by index. <a href="#af48c6d8e1ca7c27911922e13a87096a9">More...</a><br /></td></tr>
<tr class="separator:af48c6d8e1ca7c27911922e13a87096a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10959a6c9442157518a6becb8f7bd3f7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a10959a6c9442157518a6becb8f7bd3f7">operator==</a> (const <a class="el" href="classString.html">String</a> &s) const noexcept</td></tr>
<tr class="memdesc:a10959a6c9442157518a6becb8f7bd3f7"><td class="mdescLeft"> </td><td class="mdescRight">Compares this <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> with a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. <a href="#a10959a6c9442157518a6becb8f7bd3f7">More...</a><br /></td></tr>
<tr class="separator:a10959a6c9442157518a6becb8f7bd3f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a795a1c11c40714951a19dcca2cd441"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a4a795a1c11c40714951a19dcca2cd441">operator!=</a> (const <a class="el" href="classString.html">String</a> &s) const noexcept</td></tr>
<tr class="memdesc:a4a795a1c11c40714951a19dcca2cd441"><td class="mdescLeft"> </td><td class="mdescRight">Compares this <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> with a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. <a href="#a4a795a1c11c40714951a19dcca2cd441">More...</a><br /></td></tr>
<tr class="separator:a4a795a1c11c40714951a19dcca2cd441"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c5652f5780779945bf238555b29a715"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a2c5652f5780779945bf238555b29a715">operator==</a> (<a class="el" href="classStringRef.html">StringRef</a> s) const noexcept</td></tr>
<tr class="memdesc:a2c5652f5780779945bf238555b29a715"><td class="mdescLeft"> </td><td class="mdescRight">Case-sensitive comparison of two StringRefs. <a href="#a2c5652f5780779945bf238555b29a715">More...</a><br /></td></tr>
<tr class="separator:a2c5652f5780779945bf238555b29a715"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7daa77216405e3d71d5c266088734d80"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a7daa77216405e3d71d5c266088734d80">operator!=</a> (<a class="el" href="classStringRef.html">StringRef</a> s) const noexcept</td></tr>
<tr class="memdesc:a7daa77216405e3d71d5c266088734d80"><td class="mdescLeft"> </td><td class="mdescRight">Case-sensitive comparison of two StringRefs. <a href="#a7daa77216405e3d71d5c266088734d80">More...</a><br /></td></tr>
<tr class="separator:a7daa77216405e3d71d5c266088734d80"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6a1889712d28a2d8725890b04e8bc020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringRef.html#a6a1889712d28a2d8725890b04e8bc020">text</a></td></tr>
<tr class="memdesc:a6a1889712d28a2d8725890b04e8bc020"><td class="mdescLeft"> </td><td class="mdescRight">The text that is referenced. <a href="#a6a1889712d28a2d8725890b04e8bc020">More...</a><br /></td></tr>
<tr class="separator:a6a1889712d28a2d8725890b04e8bc020"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A simple class for holding temporary references to a string literal or <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. </p>
<p>Unlike a real <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object, the <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> does not allocate any memory or take ownership of the strings you give to it - it simply holds a reference to a string that has been allocated elsewhere. The main purpose of the class is to be used instead of a const <a class="el" href="classString.html" title="The JUCE String class! ">String</a>& as the type of function arguments where the caller may pass either a string literal or a <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object. This means that when the called uses a string literal, there's no need for an temporary <a class="el" href="classString.html" title="The JUCE String class! ">String</a> object to be allocated, and this cuts down overheads substantially.</p>
<p>Because the class is simply a wrapper around a pointer, you should always pass it by value, not by reference.</p>
<div class="fragment"><div class="line"><span class="keywordtype">void</span> myStringFunction1 (<span class="keyword">const</span> <a class="code" href="classString.html">String</a>&);</div><div class="line"><span class="keywordtype">void</span> myStringFunction2 (<a class="code" href="classStringRef.html">StringRef</a>);</div><div class="line"></div><div class="line">myStringFunction1 (<span class="stringliteral">"abc"</span>); <span class="comment">// Implicitly allocates a temporary String object.</span></div><div class="line">myStringFunction2 (<span class="stringliteral">"abc"</span>); <span class="comment">// Much faster, as no local allocations are needed.</span></div></div><!-- fragment --><p>For examples of it in use, see the <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> or <a class="el" href="classStringArray.html" title="A special array for holding a list of strings. ">StringArray</a> classes.</p>
<p>Bear in mind that there are still many cases where it's better to use an argument which is a const <a class="el" href="classString.html" title="The JUCE String class! ">String</a>&. For example if the function stores the string or needs to internally create a <a class="el" href="classString.html" title="The JUCE String class! ">String</a> from the argument, then it's better for the original argument to already be a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classString.html" title="The JUCE String class! ">String</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="afdd484f4bdb44927ffc3ae24292f0cd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdd484f4bdb44927ffc3ae24292f0cd6">§ </a></span>StringRef() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::StringRef </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>stringLiteral</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="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a raw string literal. </p>
<p>The <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> object does NOT take ownership or copy this data, so you must ensure that the data does not change during the lifetime of the <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a>. Note that this pointer not be null! </p>
</div>
</div>
<a id="a4c1e86162550a9fa7f3f9aa65b9cc74a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c1e86162550a9fa7f3f9aa65b9cc74a">§ </a></span>StringRef() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::StringRef </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> </td>
<td class="paramname"><em>stringLiteral</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="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a raw char pointer. </p>
<p>The <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> object does NOT take ownership or copy this data, so you must ensure that the data does not change during the lifetime of the <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a>. </p>
</div>
</div>
<a id="a47ea3e1c936ecf660bf9f98b7f75d28e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47ea3e1c936ecf660bf9f98b7f75d28e">§ </a></span>StringRef() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::StringRef </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>string</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="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> from a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. </p>
<p>The <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> object does NOT take ownership or copy the data from the <a class="el" href="classString.html" title="The JUCE String class! ">String</a>, so you must ensure that the <a class="el" href="classString.html" title="The JUCE String class! ">String</a> is not modified or deleted during the lifetime of the <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a>. </p>
</div>
</div>
<a id="a7ed3eed766b7dac3eaad6e7fe0f6a920"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ed3eed766b7dac3eaad6e7fe0f6a920">§ </a></span>StringRef() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::StringRef </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="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> pointer to an empty string. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9fdf0812da686c16598871b20ae7bab8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fdf0812da686c16598871b20ae7bab8">§ </a></span>operator const String::CharPointerType::CharType *()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::operator const <a class="el" href="classCharPointer__UTF8.html#ac410c2e8043cffd3cf0ae00e04c6e630">String::CharPointerType::CharType</a> * </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 a raw pointer to the underlying string data. </p>
</div>
</div>
<a id="ad55d30afe25364e21e2f3a69c65de747"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad55d30afe25364e21e2f3a69c65de747">§ </a></span>operator String::CharPointerType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringRef::operator <a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> </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 a pointer to the underlying string data as a char pointer object. </p>
</div>
</div>
<a id="a767c25863e7e107f6dc465fa88ebf1f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a767c25863e7e107f6dc465fa88ebf1f4">§ </a></span>isEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool StringRef::isEmpty </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 string is empty. </p>
</div>
</div>
<a id="a289e7892dc5a52aa19dcb47127b0154d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a289e7892dc5a52aa19dcb47127b0154d">§ </a></span>isNotEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool StringRef::isNotEmpty </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 string is not empty. </p>
</div>
</div>
<a id="aab566908106a7a19c17d45bbfbbd5849"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab566908106a7a19c17d45bbfbbd5849">§ </a></span>length()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int StringRef::length </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 number of characters in the string. </p>
</div>
</div>
<a id="af48c6d8e1ca7c27911922e13a87096a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af48c6d8e1ca7c27911922e13a87096a9">§ </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="juce__CharacterFunctions_8h.html#a7d83261f3888884bbf04a58edc2672da">juce_wchar</a> StringRef::operator[] </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></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>Retrieves a character by index. </p>
</div>
</div>
<a id="a10959a6c9442157518a6becb8f7bd3f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10959a6c9442157518a6becb8f7bd3f7">§ </a></span>operator==() <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">bool StringRef::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>s</em></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>Compares this <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> with a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. </p>
</div>
</div>
<a id="a4a795a1c11c40714951a19dcca2cd441"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a795a1c11c40714951a19dcca2cd441">§ </a></span>operator!=() <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">bool StringRef::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>s</em></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>Compares this <a class="el" href="classStringRef.html" title="A simple class for holding temporary references to a string literal or String. ">StringRef</a> with a <a class="el" href="classString.html" title="The JUCE String class! ">String</a>. </p>
</div>
</div>
<a id="a2c5652f5780779945bf238555b29a715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c5652f5780779945bf238555b29a715">§ </a></span>operator==() <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">bool StringRef::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>s</em></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>Case-sensitive comparison of two StringRefs. </p>
</div>
</div>
<a id="a7daa77216405e3d71d5c266088734d80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7daa77216405e3d71d5c266088734d80">§ </a></span>operator!=() <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">bool StringRef::operator!= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>s</em></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>Case-sensitive comparison of two StringRefs. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6a1889712d28a2d8725890b04e8bc020"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a1889712d28a2d8725890b04e8bc020">§ </a></span>text</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html#a32e28d7fc3a4900c319884191d90dbf0">String::CharPointerType</a> StringRef::text</td>
</tr>
</table>
</div><div class="memdoc">
<p>The text that is referenced. </p>
<p>Referenced by <a class="el" href="classRectangle.html#aeebcebc71a8f2fb7fd216acb0bd45a55">Rectangle< int >::fromString()</a>, and <a class="el" href="juce__StringRef_8h.html#ac4d152f0cb9688f5a0d09a5275ff8fe7">operator+()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__StringRef_8h.html">juce_StringRef.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|