/usr/share/doc/libjuce/apiref/classStringPairArray.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 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 | <!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: StringPairArray 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="classStringPairArray-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">StringPairArray Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A container for holding a set of strings which are keyed by another string.
<a href="classStringPairArray.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:a606a520b01b1c8505ae5bba847ac0d85"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a606a520b01b1c8505ae5bba847ac0d85">StringPairArray</a> (bool ignoreCaseWhenComparingKeys=true)</td></tr>
<tr class="memdesc:a606a520b01b1c8505ae5bba847ac0d85"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty array. <a href="#a606a520b01b1c8505ae5bba847ac0d85">More...</a><br /></td></tr>
<tr class="separator:a606a520b01b1c8505ae5bba847ac0d85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae9d7222fa917d07fa51815681bd61f50"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#ae9d7222fa917d07fa51815681bd61f50">StringPairArray</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &other)</td></tr>
<tr class="memdesc:ae9d7222fa917d07fa51815681bd61f50"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another array. <a href="#ae9d7222fa917d07fa51815681bd61f50">More...</a><br /></td></tr>
<tr class="separator:ae9d7222fa917d07fa51815681bd61f50"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e01064c8cd1ae16f106673552306d99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a0e01064c8cd1ae16f106673552306d99">~StringPairArray</a> ()</td></tr>
<tr class="memdesc:a0e01064c8cd1ae16f106673552306d99"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a0e01064c8cd1ae16f106673552306d99">More...</a><br /></td></tr>
<tr class="separator:a0e01064c8cd1ae16f106673552306d99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2d261429821952f6a05d4b198c921486"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classStringPairArray.html">StringPairArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a2d261429821952f6a05d4b198c921486">operator=</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &other)</td></tr>
<tr class="memdesc:a2d261429821952f6a05d4b198c921486"><td class="mdescLeft"> </td><td class="mdescRight">Copies the contents of another string array into this one. <a href="#a2d261429821952f6a05d4b198c921486">More...</a><br /></td></tr>
<tr class="separator:a2d261429821952f6a05d4b198c921486"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4139d51fd7847490f7ef5986d51858cb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a4139d51fd7847490f7ef5986d51858cb">operator==</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &other) const</td></tr>
<tr class="memdesc:a4139d51fd7847490f7ef5986d51858cb"><td class="mdescLeft"> </td><td class="mdescRight">Compares two arrays. <a href="#a4139d51fd7847490f7ef5986d51858cb">More...</a><br /></td></tr>
<tr class="separator:a4139d51fd7847490f7ef5986d51858cb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35469469809624ad06f183feb33193a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a35469469809624ad06f183feb33193a9">operator!=</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &other) const</td></tr>
<tr class="memdesc:a35469469809624ad06f183feb33193a9"><td class="mdescLeft"> </td><td class="mdescRight">Compares two arrays. <a href="#a35469469809624ad06f183feb33193a9">More...</a><br /></td></tr>
<tr class="separator:a35469469809624ad06f183feb33193a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6daaa0f9e90d1e5fcad02a0586695d8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#ac6daaa0f9e90d1e5fcad02a0586695d8">operator[]</a> (<a class="el" href="classStringRef.html">StringRef</a> key) const</td></tr>
<tr class="memdesc:ac6daaa0f9e90d1e5fcad02a0586695d8"><td class="mdescLeft"> </td><td class="mdescRight">Finds the value corresponding to a key string. <a href="#ac6daaa0f9e90d1e5fcad02a0586695d8">More...</a><br /></td></tr>
<tr class="separator:ac6daaa0f9e90d1e5fcad02a0586695d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8510d46e9cbdeff9c662f97dac4ed0f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a8510d46e9cbdeff9c662f97dac4ed0f4">getValue</a> (<a class="el" href="classStringRef.html">StringRef</a>, const <a class="el" href="classString.html">String</a> &defaultReturnValue) const</td></tr>
<tr class="memdesc:a8510d46e9cbdeff9c662f97dac4ed0f4"><td class="mdescLeft"> </td><td class="mdescRight">Finds the value corresponding to a key string. <a href="#a8510d46e9cbdeff9c662f97dac4ed0f4">More...</a><br /></td></tr>
<tr class="separator:a8510d46e9cbdeff9c662f97dac4ed0f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dfe1dba255e20925aa760fca094099d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a8dfe1dba255e20925aa760fca094099d">containsKey</a> (<a class="el" href="classStringRef.html">StringRef</a> key) const noexcept</td></tr>
<tr class="memdesc:a8dfe1dba255e20925aa760fca094099d"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given key exists. <a href="#a8dfe1dba255e20925aa760fca094099d">More...</a><br /></td></tr>
<tr class="separator:a8dfe1dba255e20925aa760fca094099d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe09f8163564ff39529f5c942977b691"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringArray.html">StringArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#afe09f8163564ff39529f5c942977b691">getAllKeys</a> () const noexcept</td></tr>
<tr class="memdesc:afe09f8163564ff39529f5c942977b691"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all keys in the array. <a href="#afe09f8163564ff39529f5c942977b691">More...</a><br /></td></tr>
<tr class="separator:afe09f8163564ff39529f5c942977b691"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a82ff57a56741ebe88729e926f593af"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringArray.html">StringArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a3a82ff57a56741ebe88729e926f593af">getAllValues</a> () const noexcept</td></tr>
<tr class="memdesc:a3a82ff57a56741ebe88729e926f593af"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all values in the array. <a href="#a3a82ff57a56741ebe88729e926f593af">More...</a><br /></td></tr>
<tr class="separator:a3a82ff57a56741ebe88729e926f593af"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae488d0a644afedc40004d37c938f3e8e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#ae488d0a644afedc40004d37c938f3e8e">size</a> () const noexcept</td></tr>
<tr class="memdesc:ae488d0a644afedc40004d37c938f3e8e"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of strings in the array. <a href="#ae488d0a644afedc40004d37c938f3e8e">More...</a><br /></td></tr>
<tr class="separator:ae488d0a644afedc40004d37c938f3e8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a9a1f077d33f143b50628bd35f69516"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a1a9a1f077d33f143b50628bd35f69516">set</a> (const <a class="el" href="classString.html">String</a> &key, const <a class="el" href="classString.html">String</a> &value)</td></tr>
<tr class="memdesc:a1a9a1f077d33f143b50628bd35f69516"><td class="mdescLeft"> </td><td class="mdescRight">Adds or amends a key/value pair. <a href="#a1a9a1f077d33f143b50628bd35f69516">More...</a><br /></td></tr>
<tr class="separator:a1a9a1f077d33f143b50628bd35f69516"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15be7425b909b9aded5eddf69f096466"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a15be7425b909b9aded5eddf69f096466">addArray</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &other)</td></tr>
<tr class="memdesc:a15be7425b909b9aded5eddf69f096466"><td class="mdescLeft"> </td><td class="mdescRight">Adds the items from another array to this one. <a href="#a15be7425b909b9aded5eddf69f096466">More...</a><br /></td></tr>
<tr class="separator:a15be7425b909b9aded5eddf69f096466"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79f8a87870700e5cb53a5a4f5d05658f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a79f8a87870700e5cb53a5a4f5d05658f">clear</a> ()</td></tr>
<tr class="memdesc:a79f8a87870700e5cb53a5a4f5d05658f"><td class="mdescLeft"> </td><td class="mdescRight">Removes all elements from the array. <a href="#a79f8a87870700e5cb53a5a4f5d05658f">More...</a><br /></td></tr>
<tr class="separator:a79f8a87870700e5cb53a5a4f5d05658f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33110fcda0e416e0e7581387f6965678"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a33110fcda0e416e0e7581387f6965678">remove</a> (<a class="el" href="classStringRef.html">StringRef</a> key)</td></tr>
<tr class="memdesc:a33110fcda0e416e0e7581387f6965678"><td class="mdescLeft"> </td><td class="mdescRight">Removes a string from the array based on its key. <a href="#a33110fcda0e416e0e7581387f6965678">More...</a><br /></td></tr>
<tr class="separator:a33110fcda0e416e0e7581387f6965678"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafc00fcda71c9832f6f77f0fba7c781e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#aafc00fcda71c9832f6f77f0fba7c781e">remove</a> (int index)</td></tr>
<tr class="memdesc:aafc00fcda71c9832f6f77f0fba7c781e"><td class="mdescLeft"> </td><td class="mdescRight">Removes a string from the array based on its index. <a href="#aafc00fcda71c9832f6f77f0fba7c781e">More...</a><br /></td></tr>
<tr class="separator:aafc00fcda71c9832f6f77f0fba7c781e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d884d5d61f3617e2290bba08fa4effa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a6d884d5d61f3617e2290bba08fa4effa">setIgnoresCase</a> (bool shouldIgnoreCase)</td></tr>
<tr class="memdesc:a6d884d5d61f3617e2290bba08fa4effa"><td class="mdescLeft"> </td><td class="mdescRight">Indicates whether to use a case-insensitive search when looking up a key string. <a href="#a6d884d5d61f3617e2290bba08fa4effa">More...</a><br /></td></tr>
<tr class="separator:a6d884d5d61f3617e2290bba08fa4effa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a833b1ac920151776378a48d98f05cd70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a833b1ac920151776378a48d98f05cd70">getDescription</a> () const</td></tr>
<tr class="memdesc:a833b1ac920151776378a48d98f05cd70"><td class="mdescLeft"> </td><td class="mdescRight">Returns a descriptive string containing the items. <a href="#a833b1ac920151776378a48d98f05cd70">More...</a><br /></td></tr>
<tr class="separator:a833b1ac920151776378a48d98f05cd70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35917c28f68b33afe84e2a22a373a67d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStringPairArray.html#a35917c28f68b33afe84e2a22a373a67d">minimiseStorageOverheads</a> ()</td></tr>
<tr class="memdesc:a35917c28f68b33afe84e2a22a373a67d"><td class="mdescLeft"> </td><td class="mdescRight">Reduces the amount of storage being used by the array. <a href="#a35917c28f68b33afe84e2a22a373a67d">More...</a><br /></td></tr>
<tr class="separator:a35917c28f68b33afe84e2a22a373a67d"><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 container for holding a set of strings which are keyed by another string. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classStringArray.html" title="A special array for holding a list of strings. ">StringArray</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a606a520b01b1c8505ae5bba847ac0d85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a606a520b01b1c8505ae5bba847ac0d85">§ </a></span>StringPairArray() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringPairArray::StringPairArray </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ignoreCaseWhenComparingKeys</em> = <code>true</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty array. </p>
</div>
</div>
<a id="ae9d7222fa917d07fa51815681bd61f50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9d7222fa917d07fa51815681bd61f50">§ </a></span>StringPairArray() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringPairArray::StringPairArray </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of another array. </p>
</div>
</div>
<a id="a0e01064c8cd1ae16f106673552306d99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e01064c8cd1ae16f106673552306d99">§ </a></span>~StringPairArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">StringPairArray::~StringPairArray </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2d261429821952f6a05d4b198c921486"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d261429821952f6a05d4b198c921486">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classStringPairArray.html">StringPairArray</a>& StringPairArray::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies the contents of another string array into this one. </p>
</div>
</div>
<a id="a4139d51fd7847490f7ef5986d51858cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4139d51fd7847490f7ef5986d51858cb">§ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool StringPairArray::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two arrays. </p>
<p>Comparisons are case-sensitive. </p><dl class="section return"><dt>Returns</dt><dd>true only if the other array contains exactly the same strings with the same keys </dd></dl>
</div>
</div>
<a id="a35469469809624ad06f183feb33193a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35469469809624ad06f183feb33193a9">§ </a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool StringPairArray::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two arrays. </p>
<p>Comparisons are case-sensitive. </p><dl class="section return"><dt>Returns</dt><dd>false if the other array contains exactly the same strings with the same keys </dd></dl>
</div>
</div>
<a id="ac6daaa0f9e90d1e5fcad02a0586695d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6daaa0f9e90d1e5fcad02a0586695d8">§ </a></span>operator[]()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classString.html">String</a>& StringPairArray::operator[] </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the value corresponding to a key string. </p>
<p>If no such key is found, this will just return an empty string. To check whether a given key actually exists (because it might actually be paired with an empty string), use the <a class="el" href="classStringPairArray.html#afe09f8163564ff39529f5c942977b691" title="Returns a list of all keys in the array. ">getAllKeys()</a> method to obtain a list.</p>
<p>Obviously the reference returned shouldn't be stored for later use, as the string it refers to may disappear when the array changes.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classStringPairArray.html#a8510d46e9cbdeff9c662f97dac4ed0f4" title="Finds the value corresponding to a key string. ">getValue</a> </dd></dl>
</div>
</div>
<a id="a8510d46e9cbdeff9c662f97dac4ed0f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8510d46e9cbdeff9c662f97dac4ed0f4">§ </a></span>getValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPairArray::getValue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>defaultReturnValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the value corresponding to a key string. </p>
<p>If no such key is found, this will just return the value provided as a default. </p><dl class="section see"><dt>See also</dt><dd>operator[] </dd></dl>
</div>
</div>
<a id="a8dfe1dba255e20925aa760fca094099d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dfe1dba255e20925aa760fca094099d">§ </a></span>containsKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool StringPairArray::containsKey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>key</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>Returns true if the given key exists. </p>
</div>
</div>
<a id="afe09f8163564ff39529f5c942977b691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe09f8163564ff39529f5c942977b691">§ </a></span>getAllKeys()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringArray.html">StringArray</a>& StringPairArray::getAllKeys </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 list of all keys in the array. </p>
</div>
</div>
<a id="a3a82ff57a56741ebe88729e926f593af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a82ff57a56741ebe88729e926f593af">§ </a></span>getAllValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringArray.html">StringArray</a>& StringPairArray::getAllValues </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 list of all values in the array. </p>
</div>
</div>
<a id="ae488d0a644afedc40004d37c938f3e8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae488d0a644afedc40004d37c938f3e8e">§ </a></span>size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int StringPairArray::size </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 strings in the array. </p>
<p>References <a class="el" href="juce__LeakedObjectDetector_8h.html#ab3639a79598b35f2116f4572af0d93f1">JUCE_LEAK_DETECTOR</a>.</p>
</div>
</div>
<a id="a1a9a1f077d33f143b50628bd35f69516"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a9a1f077d33f143b50628bd35f69516">§ </a></span>set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds or amends a key/value pair. </p>
<p>If a value already exists with this key, its value will be overwritten, otherwise the key/value pair will be added to the array. </p>
</div>
</div>
<a id="a15be7425b909b9aded5eddf69f096466"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15be7425b909b9aded5eddf69f096466">§ </a></span>addArray()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::addArray </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds the items from another array to this one. </p>
<p>This is equivalent to using <a class="el" href="classStringPairArray.html#a1a9a1f077d33f143b50628bd35f69516" title="Adds or amends a key/value pair. ">set()</a> to add each of the pairs from the other array. </p>
</div>
</div>
<a id="a79f8a87870700e5cb53a5a4f5d05658f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79f8a87870700e5cb53a5a4f5d05658f">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all elements from the array. </p>
</div>
</div>
<a id="a33110fcda0e416e0e7581387f6965678"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33110fcda0e416e0e7581387f6965678">§ </a></span>remove() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classStringRef.html">StringRef</a> </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a string from the array based on its key. </p>
<p>If the key isn't found, nothing will happen. </p>
</div>
</div>
<a id="aafc00fcda71c9832f6f77f0fba7c781e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafc00fcda71c9832f6f77f0fba7c781e">§ </a></span>remove() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::remove </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a string from the array based on its index. </p>
<p>If the index is out-of-range, no action will be taken. </p>
</div>
</div>
<a id="a6d884d5d61f3617e2290bba08fa4effa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d884d5d61f3617e2290bba08fa4effa">§ </a></span>setIgnoresCase()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::setIgnoresCase </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>shouldIgnoreCase</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicates whether to use a case-insensitive search when looking up a key string. </p>
</div>
</div>
<a id="a833b1ac920151776378a48d98f05cd70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a833b1ac920151776378a48d98f05cd70">§ </a></span>getDescription()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> StringPairArray::getDescription </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a descriptive string containing the items. </p>
<p>This is handy for dumping the contents of an array. </p>
</div>
</div>
<a id="a35917c28f68b33afe84e2a22a373a67d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35917c28f68b33afe84e2a22a373a67d">§ </a></span>minimiseStorageOverheads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void StringPairArray::minimiseStorageOverheads </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reduces the amount of storage being used by the array. </p>
<p>Arrays typically allocate slightly more storage than they need, and after removing elements, they may have quite a lot of unused space allocated. This method will reduce the amount of allocated storage to a minimum. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__StringPairArray_8h.html">juce_StringPairArray.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|