/usr/share/doc/libjuce/apiref/classKeyPressMappingSet.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 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 | <!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: KeyPressMappingSet 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="classKeyPressMappingSet-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">KeyPressMappingSet Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>.
<a href="classKeyPressMappingSet.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for KeyPressMappingSet:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classKeyPressMappingSet.png" usemap="#KeyPressMappingSet_map" alt=""/>
<map id="KeyPressMappingSet_map" name="KeyPressMappingSet_map">
<area href="classKeyListener.html" title="Receives callbacks when keys are pressed. " alt="KeyListener" shape="rect" coords="0,0,136,24"/>
<area href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. " alt="ChangeBroadcaster" shape="rect" coords="146,0,282,24"/>
<area href="classFocusChangeListener.html" title="Classes can implement this interface and register themselves with the Desktop class to receive callba..." alt="FocusChangeListener" shape="rect" coords="292,0,428,24"/>
</map>
</div></div>
<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:a809a42cae8d2bfaf754c369f01a03870"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a809a42cae8d2bfaf754c369f01a03870">KeyPressMappingSet</a> (<a class="el" href="classApplicationCommandManager.html">ApplicationCommandManager</a> &)</td></tr>
<tr class="memdesc:a809a42cae8d2bfaf754c369f01a03870"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a> for a given command manager. <a href="#a809a42cae8d2bfaf754c369f01a03870">More...</a><br /></td></tr>
<tr class="separator:a809a42cae8d2bfaf754c369f01a03870"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af094b874c041df2b6ba52855573e2437"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#af094b874c041df2b6ba52855573e2437">KeyPressMappingSet</a> (const <a class="el" href="classKeyPressMappingSet.html">KeyPressMappingSet</a> &)</td></tr>
<tr class="memdesc:af094b874c041df2b6ba52855573e2437"><td class="mdescLeft"> </td><td class="mdescRight">Creates an copy of a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a>. <a href="#af094b874c041df2b6ba52855573e2437">More...</a><br /></td></tr>
<tr class="separator:af094b874c041df2b6ba52855573e2437"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adae95f518172adb938d30d38cf361743"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#adae95f518172adb938d30d38cf361743">~KeyPressMappingSet</a> ()</td></tr>
<tr class="memdesc:adae95f518172adb938d30d38cf361743"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#adae95f518172adb938d30d38cf361743">More...</a><br /></td></tr>
<tr class="separator:adae95f518172adb938d30d38cf361743"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8c3bf18eddf7d637934cf1c4e271791"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classApplicationCommandManager.html">ApplicationCommandManager</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#ad8c3bf18eddf7d637934cf1c4e271791">getCommandManager</a> () const noexcept</td></tr>
<tr class="separator:ad8c3bf18eddf7d637934cf1c4e271791"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e195f0c065f2cbc7b2c74a41df457fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classArray.html">Array</a>< <a class="el" href="classKeyPress.html">KeyPress</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a9e195f0c065f2cbc7b2c74a41df457fc">getKeyPressesAssignedToCommand</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID) const</td></tr>
<tr class="memdesc:a9e195f0c065f2cbc7b2c74a41df457fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of keypresses that are assigned to a particular command. <a href="#a9e195f0c065f2cbc7b2c74a41df457fc">More...</a><br /></td></tr>
<tr class="separator:a9e195f0c065f2cbc7b2c74a41df457fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2adbad788cddf223990617e00fbd7f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#ac2adbad788cddf223990617e00fbd7f1">addKeyPress</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID, const <a class="el" href="classKeyPress.html">KeyPress</a> &newKeyPress, int insertIndex=-1)</td></tr>
<tr class="memdesc:ac2adbad788cddf223990617e00fbd7f1"><td class="mdescLeft"> </td><td class="mdescRight">Assigns a keypress to a command. <a href="#ac2adbad788cddf223990617e00fbd7f1">More...</a><br /></td></tr>
<tr class="separator:ac2adbad788cddf223990617e00fbd7f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11ec4b86290489da987e2fcc3455b140"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140">resetToDefaultMappings</a> ()</td></tr>
<tr class="memdesc:a11ec4b86290489da987e2fcc3455b140"><td class="mdescLeft"> </td><td class="mdescRight">Reset all mappings to the defaults, as dictated by the <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>. <a href="#a11ec4b86290489da987e2fcc3455b140">More...</a><br /></td></tr>
<tr class="separator:a11ec4b86290489da987e2fcc3455b140"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60fb5f6f71f8d4b9ef04627c625fb5b5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a60fb5f6f71f8d4b9ef04627c625fb5b5">resetToDefaultMapping</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID)</td></tr>
<tr class="memdesc:a60fb5f6f71f8d4b9ef04627c625fb5b5"><td class="mdescLeft"> </td><td class="mdescRight">Resets all key-mappings to the defaults for a particular command. <a href="#a60fb5f6f71f8d4b9ef04627c625fb5b5">More...</a><br /></td></tr>
<tr class="separator:a60fb5f6f71f8d4b9ef04627c625fb5b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16e2d91480adcd22ee5dbfdce01c0156"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a16e2d91480adcd22ee5dbfdce01c0156">clearAllKeyPresses</a> ()</td></tr>
<tr class="memdesc:a16e2d91480adcd22ee5dbfdce01c0156"><td class="mdescLeft"> </td><td class="mdescRight">Removes all keypresses that are assigned to any commands. <a href="#a16e2d91480adcd22ee5dbfdce01c0156">More...</a><br /></td></tr>
<tr class="separator:a16e2d91480adcd22ee5dbfdce01c0156"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9f3803440dd3d36fd79680c8dc2cc779"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a9f3803440dd3d36fd79680c8dc2cc779">clearAllKeyPresses</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID)</td></tr>
<tr class="memdesc:a9f3803440dd3d36fd79680c8dc2cc779"><td class="mdescLeft"> </td><td class="mdescRight">Removes all keypresses that are assigned to a particular command. <a href="#a9f3803440dd3d36fd79680c8dc2cc779">More...</a><br /></td></tr>
<tr class="separator:a9f3803440dd3d36fd79680c8dc2cc779"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69386f2e687ced9630b24a745b6fa33a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a69386f2e687ced9630b24a745b6fa33a">removeKeyPress</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID, int keyPressIndex)</td></tr>
<tr class="memdesc:a69386f2e687ced9630b24a745b6fa33a"><td class="mdescLeft"> </td><td class="mdescRight">Removes one of the keypresses that are assigned to a command. <a href="#a69386f2e687ced9630b24a745b6fa33a">More...</a><br /></td></tr>
<tr class="separator:a69386f2e687ced9630b24a745b6fa33a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0626523ca6a55cc5948531f0382e2ad8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a0626523ca6a55cc5948531f0382e2ad8">removeKeyPress</a> (const <a class="el" href="classKeyPress.html">KeyPress</a> &keypress)</td></tr>
<tr class="memdesc:a0626523ca6a55cc5948531f0382e2ad8"><td class="mdescLeft"> </td><td class="mdescRight">Removes a keypress from any command that it may be assigned to. <a href="#a0626523ca6a55cc5948531f0382e2ad8">More...</a><br /></td></tr>
<tr class="separator:a0626523ca6a55cc5948531f0382e2ad8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a452b1dd8851dd760fb52f97637f387a5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a452b1dd8851dd760fb52f97637f387a5">containsMapping</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID, const <a class="el" href="classKeyPress.html">KeyPress</a> &keyPress) const noexcept</td></tr>
<tr class="memdesc:a452b1dd8851dd760fb52f97637f387a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given command is linked to this key. <a href="#a452b1dd8851dd760fb52f97637f387a5">More...</a><br /></td></tr>
<tr class="separator:a452b1dd8851dd760fb52f97637f387a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a748d3657cb192844b1ff7cfa1044231d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a748d3657cb192844b1ff7cfa1044231d">findCommandForKeyPress</a> (const <a class="el" href="classKeyPress.html">KeyPress</a> &keyPress) const noexcept</td></tr>
<tr class="memdesc:a748d3657cb192844b1ff7cfa1044231d"><td class="mdescLeft"> </td><td class="mdescRight">Looks for a command that corresponds to a keypress. <a href="#a748d3657cb192844b1ff7cfa1044231d">More...</a><br /></td></tr>
<tr class="separator:a748d3657cb192844b1ff7cfa1044231d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd0da647bbd350e6daebcd8705a8b11e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#acd0da647bbd350e6daebcd8705a8b11e">restoreFromXml</a> (const <a class="el" href="classXmlElement.html">XmlElement</a> &xmlVersion)</td></tr>
<tr class="memdesc:acd0da647bbd350e6daebcd8705a8b11e"><td class="mdescLeft"> </td><td class="mdescRight">Tries to recreate the mappings from a previously stored state. <a href="#acd0da647bbd350e6daebcd8705a8b11e">More...</a><br /></td></tr>
<tr class="separator:acd0da647bbd350e6daebcd8705a8b11e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af138b81ebe656729ee4b900354d28505"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#af138b81ebe656729ee4b900354d28505">createXml</a> (bool saveDifferencesFromDefaultSet) const</td></tr>
<tr class="memdesc:af138b81ebe656729ee4b900354d28505"><td class="mdescLeft"> </td><td class="mdescRight">Creates an XML representation of the current mappings. <a href="#af138b81ebe656729ee4b900354d28505">More...</a><br /></td></tr>
<tr class="separator:af138b81ebe656729ee4b900354d28505"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab92a471a8cfc20ad036750cd3c19d5c5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#ab92a471a8cfc20ad036750cd3c19d5c5">keyPressed</a> (const <a class="el" href="classKeyPress.html">KeyPress</a> &, <a class="el" href="classComponent.html">Component</a> *) override</td></tr>
<tr class="separator:ab92a471a8cfc20ad036750cd3c19d5c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0329856dd3e6ec50d64114f197045491"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a0329856dd3e6ec50d64114f197045491">keyStateChanged</a> (bool isKeyDown, <a class="el" href="classComponent.html">Component</a> *) override</td></tr>
<tr class="separator:a0329856dd3e6ec50d64114f197045491"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a87b7a4ae2b7365723e47e29cf48500"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyPressMappingSet.html#a9a87b7a4ae2b7365723e47e29cf48500">globalFocusChanged</a> (<a class="el" href="classComponent.html">Component</a> *) override</td></tr>
<tr class="separator:a9a87b7a4ae2b7365723e47e29cf48500"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classKeyListener"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classKeyListener')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classKeyListener.html">KeyListener</a></td></tr>
<tr class="memitem:a3b63a69dab82d70acb71939a4c05b869 inherit pub_methods_classKeyListener"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classKeyListener.html#a3b63a69dab82d70acb71939a4c05b869">~KeyListener</a> ()</td></tr>
<tr class="memdesc:a3b63a69dab82d70acb71939a4c05b869 inherit pub_methods_classKeyListener"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classKeyListener.html#a3b63a69dab82d70acb71939a4c05b869">More...</a><br /></td></tr>
<tr class="separator:a3b63a69dab82d70acb71939a4c05b869 inherit pub_methods_classKeyListener"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classChangeBroadcaster"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classChangeBroadcaster')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classChangeBroadcaster.html">ChangeBroadcaster</a></td></tr>
<tr class="memitem:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">ChangeBroadcaster</a> () noexcept</td></tr>
<tr class="memdesc:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a>. <a href="classChangeBroadcaster.html#a1c8ccfa186a47d58a05e7f1f1576c038">More...</a><br /></td></tr>
<tr class="separator:a1c8ccfa186a47d58a05e7f1f1576c038 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">~ChangeBroadcaster</a> ()</td></tr>
<tr class="memdesc:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classChangeBroadcaster.html#a3b2f8465cc6c09c0583c8bdf56319742">More...</a><br /></td></tr>
<tr class="separator:a3b2f8465cc6c09c0583c8bdf56319742 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">addChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Registers a listener to receive change callbacks from this broadcaster. <a href="classChangeBroadcaster.html#ad68416fe79a94cd5c99519bdea6c2a06">More...</a><br /></td></tr>
<tr class="separator:ad68416fe79a94cd5c99519bdea6c2a06 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">removeChangeListener</a> (<a class="el" href="classChangeListener.html">ChangeListener</a> *listener)</td></tr>
<tr class="memdesc:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Unregisters a listener from the list. <a href="classChangeBroadcaster.html#ae558a26c795278549a63e342bd5f1650">More...</a><br /></td></tr>
<tr class="separator:ae558a26c795278549a63e342bd5f1650 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">removeAllChangeListeners</a> ()</td></tr>
<tr class="memdesc:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Removes all listeners from the list. <a href="classChangeBroadcaster.html#a6b9c150078318d419debc82e6f22ce58">More...</a><br /></td></tr>
<tr class="separator:a6b9c150078318d419debc82e6f22ce58 inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">sendChangeMessage</a> ()</td></tr>
<tr class="memdesc:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Causes an asynchronous change message to be sent to all the registered listeners. <a href="classChangeBroadcaster.html#a10f01d1c0a7fde85355321985a682cbd">More...</a><br /></td></tr>
<tr class="separator:a10f01d1c0a7fde85355321985a682cbd inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">sendSynchronousChangeMessage</a> ()</td></tr>
<tr class="memdesc:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">Sends a synchronous change message to all the registered listeners. <a href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b">More...</a><br /></td></tr>
<tr class="separator:a5d16cd01b9af4bacb1716530af17f77b inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">dispatchPendingMessages</a> ()</td></tr>
<tr class="memdesc:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="mdescLeft"> </td><td class="mdescRight">If a change message has been sent but not yet dispatched, this will call <a class="el" href="classChangeBroadcaster.html#a5d16cd01b9af4bacb1716530af17f77b" title="Sends a synchronous change message to all the registered listeners. ">sendSynchronousChangeMessage()</a> to make the callback immediately. <a href="classChangeBroadcaster.html#a78f62ecd57a016f8ba7a6ce55454947d">More...</a><br /></td></tr>
<tr class="separator:a78f62ecd57a016f8ba7a6ce55454947d inherit pub_methods_classChangeBroadcaster"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>. </p>
<p>Normally, you won't actually create a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a> directly, because each <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a> contains its own <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a>, so typically you'd create yourself an <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>, and call its <a class="el" href="classApplicationCommandManager.html#a5fea4f129e149062866c0313b29ba976" title="Returns the manager's internal set of key mappings. ">ApplicationCommandManager::getKeyMappings()</a> method to get a pointer to its <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a>.</p>
<p>For one of these to actually use keypresses, you'll need to add it as a <a class="el" href="classKeyListener.html" title="Receives callbacks when keys are pressed. ">KeyListener</a> to the top-level component for which you want to handle keystrokes. So for example:</p>
<div class="fragment"><div class="line"><span class="keyword">class </span>MyMainWindow : <span class="keyword">public</span> <a class="code" href="classComponent.html">Component</a></div><div class="line">{</div><div class="line"> <a class="code" href="classApplicationCommandManager.html">ApplicationCommandManager</a>* myCommandManager;</div><div class="line"></div><div class="line"><span class="keyword">public</span>:</div><div class="line"> MyMainWindow()</div><div class="line"> {</div><div class="line"> myCommandManager = <span class="keyword">new</span> <a class="code" href="classApplicationCommandManager.html">ApplicationCommandManager</a>();</div><div class="line"></div><div class="line"> <span class="comment">// first, make sure the command manager has registered all the commands that its</span></div><div class="line"> <span class="comment">// targets can perform..</span></div><div class="line"> myCommandManager-><a class="code" href="classApplicationCommandManager.html#ac3f8c831583499556579848779e030cf">registerAllCommandsForTarget</a> (myCommandTarget1);</div><div class="line"> myCommandManager-><a class="code" href="classApplicationCommandManager.html#ac3f8c831583499556579848779e030cf">registerAllCommandsForTarget</a> (myCommandTarget2);</div><div class="line"></div><div class="line"> <span class="comment">// this will use the command manager to initialise the KeyPressMappingSet with</span></div><div class="line"> <span class="comment">// the default keypresses that were specified when the targets added their commands</span></div><div class="line"> <span class="comment">// to the manager.</span></div><div class="line"> myCommandManager-><a class="code" href="classApplicationCommandManager.html#a5fea4f129e149062866c0313b29ba976">getKeyMappings</a>()-><a class="code" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140">resetToDefaultMappings</a>();</div><div class="line"></div><div class="line"> <span class="comment">// having set up the default key-mappings, you might now want to load the last set</span></div><div class="line"> <span class="comment">// of mappings that the user configured.</span></div><div class="line"> myCommandManager-><a class="code" href="classApplicationCommandManager.html#a5fea4f129e149062866c0313b29ba976">getKeyMappings</a>()-><a class="code" href="classKeyPressMappingSet.html#acd0da647bbd350e6daebcd8705a8b11e">restoreFromXml</a> (lastSavedKeyMappingsXML);</div><div class="line"></div><div class="line"> <span class="comment">// Now tell our top-level window to send any keypresses that arrive to the</span></div><div class="line"> <span class="comment">// KeyPressMappingSet, which will use them to invoke the appropriate commands.</span></div><div class="line"> addKeyListener (myCommandManager-><a class="code" href="classApplicationCommandManager.html#a5fea4f129e149062866c0313b29ba976">getKeyMappings</a>());</div><div class="line"> }</div><div class="line"></div><div class="line"> ...</div><div class="line">}</div></div><!-- fragment --><p><a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a> derives from <a class="el" href="classChangeBroadcaster.html" title="Holds a list of ChangeListeners, and sends messages to them when instructed. ">ChangeBroadcaster</a> so that interested parties can register to be told when a command or mapping is added, removed, etc.</p>
<p>There's also a UI component called <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a> that can be used to easily edit the key mappings.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classComponent.html#a4ec1b609c39c54434f746cefffa6ce3f" title="Adds a listener that wants to hear about keypresses that this component receives. ...">Component::addKeyListener()</a>, <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a>, <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a809a42cae8d2bfaf754c369f01a03870"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a809a42cae8d2bfaf754c369f01a03870">§ </a></span>KeyPressMappingSet() <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">KeyPressMappingSet::KeyPressMappingSet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApplicationCommandManager.html">ApplicationCommandManager</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a> for a given command manager. </p>
<p>Normally, you won't actually create a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a> directly, because each <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a> contains its own <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a>, so the best thing to do is to create your <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>, and use the <a class="el" href="classApplicationCommandManager.html#a5fea4f129e149062866c0313b29ba976" title="Returns the manager's internal set of key mappings. ">ApplicationCommandManager::getKeyMappings()</a> method to access its mappings.</p>
<p>When a suitable keypress happens, the manager's invoke() method will be used to invoke the appropriate command.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a> </dd></dl>
</div>
</div>
<a id="af094b874c041df2b6ba52855573e2437"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af094b874c041df2b6ba52855573e2437">§ </a></span>KeyPressMappingSet() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyPressMappingSet::KeyPressMappingSet </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKeyPressMappingSet.html">KeyPressMappingSet</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an copy of a <a class="el" href="classKeyPressMappingSet.html" title="Manages and edits a list of keypresses, which it uses to invoke the appropriate command in an Applica...">KeyPressMappingSet</a>. </p>
</div>
</div>
<a id="adae95f518172adb938d30d38cf361743"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adae95f518172adb938d30d38cf361743">§ </a></span>~KeyPressMappingSet()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KeyPressMappingSet::~KeyPressMappingSet </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="ad8c3bf18eddf7d637934cf1c4e271791"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8c3bf18eddf7d637934cf1c4e271791">§ </a></span>getCommandManager()</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="classApplicationCommandManager.html">ApplicationCommandManager</a>& KeyPressMappingSet::getCommandManager </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>References <a class="el" href="classFocusChangeListener.html#aea1c72e9c4d918e41c729d79592fa956">FocusChangeListener::globalFocusChanged()</a>, <a class="el" href="juce__LeakedObjectDetector_8h.html#ab3639a79598b35f2116f4572af0d93f1">JUCE_LEAK_DETECTOR</a>, <a class="el" href="classKeyListener.html#ae69d788cbada2ae5069a9e725db0baf7">KeyListener::keyPressed()</a>, and <a class="el" href="classKeyListener.html#aa3efa1c9c4ebfb754c9d68180a40b6c7">KeyListener::keyStateChanged()</a>.</p>
</div>
</div>
<a id="a9e195f0c065f2cbc7b2c74a41df457fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e195f0c065f2cbc7b2c74a41df457fc">§ </a></span>getKeyPressesAssignedToCommand()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classArray.html">Array</a><<a class="el" href="classKeyPress.html">KeyPress</a>> KeyPressMappingSet::getKeyPressesAssignedToCommand </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of keypresses that are assigned to a particular command. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">commandID</td><td>the command's ID </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac2adbad788cddf223990617e00fbd7f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2adbad788cddf223990617e00fbd7f1">§ </a></span>addKeyPress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::addKeyPress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classKeyPress.html">KeyPress</a> & </td>
<td class="paramname"><em>newKeyPress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>insertIndex</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Assigns a keypress to a command. </p>
<p>If the keypress is already assigned to a different command, it will first be removed from that command, to avoid it triggering multiple functions.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">commandID</td><td>the ID of the command that you want to add a keypress to. If this is 0, the keypress will be removed from anything that it was previously assigned to, but not re-assigned </td></tr>
<tr><td class="paramname">newKeyPress</td><td>the new key-press </td></tr>
<tr><td class="paramname">insertIndex</td><td>if this is less than zero, the key will be appended to the end of the list of keypresses; otherwise the new keypress will be inserted into the existing list at this index </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a11ec4b86290489da987e2fcc3455b140"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11ec4b86290489da987e2fcc3455b140">§ </a></span>resetToDefaultMappings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::resetToDefaultMappings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset all mappings to the defaults, as dictated by the <a class="el" href="classApplicationCommandManager.html" title="One of these objects holds a list of all the commands your app can perform, and despatches these comm...">ApplicationCommandManager</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classKeyPressMappingSet.html#a60fb5f6f71f8d4b9ef04627c625fb5b5" title="Resets all key-mappings to the defaults for a particular command. ">resetToDefaultMapping</a> </dd></dl>
</div>
</div>
<a id="a60fb5f6f71f8d4b9ef04627c625fb5b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60fb5f6f71f8d4b9ef04627c625fb5b5">§ </a></span>resetToDefaultMapping()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::resetToDefaultMapping </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets all key-mappings to the defaults for a particular command. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140" title="Reset all mappings to the defaults, as dictated by the ApplicationCommandManager. ...">resetToDefaultMappings</a> </dd></dl>
</div>
</div>
<a id="a16e2d91480adcd22ee5dbfdce01c0156"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16e2d91480adcd22ee5dbfdce01c0156">§ </a></span>clearAllKeyPresses() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::clearAllKeyPresses </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all keypresses that are assigned to any commands. </p>
</div>
</div>
<a id="a9f3803440dd3d36fd79680c8dc2cc779"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f3803440dd3d36fd79680c8dc2cc779">§ </a></span>clearAllKeyPresses() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::clearAllKeyPresses </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all keypresses that are assigned to a particular command. </p>
</div>
</div>
<a id="a69386f2e687ced9630b24a745b6fa33a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69386f2e687ced9630b24a745b6fa33a">§ </a></span>removeKeyPress() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::removeKeyPress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>keyPressIndex</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes one of the keypresses that are assigned to a command. </p>
<p>See the <a class="el" href="classKeyPressMappingSet.html#a9e195f0c065f2cbc7b2c74a41df457fc" title="Returns a list of keypresses that are assigned to a particular command. ">getKeyPressesAssignedToCommand()</a> for the list of keypresses to which the keyPressIndex refers. </p>
</div>
</div>
<a id="a0626523ca6a55cc5948531f0382e2ad8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0626523ca6a55cc5948531f0382e2ad8">§ </a></span>removeKeyPress() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::removeKeyPress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKeyPress.html">KeyPress</a> & </td>
<td class="paramname"><em>keypress</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes a keypress from any command that it may be assigned to. </p>
</div>
</div>
<a id="a452b1dd8851dd760fb52f97637f387a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a452b1dd8851dd760fb52f97637f387a5">§ </a></span>containsMapping()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool KeyPressMappingSet::containsMapping </td>
<td>(</td>
<td class="paramtype"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> </td>
<td class="paramname"><em>commandID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classKeyPress.html">KeyPress</a> & </td>
<td class="paramname"><em>keyPress</em> </td>
</tr>
<tr>
<td></td>
<td>)</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 command is linked to this key. </p>
</div>
</div>
<a id="a748d3657cb192844b1ff7cfa1044231d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a748d3657cb192844b1ff7cfa1044231d">§ </a></span>findCommandForKeyPress()</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__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> KeyPressMappingSet::findCommandForKeyPress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKeyPress.html">KeyPress</a> & </td>
<td class="paramname"><em>keyPress</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>Looks for a command that corresponds to a keypress. </p>
<dl class="section return"><dt>Returns</dt><dd>the UID of the command or 0 if none was found </dd></dl>
</div>
</div>
<a id="acd0da647bbd350e6daebcd8705a8b11e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd0da647bbd350e6daebcd8705a8b11e">§ </a></span>restoreFromXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KeyPressMappingSet::restoreFromXml </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXmlElement.html">XmlElement</a> & </td>
<td class="paramname"><em>xmlVersion</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to recreate the mappings from a previously stored state. </p>
<p>The XML passed in must have been created by the <a class="el" href="classKeyPressMappingSet.html#af138b81ebe656729ee4b900354d28505" title="Creates an XML representation of the current mappings. ">createXml()</a> method.</p>
<p>If the stored state makes any reference to commands that aren't currently available, these will be ignored.</p>
<p>If the set of mappings being loaded was a set of differences (using createXml (true)), then this will call <a class="el" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140" title="Reset all mappings to the defaults, as dictated by the ApplicationCommandManager. ...">resetToDefaultMappings()</a> and then merge the saved mappings on top. If the saved set was created with createXml (false), then this method will first clear all existing mappings and load the saved ones as a complete set.</p>
<dl class="section return"><dt>Returns</dt><dd>true if it manages to load the XML correctly </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classKeyPressMappingSet.html#af138b81ebe656729ee4b900354d28505" title="Creates an XML representation of the current mappings. ">createXml</a> </dd></dl>
</div>
</div>
<a id="af138b81ebe656729ee4b900354d28505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af138b81ebe656729ee4b900354d28505">§ </a></span>createXml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXmlElement.html">XmlElement</a>* KeyPressMappingSet::createXml </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>saveDifferencesFromDefaultSet</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an XML representation of the current mappings. </p>
<p>This will produce a lump of XML that can be later reloaded using <a class="el" href="classKeyPressMappingSet.html#acd0da647bbd350e6daebcd8705a8b11e" title="Tries to recreate the mappings from a previously stored state. ">restoreFromXml()</a> to recreate the current mapping state.</p>
<p>The object that is returned must be deleted by the caller.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">saveDifferencesFromDefaultSet</td><td>if this is false, then all keypresses will be saved into the XML. If it's true, then the XML will only store the differences between the current mappings and the default mappings you'd get from calling <a class="el" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140" title="Reset all mappings to the defaults, as dictated by the ApplicationCommandManager. ...">resetToDefaultMappings()</a>. The advantage of saving a set of differences from the default is that if you change the default mappings (in a new version of your app, for example), then these will be merged into a user's saved preferences.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classKeyPressMappingSet.html#acd0da647bbd350e6daebcd8705a8b11e" title="Tries to recreate the mappings from a previously stored state. ">restoreFromXml</a> </dd></dl>
</div>
</div>
<a id="ab92a471a8cfc20ad036750cd3c19d5c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab92a471a8cfc20ad036750cd3c19d5c5">§ </a></span>keyPressed()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool KeyPressMappingSet::keyPressed </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classKeyPress.html">KeyPress</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classKeyListener.html#ae69d788cbada2ae5069a9e725db0baf7">KeyListener</a>.</p>
</div>
</div>
<a id="a0329856dd3e6ec50d64114f197045491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0329856dd3e6ec50d64114f197045491">§ </a></span>keyStateChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool KeyPressMappingSet::keyStateChanged </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isKeyDown</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reimplemented from <a class="el" href="classKeyListener.html#aa3efa1c9c4ebfb754c9d68180a40b6c7">KeyListener</a>.</p>
</div>
</div>
<a id="a9a87b7a4ae2b7365723e47e29cf48500"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a87b7a4ae2b7365723e47e29cf48500">§ </a></span>globalFocusChanged()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void KeyPressMappingSet::globalFocusChanged </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classFocusChangeListener.html#aea1c72e9c4d918e41c729d79592fa956">FocusChangeListener</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__KeyPressMappingSet_8h.html">juce_KeyPressMappingSet.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|