/usr/share/doc/libjuce/apiref/structApplicationCommandInfo.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 | <!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: ApplicationCommandInfo Struct 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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structApplicationCommandInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ApplicationCommandInfo Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds information describing an application command.
<a href="structApplicationCommandInfo.html#details">More...</a></p>
<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:ab9633f0a25ad57236fde726c98b29d72"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72">CommandFlags</a> { <br />
  <a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72a202cb5c15583e30f2f59b48e6c18c90b">isDisabled</a> = 1 << 0,
<a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72af0c8f1c0103edb7a8e9ea852d3d3dee2">isTicked</a> = 1 << 1,
<a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72ab8ea56bbed1d23f3df3cbd3c20f2a8d1">wantsKeyUpDownCallbacks</a> = 1 << 2,
<a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72a626b4f9f1aa2bd0761b89b376063d254">hiddenFromKeyEditor</a> = 1 << 3,
<br />
  <a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72a57e236658a383bd74c76fadfe6c49370">readOnlyInKeyEditor</a> = 1 << 4,
<a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72a362e5c4decffcd4c7ec6f508f672e443">dontTriggerVisualFeedback</a> = 1 << 5
<br />
}<tr class="memdesc:ab9633f0a25ad57236fde726c98b29d72"><td class="mdescLeft"> </td><td class="mdescRight">Flags describing the ways in which this command should be used. <a href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ab9633f0a25ad57236fde726c98b29d72"><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:a79d1e190c9157fa3bb96f8981858ca8c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a79d1e190c9157fa3bb96f8981858ca8c">ApplicationCommandInfo</a> (<a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> <a class="el" href="structApplicationCommandInfo.html#ac8265d08896874e8aad4f9bfee9e7e03">commandID</a>) noexcept</td></tr>
<tr class="separator:a79d1e190c9157fa3bb96f8981858ca8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e9cd7e72fbf617a0d70d6be3d513b82"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a3e9cd7e72fbf617a0d70d6be3d513b82">setInfo</a> (const <a class="el" href="classString.html">String</a> &<a class="el" href="structApplicationCommandInfo.html#a2da18de634cf7794fcd0b26e4121e3ec">shortName</a>, const <a class="el" href="classString.html">String</a> &<a class="el" href="structApplicationCommandInfo.html#a9d36981d292001925176c0be0d2e6b3a">description</a>, const <a class="el" href="classString.html">String</a> &<a class="el" href="structApplicationCommandInfo.html#a38af85def791bf7f344d18ddb6f65f66">categoryName</a>, int <a class="el" href="structApplicationCommandInfo.html#a45fa351a09f7a6df3e76fe466c476905">flags</a>) noexcept</td></tr>
<tr class="memdesc:a3e9cd7e72fbf617a0d70d6be3d513b82"><td class="mdescLeft"> </td><td class="mdescRight">Sets a number of the structures values at once. <a href="#a3e9cd7e72fbf617a0d70d6be3d513b82">More...</a><br /></td></tr>
<tr class="separator:a3e9cd7e72fbf617a0d70d6be3d513b82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68a043a95e058beeeddfba2441ee7306"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a68a043a95e058beeeddfba2441ee7306">setActive</a> (bool isActive) noexcept</td></tr>
<tr class="memdesc:a68a043a95e058beeeddfba2441ee7306"><td class="mdescLeft"> </td><td class="mdescRight">An easy way to set or remove the isDisabled bit in the structure's flags field. <a href="#a68a043a95e058beeeddfba2441ee7306">More...</a><br /></td></tr>
<tr class="separator:a68a043a95e058beeeddfba2441ee7306"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aac92e704735d8013bf8b17450858f3fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#aac92e704735d8013bf8b17450858f3fb">setTicked</a> (bool <a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72af0c8f1c0103edb7a8e9ea852d3d3dee2">isTicked</a>) noexcept</td></tr>
<tr class="memdesc:aac92e704735d8013bf8b17450858f3fb"><td class="mdescLeft"> </td><td class="mdescRight">An easy way to set or remove the isTicked bit in the structure's flags field. <a href="#aac92e704735d8013bf8b17450858f3fb">More...</a><br /></td></tr>
<tr class="separator:aac92e704735d8013bf8b17450858f3fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46d8d91bd1e2ca8aa37b1d51f7aac914"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a46d8d91bd1e2ca8aa37b1d51f7aac914">addDefaultKeypress</a> (int keyCode, <a class="el" href="classModifierKeys.html">ModifierKeys</a> modifiers) noexcept</td></tr>
<tr class="memdesc:a46d8d91bd1e2ca8aa37b1d51f7aac914"><td class="mdescLeft"> </td><td class="mdescRight">Handy method for adding a keypress to the defaultKeypresses array. <a href="#a46d8d91bd1e2ca8aa37b1d51f7aac914">More...</a><br /></td></tr>
<tr class="separator:a46d8d91bd1e2ca8aa37b1d51f7aac914"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:ac8265d08896874e8aad4f9bfee9e7e03"><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="structApplicationCommandInfo.html#ac8265d08896874e8aad4f9bfee9e7e03">commandID</a></td></tr>
<tr class="memdesc:ac8265d08896874e8aad4f9bfee9e7e03"><td class="mdescLeft"> </td><td class="mdescRight">The command's unique ID number. <a href="#ac8265d08896874e8aad4f9bfee9e7e03">More...</a><br /></td></tr>
<tr class="separator:ac8265d08896874e8aad4f9bfee9e7e03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2da18de634cf7794fcd0b26e4121e3ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a2da18de634cf7794fcd0b26e4121e3ec">shortName</a></td></tr>
<tr class="memdesc:a2da18de634cf7794fcd0b26e4121e3ec"><td class="mdescLeft"> </td><td class="mdescRight">A short name to describe the command. <a href="#a2da18de634cf7794fcd0b26e4121e3ec">More...</a><br /></td></tr>
<tr class="separator:a2da18de634cf7794fcd0b26e4121e3ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9d36981d292001925176c0be0d2e6b3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a9d36981d292001925176c0be0d2e6b3a">description</a></td></tr>
<tr class="memdesc:a9d36981d292001925176c0be0d2e6b3a"><td class="mdescLeft"> </td><td class="mdescRight">A longer description of the command. <a href="#a9d36981d292001925176c0be0d2e6b3a">More...</a><br /></td></tr>
<tr class="separator:a9d36981d292001925176c0be0d2e6b3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a38af85def791bf7f344d18ddb6f65f66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a38af85def791bf7f344d18ddb6f65f66">categoryName</a></td></tr>
<tr class="memdesc:a38af85def791bf7f344d18ddb6f65f66"><td class="mdescLeft"> </td><td class="mdescRight">A named category that the command fits into. <a href="#a38af85def791bf7f344d18ddb6f65f66">More...</a><br /></td></tr>
<tr class="separator:a38af85def791bf7f344d18ddb6f65f66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acae1903bdfd8214162adb8326d1ee9da"><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="structApplicationCommandInfo.html#acae1903bdfd8214162adb8326d1ee9da">defaultKeypresses</a></td></tr>
<tr class="memdesc:acae1903bdfd8214162adb8326d1ee9da"><td class="mdescLeft"> </td><td class="mdescRight">A list of zero or more keypresses that should be used as the default keys for this command. <a href="#acae1903bdfd8214162adb8326d1ee9da">More...</a><br /></td></tr>
<tr class="separator:acae1903bdfd8214162adb8326d1ee9da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45fa351a09f7a6df3e76fe466c476905"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structApplicationCommandInfo.html#a45fa351a09f7a6df3e76fe466c476905">flags</a></td></tr>
<tr class="memdesc:a45fa351a09f7a6df3e76fe466c476905"><td class="mdescLeft"> </td><td class="mdescRight">A bitwise-OR of the values specified in the CommandFlags enum. <a href="#a45fa351a09f7a6df3e76fe466c476905">More...</a><br /></td></tr>
<tr class="separator:a45fa351a09f7a6df3e76fe466c476905"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds information describing an application command. </p>
<p>This object is used to pass information about a particular command, such as its name, description and other usage flags.</p>
<p>When an <a class="el" href="classApplicationCommandTarget.html" title="A command target publishes a list of command IDs that it can perform. ">ApplicationCommandTarget</a> is asked to provide information about the commands it can perform, this is the structure gets filled-in to describe each one.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classApplicationCommandTarget.html" title="A command target publishes a list of command IDs that it can perform. ">ApplicationCommandTarget</a>, <a class="el" href="classApplicationCommandTarget.html#a54171f3ee599f0b508fed08e647edf89" title="This must provide details about one of the commands that this target can perform. ...">ApplicationCommandTarget::getCommandInfo()</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">Member Enumeration Documentation</h2>
<a id="ab9633f0a25ad57236fde726c98b29d72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9633f0a25ad57236fde726c98b29d72">§ </a></span>CommandFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="structApplicationCommandInfo.html#ab9633f0a25ad57236fde726c98b29d72">ApplicationCommandInfo::CommandFlags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags describing the ways in which this command should be used. </p>
<p>A bitwise-OR of these values is stored in the <a class="el" href="structApplicationCommandInfo.html#a45fa351a09f7a6df3e76fe466c476905" title="A bitwise-OR of the values specified in the CommandFlags enum. ">ApplicationCommandInfo::flags</a> variable. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72a202cb5c15583e30f2f59b48e6c18c90b"></a>isDisabled </td><td class="fielddoc"><p>Indicates that the command can't currently be performed. </p>
<p>The <a class="el" href="classApplicationCommandTarget.html#a54171f3ee599f0b508fed08e647edf89" title="This must provide details about one of the commands that this target can perform. ...">ApplicationCommandTarget::getCommandInfo()</a> method must set this flag if it's not currently permissible to perform the command. If the flag is set, then components that trigger the command, e.g. <a class="el" href="classPopupMenu.html" title="Creates and displays a popup-menu. ">PopupMenu</a>, may choose to grey-out the command or show themselves as not being enabled.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structApplicationCommandInfo.html#a68a043a95e058beeeddfba2441ee7306" title="An easy way to set or remove the isDisabled bit in the structure's flags field. ">ApplicationCommandInfo::setActive</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72af0c8f1c0103edb7a8e9ea852d3d3dee2"></a>isTicked </td><td class="fielddoc"><p>Indicates that the command should have a tick next to it on a menu. </p>
<p>If your command is shown on a menu and this is set, it'll show a tick next to it. Other components such as buttons may also use this flag to indicate that it is a value that can be toggled, and is currently in the 'on' state.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structApplicationCommandInfo.html#aac92e704735d8013bf8b17450858f3fb" title="An easy way to set or remove the isTicked bit in the structure's flags field. ">ApplicationCommandInfo::setTicked</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72ab8ea56bbed1d23f3df3cbd3c20f2a8d1"></a>wantsKeyUpDownCallbacks </td><td class="fielddoc"><p>If this flag is present, then when 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> invokes the command, it will call the command twice, once on key-down and again on key-up. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structApplicationCommandTarget_1_1InvocationInfo.html" title="Contains contextual details about the invocation of a command. ">ApplicationCommandTarget::InvocationInfo</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72a626b4f9f1aa2bd0761b89b376063d254"></a>hiddenFromKeyEditor </td><td class="fielddoc"><p>If this flag is present, then a <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a> will not display the command in its list. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72a57e236658a383bd74c76fadfe6c49370"></a>readOnlyInKeyEditor </td><td class="fielddoc"><p>If this flag is present, then a <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a> will display the command in its list, but won't allow the assigned keypress to be changed. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab9633f0a25ad57236fde726c98b29d72a362e5c4decffcd4c7ec6f508f672e443"></a>dontTriggerVisualFeedback </td><td class="fielddoc"><p>If this flag is present and the command is invoked from a keypress, then any buttons or menus that are also connected to the command will not flash to indicate that they've been triggered. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a79d1e190c9157fa3bb96f8981858ca8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79d1e190c9157fa3bb96f8981858ca8c">§ </a></span>ApplicationCommandInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ApplicationCommandInfo::ApplicationCommandInfo </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>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3e9cd7e72fbf617a0d70d6be3d513b82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e9cd7e72fbf617a0d70d6be3d513b82">§ </a></span>setInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ApplicationCommandInfo::setInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>shortName</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>description</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>categoryName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a number of the structures values at once. </p>
<p>The meanings of each of the parameters is described below, in the appropriate member variable's description. </p>
</div>
</div>
<a id="a68a043a95e058beeeddfba2441ee7306"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68a043a95e058beeeddfba2441ee7306">§ </a></span>setActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ApplicationCommandInfo::setActive </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isActive</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An easy way to set or remove the isDisabled bit in the structure's flags field. </p>
<p>If isActive is true, the flags member has the isDisabled bit cleared; if isActive is false, the bit is set. </p>
</div>
</div>
<a id="aac92e704735d8013bf8b17450858f3fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac92e704735d8013bf8b17450858f3fb">§ </a></span>setTicked()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ApplicationCommandInfo::setTicked </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isTicked</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>An easy way to set or remove the isTicked bit in the structure's flags field. </p>
</div>
</div>
<a id="a46d8d91bd1e2ca8aa37b1d51f7aac914"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46d8d91bd1e2ca8aa37b1d51f7aac914">§ </a></span>addDefaultKeypress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ApplicationCommandInfo::addDefaultKeypress </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>keyCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classModifierKeys.html">ModifierKeys</a> </td>
<td class="paramname"><em>modifiers</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Handy method for adding a keypress to the defaultKeypresses array. </p>
<p>This is just so you can write things like: </p><div class="fragment"><div class="line">myinfo.addDefaultKeypress (<span class="charliteral">'s'</span>, <a class="code" href="classModifierKeys.html#acdd2a85defa6a705d74e1a63d193678ba5e28f0dd247a86d9a21bdcabd644d058">ModifierKeys::commandModifier</a>);</div></div><!-- fragment --><p> instead of </p><div class="fragment"><div class="line">myinfo.defaultKeypresses.add (<a class="code" href="classKeyPress.html">KeyPress</a> (<span class="charliteral">'s'</span>, <a class="code" href="classModifierKeys.html#acdd2a85defa6a705d74e1a63d193678ba5e28f0dd247a86d9a21bdcabd644d058">ModifierKeys::commandModifier</a>));</div></div><!-- fragment -->
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ac8265d08896874e8aad4f9bfee9e7e03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8265d08896874e8aad4f9bfee9e7e03">§ </a></span>commandID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="juce__ApplicationCommandID_8h.html#afd69b5d28aad07b587b693925e09308b">CommandID</a> ApplicationCommandInfo::commandID</td>
</tr>
</table>
</div><div class="memdoc">
<p>The command's unique ID number. </p>
</div>
</div>
<a id="a2da18de634cf7794fcd0b26e4121e3ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2da18de634cf7794fcd0b26e4121e3ec">§ </a></span>shortName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> ApplicationCommandInfo::shortName</td>
</tr>
</table>
</div><div class="memdoc">
<p>A short name to describe the command. </p>
<p>This should be suitable for use in menus, on buttons that trigger the command, etc.</p>
<p>You can use the <a class="el" href="structApplicationCommandInfo.html#a3e9cd7e72fbf617a0d70d6be3d513b82" title="Sets a number of the structures values at once. ">setInfo()</a> method to quickly set this and some of the command's other properties. </p>
</div>
</div>
<a id="a9d36981d292001925176c0be0d2e6b3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d36981d292001925176c0be0d2e6b3a">§ </a></span>description</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> ApplicationCommandInfo::description</td>
</tr>
</table>
</div><div class="memdoc">
<p>A longer description of the command. </p>
<p>This should be suitable for use in contexts such as a <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a> or pop-up tooltip describing what the command does.</p>
<p>You can use the <a class="el" href="structApplicationCommandInfo.html#a3e9cd7e72fbf617a0d70d6be3d513b82" title="Sets a number of the structures values at once. ">setInfo()</a> method to quickly set this and some of the command's other properties. </p>
</div>
</div>
<a id="a38af85def791bf7f344d18ddb6f65f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38af85def791bf7f344d18ddb6f65f66">§ </a></span>categoryName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> ApplicationCommandInfo::categoryName</td>
</tr>
</table>
</div><div class="memdoc">
<p>A named category that the command fits into. </p>
<p>You can give your commands any category you like, and these will be displayed in contexts such as the <a class="el" href="classKeyMappingEditorComponent.html" title="A component to allow editing of the keymaps stored by a KeyPressMappingSet object. ">KeyMappingEditorComponent</a>, where the category is used to group commands together.</p>
<p>You can use the <a class="el" href="structApplicationCommandInfo.html#a3e9cd7e72fbf617a0d70d6be3d513b82" title="Sets a number of the structures values at once. ">setInfo()</a> method to quickly set this and some of the command's other properties. </p>
</div>
</div>
<a id="acae1903bdfd8214162adb8326d1ee9da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acae1903bdfd8214162adb8326d1ee9da">§ </a></span>defaultKeypresses</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>> ApplicationCommandInfo::defaultKeypresses</td>
</tr>
</table>
</div><div class="memdoc">
<p>A list of zero or more keypresses that should be used as the default keys for this command. </p>
<p>Methods such as <a class="el" href="classKeyPressMappingSet.html#a11ec4b86290489da987e2fcc3455b140" title="Reset all mappings to the defaults, as dictated by the ApplicationCommandManager. ...">KeyPressMappingSet::resetToDefaultMappings()</a> will use the keypresses in this list to initialise the default set of key-to-command mappings.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structApplicationCommandInfo.html#a46d8d91bd1e2ca8aa37b1d51f7aac914" title="Handy method for adding a keypress to the defaultKeypresses array. ">addDefaultKeypress</a> </dd></dl>
</div>
</div>
<a id="a45fa351a09f7a6df3e76fe466c476905"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45fa351a09f7a6df3e76fe466c476905">§ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ApplicationCommandInfo::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>A bitwise-OR of the values specified in the CommandFlags enum. </p>
<p>You can use the <a class="el" href="structApplicationCommandInfo.html#a3e9cd7e72fbf617a0d70d6be3d513b82" title="Sets a number of the structures values at once. ">setInfo()</a> method to quickly set this and some of the command's other properties. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="juce__ApplicationCommandInfo_8h.html">juce_ApplicationCommandInfo.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|