/usr/share/doc/libjuce/apiref/classPopupMenu.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 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 | <!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: PopupMenu 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="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classPopupMenu-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">PopupMenu Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Creates and displays a popup-menu.
<a href="classPopupMenu.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu_1_1CustomCallback.html">CustomCallback</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A user-defined callback that can be used for specific items in a popup menu. <a href="classPopupMenu_1_1CustomCallback.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu_1_1CustomComponent.html">CustomComponent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A user-defined component that can be used as an item in a popup menu. <a href="classPopupMenu_1_1CustomComponent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPopupMenu_1_1Item.html">Item</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Describes a popup menu item. <a href="structPopupMenu_1_1Item.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structPopupMenu_1_1LookAndFeelMethods.html">LookAndFeelMethods</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This abstract base class is implemented by <a class="el" href="classLookAndFeel.html" title="LookAndFeel objects define the appearance of all the JUCE widgets, and subclasses can be used to appl...">LookAndFeel</a> classes to provide menu drawing functionality. <a href="structPopupMenu_1_1LookAndFeelMethods.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu_1_1MenuItemIterator.html">MenuItemIterator</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Allows you to iterate through the items in a pop-up menu, and examine their properties. <a href="classPopupMenu_1_1MenuItemIterator.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu_1_1Options.html">Options</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Class used to create a set of options to pass to the <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> method. <a href="classPopupMenu_1_1Options.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0888091ddab0f599bb9d2fab28153f6b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6b">ColourIds</a> { <br />
  <a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6baf598840a9e3f2137df45179367323b39">backgroundColourId</a> = 0x1000700,
<a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6ba00636235348246a1bd2bad0cb66f307a">textColourId</a> = 0x1000600,
<a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6ba964cf665c7c5a26b63866e537e9bfed0">headerTextColourId</a> = 0x1000601,
<a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6ba6a9ce95ec115c9def5903d25b5ed2f36">highlightedBackgroundColourId</a> = 0x1000900,
<br />
  <a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6ba1ec81989e7186fa2dff6b57bb057f834">highlightedTextColourId</a> = 0x1000800
<br />
}<tr class="memdesc:a0888091ddab0f599bb9d2fab28153f6b"><td class="mdescLeft"> </td><td class="mdescRight">A set of colour IDs to use to change the colour of various aspects of the menu. <a href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6b">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a0888091ddab0f599bb9d2fab28153f6b"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a75f519bff4ab374bf2e00fe5d93f96f1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a75f519bff4ab374bf2e00fe5d93f96f1">PopupMenu</a> ()</td></tr>
<tr class="memdesc:a75f519bff4ab374bf2e00fe5d93f96f1"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty popup menu. <a href="#a75f519bff4ab374bf2e00fe5d93f96f1">More...</a><br /></td></tr>
<tr class="separator:a75f519bff4ab374bf2e00fe5d93f96f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5b1738cc16508249628b174e6827522"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ac5b1738cc16508249628b174e6827522">PopupMenu</a> (const <a class="el" href="classPopupMenu.html">PopupMenu</a> &other)</td></tr>
<tr class="memdesc:ac5b1738cc16508249628b174e6827522"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another menu. <a href="#ac5b1738cc16508249628b174e6827522">More...</a><br /></td></tr>
<tr class="separator:ac5b1738cc16508249628b174e6827522"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabdf2cc11c5e3cb57049041c459082fd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#aabdf2cc11c5e3cb57049041c459082fd">~PopupMenu</a> ()</td></tr>
<tr class="memdesc:aabdf2cc11c5e3cb57049041c459082fd"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aabdf2cc11c5e3cb57049041c459082fd">More...</a><br /></td></tr>
<tr class="separator:aabdf2cc11c5e3cb57049041c459082fd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89e61dea91a2f6e943cf7e4a2ae09bae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPopupMenu.html">PopupMenu</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a89e61dea91a2f6e943cf7e4a2ae09bae">operator=</a> (const <a class="el" href="classPopupMenu.html">PopupMenu</a> &other)</td></tr>
<tr class="memdesc:a89e61dea91a2f6e943cf7e4a2ae09bae"><td class="mdescLeft"> </td><td class="mdescRight">Copies this menu from another one. <a href="#a89e61dea91a2f6e943cf7e4a2ae09bae">More...</a><br /></td></tr>
<tr class="separator:a89e61dea91a2f6e943cf7e4a2ae09bae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3f9961ffe0080e086ba6b9602533d44"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ad3f9961ffe0080e086ba6b9602533d44">PopupMenu</a> (<a class="el" href="classPopupMenu.html">PopupMenu</a> &&other) noexcept</td></tr>
<tr class="separator:ad3f9961ffe0080e086ba6b9602533d44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab37d3fba08302f30207a4624416b9d1d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classPopupMenu.html">PopupMenu</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ab37d3fba08302f30207a4624416b9d1d">operator=</a> (<a class="el" href="classPopupMenu.html">PopupMenu</a> &&other) noexcept</td></tr>
<tr class="separator:ab37d3fba08302f30207a4624416b9d1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4af03082fd727b395481a64ad940654"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ab4af03082fd727b395481a64ad940654">clear</a> ()</td></tr>
<tr class="memdesc:ab4af03082fd727b395481a64ad940654"><td class="mdescLeft"> </td><td class="mdescRight">Resets the menu, removing all its items. <a href="#ab4af03082fd727b395481a64ad940654">More...</a><br /></td></tr>
<tr class="separator:ab4af03082fd727b395481a64ad940654"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7447231fa198d379fe749a07b0c4511"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (const <a class="el" href="structPopupMenu_1_1Item.html">Item</a> &newItem)</td></tr>
<tr class="memdesc:af7447231fa198d379fe749a07b0c4511"><td class="mdescLeft"> </td><td class="mdescRight">Adds an item to the menu. <a href="#af7447231fa198d379fe749a07b0c4511">More...</a><br /></td></tr>
<tr class="separator:af7447231fa198d379fe749a07b0c4511"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a41753d85a912104ec476fec1a818ec4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a41753d85a912104ec476fec1a818ec4b">addItem</a> (int itemResultID, const <a class="el" href="classString.html">String</a> &itemText, bool isEnabled=true, bool isTicked=false)</td></tr>
<tr class="memdesc:a41753d85a912104ec476fec1a818ec4b"><td class="mdescLeft"> </td><td class="mdescRight">Appends a new text item for this menu to show. <a href="#a41753d85a912104ec476fec1a818ec4b">More...</a><br /></td></tr>
<tr class="separator:a41753d85a912104ec476fec1a818ec4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa76dd642e2a7786ef75d95f425c3bead"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#aa76dd642e2a7786ef75d95f425c3bead">addItem</a> (int itemResultID, const <a class="el" href="classString.html">String</a> &itemText, bool isEnabled, bool isTicked, const <a class="el" href="classImage.html">Image</a> &iconToUse)</td></tr>
<tr class="memdesc:aa76dd642e2a7786ef75d95f425c3bead"><td class="mdescLeft"> </td><td class="mdescRight">Appends a new item with an icon. <a href="#aa76dd642e2a7786ef75d95f425c3bead">More...</a><br /></td></tr>
<tr class="separator:aa76dd642e2a7786ef75d95f425c3bead"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bd542bdf1f7a52639266788f0ddf946"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a0bd542bdf1f7a52639266788f0ddf946">addItem</a> (int itemResultID, const <a class="el" href="classString.html">String</a> &itemText, bool isEnabled, bool isTicked, <a class="el" href="classDrawable.html">Drawable</a> *iconToUse)</td></tr>
<tr class="memdesc:a0bd542bdf1f7a52639266788f0ddf946"><td class="mdescLeft"> </td><td class="mdescRight">Appends a new item with an icon. <a href="#a0bd542bdf1f7a52639266788f0ddf946">More...</a><br /></td></tr>
<tr class="separator:a0bd542bdf1f7a52639266788f0ddf946"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11c9d3dfcb73bf6c281436147901ed0a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a11c9d3dfcb73bf6c281436147901ed0a">addCommandItem</a> (<a class="el" href="classApplicationCommandManager.html">ApplicationCommandManager</a> *commandManager, <a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> commandID, const <a class="el" href="classString.html">String</a> &displayName=<a class="el" href="classString.html">String</a>(), <a class="el" href="classDrawable.html">Drawable</a> *iconToUse=nullptr)</td></tr>
<tr class="memdesc:a11c9d3dfcb73bf6c281436147901ed0a"><td class="mdescLeft"> </td><td class="mdescRight">Adds an item that represents one of the commands in a command manager object. <a href="#a11c9d3dfcb73bf6c281436147901ed0a">More...</a><br /></td></tr>
<tr class="separator:a11c9d3dfcb73bf6c281436147901ed0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46aa85ebfb2f0a7df713dbccc803a90c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a46aa85ebfb2f0a7df713dbccc803a90c">addColouredItem</a> (int itemResultID, const <a class="el" href="classString.html">String</a> &itemText, <a class="el" href="classColour.html">Colour</a> itemTextColour, bool isEnabled=true, bool isTicked=false, const <a class="el" href="classImage.html">Image</a> &iconToUse=<a class="el" href="classImage.html">Image</a>())</td></tr>
<tr class="memdesc:a46aa85ebfb2f0a7df713dbccc803a90c"><td class="mdescLeft"> </td><td class="mdescRight">Appends a text item with a special colour. <a href="#a46aa85ebfb2f0a7df713dbccc803a90c">More...</a><br /></td></tr>
<tr class="separator:a46aa85ebfb2f0a7df713dbccc803a90c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abca9890f63f22575c190c0115a1f3acf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#abca9890f63f22575c190c0115a1f3acf">addColouredItem</a> (int itemResultID, const <a class="el" href="classString.html">String</a> &itemText, <a class="el" href="classColour.html">Colour</a> itemTextColour, bool isEnabled, bool isTicked, <a class="el" href="classDrawable.html">Drawable</a> *iconToUse)</td></tr>
<tr class="memdesc:abca9890f63f22575c190c0115a1f3acf"><td class="mdescLeft"> </td><td class="mdescRight">Appends a text item with a special colour. <a href="#abca9890f63f22575c190c0115a1f3acf">More...</a><br /></td></tr>
<tr class="separator:abca9890f63f22575c190c0115a1f3acf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3420fb5dc0dc01786ffc056892509efd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a3420fb5dc0dc01786ffc056892509efd">addCustomItem</a> (int itemResultID, <a class="el" href="classPopupMenu_1_1CustomComponent.html">CustomComponent</a> *customComponent, const <a class="el" href="classPopupMenu.html">PopupMenu</a> *optionalSubMenu=nullptr)</td></tr>
<tr class="memdesc:a3420fb5dc0dc01786ffc056892509efd"><td class="mdescLeft"> </td><td class="mdescRight">Appends a custom menu item. <a href="#a3420fb5dc0dc01786ffc056892509efd">More...</a><br /></td></tr>
<tr class="separator:a3420fb5dc0dc01786ffc056892509efd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b463a49cd883ab9b5ef3584b66378c3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a5b463a49cd883ab9b5ef3584b66378c3">addCustomItem</a> (int itemResultID, <a class="el" href="classComponent.html">Component</a> *customComponent, int idealWidth, int idealHeight, bool triggerMenuItemAutomaticallyWhenClicked, const <a class="el" href="classPopupMenu.html">PopupMenu</a> *optionalSubMenu=nullptr)</td></tr>
<tr class="memdesc:a5b463a49cd883ab9b5ef3584b66378c3"><td class="mdescLeft"> </td><td class="mdescRight">Appends a custom menu item that can't be used to trigger a result. <a href="#a5b463a49cd883ab9b5ef3584b66378c3">More...</a><br /></td></tr>
<tr class="separator:a5b463a49cd883ab9b5ef3584b66378c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a671c58c6c3b8efb37ccdb5532855500d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a671c58c6c3b8efb37ccdb5532855500d">addSubMenu</a> (const <a class="el" href="classString.html">String</a> &subMenuName, const <a class="el" href="classPopupMenu.html">PopupMenu</a> &subMenu, bool isEnabled=true)</td></tr>
<tr class="memdesc:a671c58c6c3b8efb37ccdb5532855500d"><td class="mdescLeft"> </td><td class="mdescRight">Appends a sub-menu. <a href="#a671c58c6c3b8efb37ccdb5532855500d">More...</a><br /></td></tr>
<tr class="separator:a671c58c6c3b8efb37ccdb5532855500d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00189eb78b4346794f53a80f47643fff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a00189eb78b4346794f53a80f47643fff">addSubMenu</a> (const <a class="el" href="classString.html">String</a> &subMenuName, const <a class="el" href="classPopupMenu.html">PopupMenu</a> &subMenu, bool isEnabled, const <a class="el" href="classImage.html">Image</a> &iconToUse, bool isTicked=false, int itemResultID=0)</td></tr>
<tr class="memdesc:a00189eb78b4346794f53a80f47643fff"><td class="mdescLeft"> </td><td class="mdescRight">Appends a sub-menu with an icon. <a href="#a00189eb78b4346794f53a80f47643fff">More...</a><br /></td></tr>
<tr class="separator:a00189eb78b4346794f53a80f47643fff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0842bfb2cb7404c25effac45e10b1e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#af0842bfb2cb7404c25effac45e10b1e2">addSubMenu</a> (const <a class="el" href="classString.html">String</a> &subMenuName, const <a class="el" href="classPopupMenu.html">PopupMenu</a> &subMenu, bool isEnabled, <a class="el" href="classDrawable.html">Drawable</a> *iconToUse, bool isTicked=false, int itemResultID=0)</td></tr>
<tr class="memdesc:af0842bfb2cb7404c25effac45e10b1e2"><td class="mdescLeft"> </td><td class="mdescRight">Appends a sub-menu with an icon. <a href="#af0842bfb2cb7404c25effac45e10b1e2">More...</a><br /></td></tr>
<tr class="separator:af0842bfb2cb7404c25effac45e10b1e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c411d5c29fe887e4e961a402dd43944"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a9c411d5c29fe887e4e961a402dd43944">addSeparator</a> ()</td></tr>
<tr class="memdesc:a9c411d5c29fe887e4e961a402dd43944"><td class="mdescLeft"> </td><td class="mdescRight">Appends a separator to the menu, to help break it up into sections. <a href="#a9c411d5c29fe887e4e961a402dd43944">More...</a><br /></td></tr>
<tr class="separator:a9c411d5c29fe887e4e961a402dd43944"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab41473f7b9ca9bb4a1e6ad13c5d24ec0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ab41473f7b9ca9bb4a1e6ad13c5d24ec0">addSectionHeader</a> (const <a class="el" href="classString.html">String</a> &title)</td></tr>
<tr class="memdesc:ab41473f7b9ca9bb4a1e6ad13c5d24ec0"><td class="mdescLeft"> </td><td class="mdescRight">Adds a non-clickable text item to the menu. <a href="#ab41473f7b9ca9bb4a1e6ad13c5d24ec0">More...</a><br /></td></tr>
<tr class="separator:ab41473f7b9ca9bb4a1e6ad13c5d24ec0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66988abcfc9795fc7775cd0bb3bd9135"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a66988abcfc9795fc7775cd0bb3bd9135">getNumItems</a> () const noexcept</td></tr>
<tr class="memdesc:a66988abcfc9795fc7775cd0bb3bd9135"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of items that the menu currently contains. <a href="#a66988abcfc9795fc7775cd0bb3bd9135">More...</a><br /></td></tr>
<tr class="separator:a66988abcfc9795fc7775cd0bb3bd9135"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0f6f276fd0d31d02c355a31a74335c9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#aa0f6f276fd0d31d02c355a31a74335c9">containsCommandItem</a> (int commandID) const</td></tr>
<tr class="memdesc:aa0f6f276fd0d31d02c355a31a74335c9"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the menu contains a command item that triggers the given command. <a href="#aa0f6f276fd0d31d02c355a31a74335c9">More...</a><br /></td></tr>
<tr class="separator:aa0f6f276fd0d31d02c355a31a74335c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab6c29dcb038fcc9920db08e3a959b11a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#ab6c29dcb038fcc9920db08e3a959b11a">containsAnyActiveItems</a> () const noexcept</td></tr>
<tr class="memdesc:ab6c29dcb038fcc9920db08e3a959b11a"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the menu contains any items that can be used. <a href="#ab6c29dcb038fcc9920db08e3a959b11a">More...</a><br /></td></tr>
<tr class="separator:ab6c29dcb038fcc9920db08e3a959b11a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acd7bdfe5db59180d929a5dac90bcacce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce">show</a> (int itemIDThatMustBeVisible=0, int minimumWidth=0, int maximumNumColumns=0, int standardItemHeight=0, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:acd7bdfe5db59180d929a5dac90bcacce"><td class="mdescLeft"> </td><td class="mdescRight">Displays the menu and waits for the user to pick something. <a href="#acd7bdfe5db59180d929a5dac90bcacce">More...</a><br /></td></tr>
<tr class="separator:acd7bdfe5db59180d929a5dac90bcacce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acc1d107b2b4dce0ed54333a063f9dfdf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#acc1d107b2b4dce0ed54333a063f9dfdf">showAt</a> (const <a class="el" href="classRectangle.html">Rectangle</a>< int > &screenAreaToAttachTo, int itemIDThatMustBeVisible=0, int minimumWidth=0, int maximumNumColumns=0, int standardItemHeight=0, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:acc1d107b2b4dce0ed54333a063f9dfdf"><td class="mdescLeft"> </td><td class="mdescRight">Displays the menu at a specific location. <a href="#acc1d107b2b4dce0ed54333a063f9dfdf">More...</a><br /></td></tr>
<tr class="separator:acc1d107b2b4dce0ed54333a063f9dfdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09cbf58f5f3e8132ad1eb6afa7819d32"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a09cbf58f5f3e8132ad1eb6afa7819d32">showAt</a> (<a class="el" href="classComponent.html">Component</a> *componentToAttachTo, int itemIDThatMustBeVisible=0, int minimumWidth=0, int maximumNumColumns=0, int standardItemHeight=0, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback=nullptr)</td></tr>
<tr class="memdesc:a09cbf58f5f3e8132ad1eb6afa7819d32"><td class="mdescLeft"> </td><td class="mdescRight">Displays the menu as if it's attached to a component such as a button. <a href="#a09cbf58f5f3e8132ad1eb6afa7819d32">More...</a><br /></td></tr>
<tr class="separator:a09cbf58f5f3e8132ad1eb6afa7819d32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbeb6708a9b79a95c85e70db830cd7d5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#abbeb6708a9b79a95c85e70db830cd7d5">showMenu</a> (const <a class="el" href="classPopupMenu_1_1Options.html">Options</a> &options)</td></tr>
<tr class="memdesc:abbeb6708a9b79a95c85e70db830cd7d5"><td class="mdescLeft"> </td><td class="mdescRight">Displays and runs the menu modally, with a set of options. <a href="#abbeb6708a9b79a95c85e70db830cd7d5">More...</a><br /></td></tr>
<tr class="separator:abbeb6708a9b79a95c85e70db830cd7d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafe397e60357ab6a12ffcc3f896ed4a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#aafe397e60357ab6a12ffcc3f896ed4a7">showMenuAsync</a> (const <a class="el" href="classPopupMenu_1_1Options.html">Options</a> &options, <a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> *callback)</td></tr>
<tr class="memdesc:aafe397e60357ab6a12ffcc3f896ed4a7"><td class="mdescLeft"> </td><td class="mdescRight">Runs the menu asynchronously, with a user-provided callback that will receive the result. <a href="#aafe397e60357ab6a12ffcc3f896ed4a7">More...</a><br /></td></tr>
<tr class="separator:aafe397e60357ab6a12ffcc3f896ed4a7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a449653121fdc2a2b7f3e77d663266d00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a449653121fdc2a2b7f3e77d663266d00">setLookAndFeel</a> (<a class="el" href="classLookAndFeel.html">LookAndFeel</a> *newLookAndFeel)</td></tr>
<tr class="memdesc:a449653121fdc2a2b7f3e77d663266d00"><td class="mdescLeft"> </td><td class="mdescRight">Specifies a look-and-feel for the menu and any sub-menus that it has. <a href="#a449653121fdc2a2b7f3e77d663266d00">More...</a><br /></td></tr>
<tr class="separator:a449653121fdc2a2b7f3e77d663266d00"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a16f1d36e74b8dcf83738b1fcbdbe8166"><td class="memItemLeft" align="right" valign="top">static bool <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classPopupMenu.html#a16f1d36e74b8dcf83738b1fcbdbe8166">dismissAllActiveMenus</a> ()</td></tr>
<tr class="memdesc:a16f1d36e74b8dcf83738b1fcbdbe8166"><td class="mdescLeft"> </td><td class="mdescRight">Closes any menus that are currently open. <a href="#a16f1d36e74b8dcf83738b1fcbdbe8166">More...</a><br /></td></tr>
<tr class="separator:a16f1d36e74b8dcf83738b1fcbdbe8166"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Creates and displays a popup-menu. </p>
<p>To show a popup-menu, you create one of these, add some items to it, then call its <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> method, which returns the id of the item the user selects.</p>
<p>E.g.</p><div class="fragment"><div class="line"><span class="keywordtype">void</span> MyWidget::mouseDown (<span class="keyword">const</span> <a class="code" href="classMouseEvent.html">MouseEvent</a>& e)</div><div class="line">{</div><div class="line"> <a class="code" href="classPopupMenu.html">PopupMenu</a> m;</div><div class="line"> m.<a class="code" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (1, <span class="stringliteral">"item 1"</span>);</div><div class="line"> m.<a class="code" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (2, <span class="stringliteral">"item 2"</span>);</div><div class="line"></div><div class="line"> <span class="keyword">const</span> <span class="keywordtype">int</span> result = m.<a class="code" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce">show</a>();</div><div class="line"></div><div class="line"> <span class="keywordflow">if</span> (result == 0)</div><div class="line"> {</div><div class="line"> <span class="comment">// user dismissed the menu without picking anything</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (result == 1)</div><div class="line"> {</div><div class="line"> <span class="comment">// user picked item 1</span></div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span> <span class="keywordflow">if</span> (result == 2)</div><div class="line"> {</div><div class="line"> <span class="comment">// user picked item 2</span></div><div class="line"> }</div><div class="line">}</div></div><!-- fragment --><p>Submenus are easy too:</p><div class="fragment"><div class="line"><span class="keywordtype">void</span> MyWidget::mouseDown (<span class="keyword">const</span> <a class="code" href="classMouseEvent.html">MouseEvent</a>& e)</div><div class="line">{</div><div class="line"> <a class="code" href="classPopupMenu.html">PopupMenu</a> subMenu;</div><div class="line"> subMenu.<a class="code" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (1, <span class="stringliteral">"item 1"</span>);</div><div class="line"> subMenu.<a class="code" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (2, <span class="stringliteral">"item 2"</span>);</div><div class="line"></div><div class="line"> <a class="code" href="classPopupMenu.html">PopupMenu</a> mainMenu;</div><div class="line"> mainMenu.<a class="code" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511">addItem</a> (3, <span class="stringliteral">"item 3"</span>);</div><div class="line"> mainMenu.<a class="code" href="classPopupMenu.html#a671c58c6c3b8efb37ccdb5532855500d">addSubMenu</a> (<span class="stringliteral">"other choices"</span>, subMenu);</div><div class="line"></div><div class="line"> <span class="keyword">const</span> <span class="keywordtype">int</span> result = m.<a class="code" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce">show</a>();</div><div class="line"></div><div class="line"> ...etc</div><div class="line">}</div></div><!-- fragment --> </div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a0888091ddab0f599bb9d2fab28153f6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0888091ddab0f599bb9d2fab28153f6b">§ </a></span>ColourIds</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classPopupMenu.html#a0888091ddab0f599bb9d2fab28153f6b">PopupMenu::ColourIds</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A set of colour IDs to use to change the colour of various aspects of the menu. </p>
<p>These constants can be used either via the <a class="el" href="classLookAndFeel.html#a167a1e914771f32e433a0d45aaba45e3" title="Registers a colour to be used for a particular purpose. ">LookAndFeel::setColour()</a> method for the look and feel that is set for this menu with <a class="el" href="classPopupMenu.html#a449653121fdc2a2b7f3e77d663266d00" title="Specifies a look-and-feel for the menu and any sub-menus that it has. ">setLookAndFeel()</a></p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#a449653121fdc2a2b7f3e77d663266d00" title="Specifies a look-and-feel for the menu and any sub-menus that it has. ">setLookAndFeel</a>, <a class="el" href="classLookAndFeel.html#a167a1e914771f32e433a0d45aaba45e3" title="Registers a colour to be used for a particular purpose. ">LookAndFeel::setColour</a>, <a class="el" href="classLookAndFeel.html#aa7f9faa480c9ec9d61b66672425f380b" title="Looks for a colour that has been registered with the given colour ID number. ">LookAndFeel::findColour</a> </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0888091ddab0f599bb9d2fab28153f6baf598840a9e3f2137df45179367323b39"></a>backgroundColourId </td><td class="fielddoc"><p>The colour to fill the menu's background with. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0888091ddab0f599bb9d2fab28153f6ba00636235348246a1bd2bad0cb66f307a"></a>textColourId </td><td class="fielddoc"><p>The colour for normal menu item text, (unless the colour is specified when the item is added). </p>
</td></tr>
<tr><td class="fieldname"><a id="a0888091ddab0f599bb9d2fab28153f6ba964cf665c7c5a26b63866e537e9bfed0"></a>headerTextColourId </td><td class="fielddoc"><p>The colour for section header item text (see the <a class="el" href="classPopupMenu.html#ab41473f7b9ca9bb4a1e6ad13c5d24ec0" title="Adds a non-clickable text item to the menu. ">addSectionHeader()</a> method). </p>
</td></tr>
<tr><td class="fieldname"><a id="a0888091ddab0f599bb9d2fab28153f6ba6a9ce95ec115c9def5903d25b5ed2f36"></a>highlightedBackgroundColourId </td><td class="fielddoc"><p>The colour to fill the background of the currently highlighted menu item. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0888091ddab0f599bb9d2fab28153f6ba1ec81989e7186fa2dff6b57bb057f834"></a>highlightedTextColourId </td><td class="fielddoc"><p>The colour to use for the text of the currently highlighted item. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a75f519bff4ab374bf2e00fe5d93f96f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75f519bff4ab374bf2e00fe5d93f96f1">§ </a></span>PopupMenu() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PopupMenu::PopupMenu </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty popup menu. </p>
</div>
</div>
<a id="ac5b1738cc16508249628b174e6827522"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac5b1738cc16508249628b174e6827522">§ </a></span>PopupMenu() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PopupMenu::PopupMenu </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</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 menu. </p>
</div>
</div>
<a id="aabdf2cc11c5e3cb57049041c459082fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabdf2cc11c5e3cb57049041c459082fd">§ </a></span>~PopupMenu()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PopupMenu::~PopupMenu </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<a id="ad3f9961ffe0080e086ba6b9602533d44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3f9961ffe0080e086ba6b9602533d44">§ </a></span>PopupMenu() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">PopupMenu::PopupMenu </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPopupMenu.html">PopupMenu</a> && </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a89e61dea91a2f6e943cf7e4a2ae09bae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89e61dea91a2f6e943cf7e4a2ae09bae">§ </a></span>operator=() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classPopupMenu.html">PopupMenu</a>& PopupMenu::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies this menu from another one. </p>
</div>
</div>
<a id="ab37d3fba08302f30207a4624416b9d1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab37d3fba08302f30207a4624416b9d1d">§ </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"><a class="el" href="classPopupMenu.html">PopupMenu</a>& PopupMenu::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classPopupMenu.html">PopupMenu</a> && </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab4af03082fd727b395481a64ad940654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4af03082fd727b395481a64ad940654">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets the menu, removing all its items. </p>
</div>
</div>
<a id="af7447231fa198d379fe749a07b0c4511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7447231fa198d379fe749a07b0c4511">§ </a></span>addItem() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addItem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structPopupMenu_1_1Item.html">Item</a> & </td>
<td class="paramname"><em>newItem</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an item to the menu. </p>
<p>You can call this method for full control over the item that is added, or use the other addItem helper methods if you want to pass arguments rather than creating an <a class="el" href="structPopupMenu_1_1Item.html" title="Describes a popup menu item. ">Item</a> object. </p>
<p>Referenced by <a class="el" href="classStandaloneFilterWindow.html#a43c03f9f453434a560a44011c9cd357e">StandaloneFilterWindow::buttonClicked()</a>.</p>
</div>
</div>
<a id="a41753d85a912104ec476fec1a818ec4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a41753d85a912104ec476fec1a818ec4b">§ </a></span>addItem() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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>itemText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a new text item for this menu to show. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemResultID</td><td>the number that will be returned from the <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> method if the user picks this item. The value should never be zero, because that's used to indicate that the user didn't select anything. </td></tr>
<tr><td class="paramname">itemText</td><td>the text to show. </td></tr>
<tr><td class="paramname">isEnabled</td><td>if false, the item will be shown 'greyed-out' and can't be picked </td></tr>
<tr><td class="paramname">isTicked</td><td>if true, the item will be shown with a tick next to it</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#a9c411d5c29fe887e4e961a402dd43944" title="Appends a separator to the menu, to help break it up into sections. ">addSeparator</a>, <a class="el" href="classPopupMenu.html#a46aa85ebfb2f0a7df713dbccc803a90c" title="Appends a text item with a special colour. ">addColouredItem</a>, <a class="el" href="classPopupMenu.html#a3420fb5dc0dc01786ffc056892509efd" title="Appends a custom menu item. ">addCustomItem</a>, <a class="el" href="classPopupMenu.html#a671c58c6c3b8efb37ccdb5532855500d" title="Appends a sub-menu. ">addSubMenu</a> </dd></dl>
</div>
</div>
<a id="aa76dd642e2a7786ef75d95f425c3bead"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa76dd642e2a7786ef75d95f425c3bead">§ </a></span>addItem() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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>itemText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>iconToUse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a new item with an icon. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemResultID</td><td>the number that will be returned from the <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> method if the user picks this item. The value should never be zero, because that's used to indicate that the user didn't select anything. </td></tr>
<tr><td class="paramname">itemText</td><td>the text to show. </td></tr>
<tr><td class="paramname">isEnabled</td><td>if false, the item will be shown 'greyed-out' and can't be picked </td></tr>
<tr><td class="paramname">isTicked</td><td>if true, the item will be shown with a tick next to it </td></tr>
<tr><td class="paramname">iconToUse</td><td>if this is a valid image, it will be displayed to the left of the item.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#a9c411d5c29fe887e4e961a402dd43944" title="Appends a separator to the menu, to help break it up into sections. ">addSeparator</a>, <a class="el" href="classPopupMenu.html#a46aa85ebfb2f0a7df713dbccc803a90c" title="Appends a text item with a special colour. ">addColouredItem</a>, <a class="el" href="classPopupMenu.html#a3420fb5dc0dc01786ffc056892509efd" title="Appends a custom menu item. ">addCustomItem</a>, <a class="el" href="classPopupMenu.html#a671c58c6c3b8efb37ccdb5532855500d" title="Appends a sub-menu. ">addSubMenu</a> </dd></dl>
</div>
</div>
<a id="a0bd542bdf1f7a52639266788f0ddf946"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bd542bdf1f7a52639266788f0ddf946">§ </a></span>addItem() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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>itemText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDrawable.html">Drawable</a> * </td>
<td class="paramname"><em>iconToUse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a new item with an icon. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemResultID</td><td>the number that will be returned from the <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> method if the user picks this item. The value should never be zero, because that's used to indicate that the user didn't select anything. </td></tr>
<tr><td class="paramname">itemText</td><td>the text to show. </td></tr>
<tr><td class="paramname">isEnabled</td><td>if false, the item will be shown 'greyed-out' and can't be picked </td></tr>
<tr><td class="paramname">isTicked</td><td>if true, the item will be shown with a tick next to it </td></tr>
<tr><td class="paramname">iconToUse</td><td>a <a class="el" href="classDrawable.html" title="The base class for objects which can draw themselves, e.g. ">Drawable</a> object to use as the icon to the left of the item. The menu will take ownership of this drawable object and will delete it later when no longer needed </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#a9c411d5c29fe887e4e961a402dd43944" title="Appends a separator to the menu, to help break it up into sections. ">addSeparator</a>, <a class="el" href="classPopupMenu.html#a46aa85ebfb2f0a7df713dbccc803a90c" title="Appends a text item with a special colour. ">addColouredItem</a>, <a class="el" href="classPopupMenu.html#a3420fb5dc0dc01786ffc056892509efd" title="Appends a custom menu item. ">addCustomItem</a>, <a class="el" href="classPopupMenu.html#a671c58c6c3b8efb37ccdb5532855500d" title="Appends a sub-menu. ">addSubMenu</a> </dd></dl>
</div>
</div>
<a id="a11c9d3dfcb73bf6c281436147901ed0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11c9d3dfcb73bf6c281436147901ed0a">§ </a></span>addCommandItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addCommandItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classApplicationCommandManager.html">ApplicationCommandManager</a> * </td>
<td class="paramname"><em>commandManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></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="classString.html">String</a> & </td>
<td class="paramname"><em>displayName</em> = <code><a class="el" href="classString.html">String</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDrawable.html">Drawable</a> * </td>
<td class="paramname"><em>iconToUse</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds an item that represents one of the commands in a command manager object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">commandManager</td><td>the manager to use to trigger the command and get information about it </td></tr>
<tr><td class="paramname">commandID</td><td>the ID of the command </td></tr>
<tr><td class="paramname">displayName</td><td>if this is non-empty, then this string will be used instead of the command's registered name </td></tr>
<tr><td class="paramname">iconToUse</td><td>an optional <a class="el" href="classDrawable.html" title="The base class for objects which can draw themselves, e.g. ">Drawable</a> object to use as the icon to the left of the item. The menu will take ownership of this drawable object and will delete it later when no longer needed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a46aa85ebfb2f0a7df713dbccc803a90c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46aa85ebfb2f0a7df713dbccc803a90c">§ </a></span>addColouredItem() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addColouredItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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>itemText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>itemTextColour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>iconToUse</em> = <code><a class="el" href="classImage.html">Image</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a text item with a special colour. </p>
<p>This is the same as <a class="el" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511" title="Adds an item to the menu. ">addItem()</a>, but specifies a colour to use for the text, which will override the default colours that are used by the current look-and-feel. See <a class="el" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511" title="Adds an item to the menu. ">addItem()</a> for a description of the parameters. </p>
</div>
</div>
<a id="abca9890f63f22575c190c0115a1f3acf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abca9890f63f22575c190c0115a1f3acf">§ </a></span>addColouredItem() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addColouredItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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>itemText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classColour.html">Colour</a> </td>
<td class="paramname"><em>itemTextColour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDrawable.html">Drawable</a> * </td>
<td class="paramname"><em>iconToUse</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a text item with a special colour. </p>
<p>This is the same as <a class="el" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511" title="Adds an item to the menu. ">addItem()</a>, but specifies a colour to use for the text, which will override the default colours that are used by the current look-and-feel. See <a class="el" href="classPopupMenu.html#af7447231fa198d379fe749a07b0c4511" title="Adds an item to the menu. ">addItem()</a> for a description of the parameters. </p>
</div>
</div>
<a id="a3420fb5dc0dc01786ffc056892509efd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3420fb5dc0dc01786ffc056892509efd">§ </a></span>addCustomItem() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addCustomItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classPopupMenu_1_1CustomComponent.html">CustomComponent</a> * </td>
<td class="paramname"><em>customComponent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> * </td>
<td class="paramname"><em>optionalSubMenu</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a custom menu item. </p>
<p>This will add a user-defined component to use as a menu item. The component passed in will be deleted by this menu when it's no longer needed.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu_1_1CustomComponent.html" title="A user-defined component that can be used as an item in a popup menu. ">CustomComponent</a> </dd></dl>
</div>
</div>
<a id="a5b463a49cd883ab9b5ef3584b66378c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b463a49cd883ab9b5ef3584b66378c3">§ </a></span>addCustomItem() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addCustomItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</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"><em>customComponent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>idealWidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>idealHeight</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>triggerMenuItemAutomaticallyWhenClicked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> * </td>
<td class="paramname"><em>optionalSubMenu</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a custom menu item that can't be used to trigger a result. </p>
<p>This will add a user-defined component to use as a menu item. It's the caller's responsibility to delete the component that is passed-in when it's no longer needed after the menu has been hidden.</p>
<p>If triggerMenuItemAutomaticallyWhenClicked is true, the menu itself will handle detection of a mouse-click on your component, and use that to trigger the menu ID specified in itemResultID. If this is false, the menu item can't be triggered, so itemResultID is not used. </p>
</div>
</div>
<a id="a671c58c6c3b8efb37ccdb5532855500d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a671c58c6c3b8efb37ccdb5532855500d">§ </a></span>addSubMenu() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addSubMenu </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>subMenuName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> & </td>
<td class="paramname"><em>subMenu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a sub-menu. </p>
<p>If the menu that's passed in is empty, it will appear as an inactive item. If the itemResultID argument is non-zero, then the sub-menu item itself can be clicked to trigger it as a command. </p>
</div>
</div>
<a id="a00189eb78b4346794f53a80f47643fff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00189eb78b4346794f53a80f47643fff">§ </a></span>addSubMenu() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addSubMenu </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>subMenuName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> & </td>
<td class="paramname"><em>subMenu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classImage.html">Image</a> & </td>
<td class="paramname"><em>iconToUse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a sub-menu with an icon. </p>
<p>If the menu that's passed in is empty, it will appear as an inactive item. If the itemResultID argument is non-zero, then the sub-menu item itself can be clicked to trigger it as a command. </p>
</div>
</div>
<a id="af0842bfb2cb7404c25effac45e10b1e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af0842bfb2cb7404c25effac45e10b1e2">§ </a></span>addSubMenu() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addSubMenu </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>subMenuName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classPopupMenu.html">PopupMenu</a> & </td>
<td class="paramname"><em>subMenu</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isEnabled</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classDrawable.html">Drawable</a> * </td>
<td class="paramname"><em>iconToUse</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em> = <code>false</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemResultID</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a sub-menu with an icon. </p>
<p>If the menu that's passed in is empty, it will appear as an inactive item. If the itemResultID argument is non-zero, then the sub-menu item itself can be clicked to trigger it as a command.</p>
<p>The iconToUse parameter is a <a class="el" href="classDrawable.html" title="The base class for objects which can draw themselves, e.g. ">Drawable</a> object to use as the icon to the left of the item. The menu will take ownership of this drawable object and will delete it later when no longer needed </p>
</div>
</div>
<a id="a9c411d5c29fe887e4e961a402dd43944"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c411d5c29fe887e4e961a402dd43944">§ </a></span>addSeparator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addSeparator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends a separator to the menu, to help break it up into sections. </p>
<p>The menu class is smart enough not to display separators at the top or bottom of the menu, and it will replace mutliple adjacent separators with a single one, so your code can be quite free and easy about adding these, and it'll always look ok. </p>
<p>Referenced by <a class="el" href="classStandaloneFilterWindow.html#a43c03f9f453434a560a44011c9cd357e">StandaloneFilterWindow::buttonClicked()</a>.</p>
</div>
</div>
<a id="ab41473f7b9ca9bb4a1e6ad13c5d24ec0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab41473f7b9ca9bb4a1e6ad13c5d24ec0">§ </a></span>addSectionHeader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::addSectionHeader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>title</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a non-clickable text item to the menu. </p>
<p>This is a bold-font items which can be used as a header to separate the items into named groups. </p>
</div>
</div>
<a id="a66988abcfc9795fc7775cd0bb3bd9135"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66988abcfc9795fc7775cd0bb3bd9135">§ </a></span>getNumItems()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int PopupMenu::getNumItems </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 items that the menu currently contains. </p>
<p>(This doesn't count separators). </p>
</div>
</div>
<a id="aa0f6f276fd0d31d02c355a31a74335c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0f6f276fd0d31d02c355a31a74335c9">§ </a></span>containsCommandItem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool PopupMenu::containsCommandItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>commandID</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the menu contains a command item that triggers the given command. </p>
</div>
</div>
<a id="ab6c29dcb038fcc9920db08e3a959b11a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab6c29dcb038fcc9920db08e3a959b11a">§ </a></span>containsAnyActiveItems()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PopupMenu::containsAnyActiveItems </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 menu contains any items that can be used. </p>
</div>
</div>
<a id="acd7bdfe5db59180d929a5dac90bcacce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd7bdfe5db59180d929a5dac90bcacce">§ </a></span>show()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PopupMenu::show </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemIDThatMustBeVisible</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minimumWidth</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maximumNumColumns</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>standardItemHeight</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Displays the menu and waits for the user to pick something. </p>
<p>This will display the menu modally, and return the ID of the item that the user picks. If they click somewhere off the menu to get rid of it without choosing anything, this will return 0.</p>
<p>The current location of the mouse will be used as the position to show the menu - to explicitly set the menu's position, use <a class="el" href="classPopupMenu.html#acc1d107b2b4dce0ed54333a063f9dfdf" title="Displays the menu at a specific location. ">showAt()</a> instead. Depending on where this point is on the screen, the menu will appear above, below or to the side of the point.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">itemIDThatMustBeVisible</td><td>if you set this to the ID of one of the menu items, then when the menu first appears, it will make sure that this item is visible. So if the menu has too many items to fit on the screen, it will be scrolled to a position where this item is visible. </td></tr>
<tr><td class="paramname">minimumWidth</td><td>a minimum width for the menu, in pixels. It may be wider than this if some items are too long to fit. </td></tr>
<tr><td class="paramname">maximumNumColumns</td><td>if there are too many items to fit on-screen in a single vertical column, the menu may be laid out as a series of columns - this is the maximum number allowed. To use the default value for this (probably about 7), you can pass in zero. </td></tr>
<tr><td class="paramname">standardItemHeight</td><td>if this is non-zero, it will be used as the standard height for menu items (apart from custom items) </td></tr>
<tr><td class="paramname">callback</td><td>if this is not a nullptr, the menu will be launched asynchronously, returning immediately, and the callback will receive a call when the menu is either dismissed or has an item selected. This object will be owned and deleted by the system, so make sure that it works safely and that any pointers that it uses are safely within scope. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#acc1d107b2b4dce0ed54333a063f9dfdf" title="Displays the menu at a specific location. ">showAt</a> </dd></dl>
</div>
</div>
<a id="acc1d107b2b4dce0ed54333a063f9dfdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc1d107b2b4dce0ed54333a063f9dfdf">§ </a></span>showAt() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PopupMenu::showAt </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>screenAreaToAttachTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemIDThatMustBeVisible</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minimumWidth</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maximumNumColumns</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>standardItemHeight</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Displays the menu at a specific location. </p>
<p>This is the same as <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a>, but uses a specific location (in global screen coordinates) rather than the current mouse position.</p>
<p>The screenAreaToAttachTo parameter indicates a screen area to which the menu will be adjacent. Depending on where this is, the menu will decide which edge to attach itself to, in order to fit itself fully on-screen. If you just want to trigger a menu at a specific point, you can pass in a rectangle of size (0, 0) with the position that you want.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> </dd></dl>
</div>
</div>
<a id="a09cbf58f5f3e8132ad1eb6afa7819d32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09cbf58f5f3e8132ad1eb6afa7819d32">§ </a></span>showAt() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PopupMenu::showAt </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classComponent.html">Component</a> * </td>
<td class="paramname"><em>componentToAttachTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>itemIDThatMustBeVisible</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>minimumWidth</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>maximumNumColumns</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>standardItemHeight</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> = <code>nullptr</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Displays the menu as if it's attached to a component such as a button. </p>
<p>This is similar to <a class="el" href="classPopupMenu.html#acc1d107b2b4dce0ed54333a063f9dfdf" title="Displays the menu at a specific location. ">showAt()</a>, but will position it next to the given component, e.g. so that the menu's edge is aligned with that of the component. This is intended for things like buttons that trigger a pop-up menu. </p>
</div>
</div>
<a id="abbeb6708a9b79a95c85e70db830cd7d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbeb6708a9b79a95c85e70db830cd7d5">§ </a></span>showMenu()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int PopupMenu::showMenu </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPopupMenu_1_1Options.html">Options</a> & </td>
<td class="paramname"><em>options</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Displays and runs the menu modally, with a set of options. </p>
</div>
</div>
<a id="aafe397e60357ab6a12ffcc3f896ed4a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafe397e60357ab6a12ffcc3f896ed4a7">§ </a></span>showMenuAsync()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::showMenuAsync </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classPopupMenu_1_1Options.html">Options</a> & </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModalComponentManager_1_1Callback.html">ModalComponentManager::Callback</a> * </td>
<td class="paramname"><em>callback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Runs the menu asynchronously, with a user-provided callback that will receive the result. </p>
<p>Referenced by <a class="el" href="classStandaloneFilterWindow.html#a43c03f9f453434a560a44011c9cd357e">StandaloneFilterWindow::buttonClicked()</a>.</p>
</div>
</div>
<a id="a16f1d36e74b8dcf83738b1fcbdbe8166"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f1d36e74b8dcf83738b1fcbdbe8166">§ </a></span>dismissAllActiveMenus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool <a class="el" href="juce__PlatformDefs_8h.html#af0b3f78ca801d88a7912f4c6bbf50e58">JUCE_CALLTYPE</a> PopupMenu::dismissAllActiveMenus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes any menus that are currently open. </p>
<p>This might be useful if you have a situation where your window is being closed by some means other than a user action, and you'd like to make sure that menus aren't left hanging around. </p>
</div>
</div>
<a id="a449653121fdc2a2b7f3e77d663266d00"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a449653121fdc2a2b7f3e77d663266d00">§ </a></span>setLookAndFeel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PopupMenu::setLookAndFeel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLookAndFeel.html">LookAndFeel</a> * </td>
<td class="paramname"><em>newLookAndFeel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Specifies a look-and-feel for the menu and any sub-menus that it has. </p>
<p>This can be called before <a class="el" href="classPopupMenu.html#acd7bdfe5db59180d929a5dac90bcacce" title="Displays the menu and waits for the user to pick something. ">show()</a> if you need a customised menu. Be careful not to delete the <a class="el" href="classLookAndFeel.html" title="LookAndFeel objects define the appearance of all the JUCE widgets, and subclasses can be used to appl...">LookAndFeel</a> object before the menu has been deleted. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__PopupMenu_8h.html">juce_PopupMenu.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|