Public Types | |
| enum | InvocationMethod { direct = 0, fromKeyPress, fromMenu, fromButton } |
The types of context in which the command might be called. More... | |
Public Member Functions | |
| InvocationInfo (const CommandID commandID) | |
Public Attributes | |
| CommandID | commandID |
| The UID of the command that should be performed. | |
| int | commandFlags |
| The command's flags. | |
| InvocationMethod | invocationMethod |
| The type of event that triggered this command. | |
| Component * | originatingComponent |
| If triggered by a keypress or menu, this will be the component that had the keyboard focus at the time. | |
| KeyPress | keyPress |
| The keypress that was used to invoke it. | |
| bool | isKeyDown |
| True if the callback is being invoked when the key is pressed, false if the key is being released. | |
| int | millisecsSinceKeyPressed |
| If the key is being released, this indicates how long it had been held down for. | |
The types of context in which the command might be called.
| ApplicationCommandTarget::InvocationInfo::InvocationInfo | ( | const CommandID | commandID ) |
The UID of the command that should be performed.
The command's flags.
See ApplicationCommandInfo for a description of these flag values.
The type of event that triggered this command.
If triggered by a keypress or menu, this will be the component that had the keyboard focus at the time.
If triggered by a button, it may be set to that component, or it may be null.
The keypress that was used to invoke it.
Note that this will be an invalid keypress if the command was invoked by some other means than a keyboard shortcut.
True if the callback is being invoked when the key is pressed, false if the key is being released.
If the key is being released, this indicates how long it had been held down for.
(Only relevant if isKeyDown is false.)
