Platforms to show: All Mac Windows Linux Cross-Platform
Back to CarbonWindowsEventsMBS class.
CarbonWindowsEventsMBS.Available as boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 2.8 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
(Read only property)
CarbonWindowsEventsMBS.EventCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Increases whenever one of the following events occurs:
MouseUp, MouseMoved, MouseDragged and MouseDown.
(Read and Write property)
CarbonWindowsEventsMBS.Lasterror as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 2.8 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
0 if successfull, -1 if function is not available.
(Read and Write property)
CarbonWindowsEventsMBS.MouseButton as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseDragged, the MouseDown and the MouseUp event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseChord as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseDragged, the MouseDown and the MouseUp event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseClickCount as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseDragged, the MouseDown and the MouseUp event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseDeltaX as Single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseMoved and the MouseDragged event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseDeltaY as Single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseMoved and the MouseDragged event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseModifierKeys as Integer
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseMoved, the MouseDragged, the MouseDown and the MouseUp event.
The modifiers field contains information about the state of the modifier keys and the mouse button at the time the event was posted.
Each of the modifier keys is represented by a specific bit in the modifiers field. You can use these constants as masks to test the setting of various bits in the modifiers field:
activeFlag | 1 | set if window being activated or if mouse-down event caused foreground switch |
btnState | 128 | set if mouse button up |
cmdKey | 256 | set if Command key down |
shiftKey | 512 | set if Shift key down |
alphaLock | 1024 | set if Caps Lock key down |
optionKey | 2048 | set if Option key down |
controlKey | 4096 | set if Control key down |
rightshiftKey | 8192 | set if right Shift key down |
rightoptionKey | 16384 | set if right Option key down |
rightcontrolKey | 32768 | set if right Control key down |
If your application attaches special meaning to any of these keys in combination with other keys or when the mouse button is down, you can test the state of the modifiers field to determine the action your application should take. For example, you can use this information to determine whether the user pressed the Command key and another key to make a menu choice.
Some keyboards do not distinguish between the right or left Control, Shift, and Option keys; for example, the virtual key code for the right Shift key and left Shift key might be the same. For these keyboards, if the user presses the Control, Shift, or Option key, the Event Manager sets only the bits corresponding to the shiftKey, optionKey, and controlKey constants. For keyboards that do distinguish between these keys, the Event Manager sets the bits in the modifiers field to indicate whether the right or left Control, Shift, or Option keys were pressed. For example, the Event Manager sets bit 13 in the modifiers field if the user presses the right Shift key and sets bit 9 if the user presses the left Shift key. In most cases your application should not need to distinguish between the left and right Control, Shift, and Option keys.
(Read and Write property)
CarbonWindowsEventsMBS.MouseX as Single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseMoved, the MouseDragged, the MouseDown and the MouseUp event.
(Read and Write property)
CarbonWindowsEventsMBS.MouseY as Single
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Set by the MouseMoved, the MouseDragged, the MouseDown and the MouseUp event.
(Read and Write property)
CarbonWindowsEventsMBS.Tablet as Boolean
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
As not every application needs tablet event information, this is optional.
Set to true to get the TabletPoint and TabletProximity parameters filled in the events.
Tablet functions may or may not work in Xojo's debug mode (some RB versions work and some not).
(Read and Write property)
CarbonWindowsEventsMBS.TabletPoint as CarbonEventsTabletPointMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Whenever an event is received and the tablet property is true and there is point information available, a reference to the CarbonEventsTabletPointMBS object (from the event) is stored in this property.
So this property enables you to access the current state information of the tablet by just looking on the last state reported.
Tablet functions may or may not work in Xojo's debug mode (some RB versions work and some not).
(Read and Write property)
CarbonWindowsEventsMBS.TabletProximity as CarbonEventsTabletProximityMBS
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
property | Carbon Events | MBS MacCF Plugin | 3.3 | ✅ Yes | ❌ No | ❌ No | ❌ No | Desktop only |
Whenever an event is received and the tablet property is true and there is proximity information available, a reference to the CarbonEventsTabletProximityMBS object (from the event) is stored in this property.
So this property enables you to access the current state information of the tablet by just looking on the last state reported.
Tablet functions may or may not work in Xojo's debug mode (some RB versions work and some not).
(Read and Write property)
The items on this page are in the following plugins: MBS MacCF Plugin.