Xojo Conferences
XDCMay2019MiamiUSA

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

NSEventMBS.absoluteX as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 8.7 Yes No No Yes, macOS only No
Function: Reports the absolute x coordinate of a pointing device on its tablet at full tablet resolution.
Notes:
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint. Use this value if you want to scale from tablet location to screen location yourself; otherwise use the class method mouseLocation or the instance method locationInWindow.

Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.absoluteY as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 8.7 Yes No No Yes, macOS only No
Function: Reports the absolute y coordinate of a pointing device on its tablet at full tablet resolution.
Notes:
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint. Use this value if you want to scale from tablet location to screen location yourself; otherwise use the class method mouseLocation or the instance method locationInWindow.

Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.absoluteZ as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 8.7 Yes No No Yes, macOS only No
Function: Reports the absolute z coordinate of pointing device on its tablet at full tablet resolution.
Notes:
For the coordinate to be valid, the receiver should represent an event generated by a tablet pointing device (otherwise 0 is returned). The z coordinate does not represent pressure. It registers the depth coordinate returned by some tablet devices with wheels; if the device is something other than these, 0 is returned. This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint.

Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.associatedEventsMask as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 15.1 Yes No No Yes, macOS only No
Function: The event mask describing the various events that you may also get during this event sequence.
Notes:
This message is valid for Mouse events. Useful for determining if the input device issuing this mouse event can also simultaneously issue NSEventTypePressure events.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.buttonMask as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 8.7 Yes No No Yes, macOS only No
Function: Returns a bit mask identifying the buttons pressed when the tablet event represented by the receiver was generated.
Notes:
Use one or more of the button-mask constants described in Constants to determine which buttons of the pointing device are pressed. This method is valid only for mouse events with a subtype of NSTabletPointEventSubtype and for events of type NSTabletPoint.

Available in Mac OS X v10.4 and later.

Constants to use:
NSPenTipMask=1The pen tip is activated.
NSPenLowerSideMask=2The button on the lower side of the device is activated.
NSPenUpperSideMask=4The button on the upper side of the device is activated.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.buttonNumber as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the button number for the mouse button that generated an NSOtherMouse... event.
Notes:
This method is intended for use with the NSOtherMouseDown, NSOtherMouseUp, and NSOtherMouseDragged events, but will return values for NSLeftMouse... and NSRightMouse... events also.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.capabilityMask as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns a mask whose set bits indicate the capabilities of the tablet device that generated the event represented by the receiver.
Notes:
These bits are vendor-defined. This method is valid only for mouse events with a subtype of NSTabletProximityEventSubtype and for events of type NSTabletProximity.

Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.CGEventRef as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 18.2 Yes No No Yes, macOS only No
Function: The Core Graphics event object corresponding to this event.
Notes:
The CGEventRef opaque type returned. If no CGEventRef object corresponding to the NSEvent object can be created, this method returns 0.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.characters as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the characters associated with the receiving key-up or key-down event.
Notes:
These characters are derived from a keyboard mapping that associates various key combinations with Unicode characters. Raises an NSInternalInconsistencyException if sent to any other kind of event object.

This method returns an empty string for dead keys, such as Option-e. However, for a key combination such as Option-Shift-e this method returns the standard accent ("'").
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.charactersIgnoringModifiers as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the characters generated by the receiving key event as if no modifier key (except for Shift) applies.
Notes:
Raises an NSInternalInconsistencyException if sent to a nonkey event.

This method returns the non-modifier key character pressed for dead keys, such as Option-e. For example, Option-e (no shift key) returns an "e" for this method, whereas the characters method returns an empty string.

This method is useful for determining "basic" key values in a hardware-independent manner, enabling such features as keyboard equivalents defined in terms of modifier keys plus character keys. For example, to determine if the user typed Alt-S, you don't have to know whether Alt-S generates a German double ess, an integral sign, or a section symbol. You simply examine the string returned by this method along with the event's modifier flags, checking for "s" and NSAlternateKeyMask.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.clickCount as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the number of mouse clicks associated with the receiver, which represents a mouse-down or mouse-up event.
Notes:
Raises an NSInternalInconsistencyException if sent to a nonmouse event.

Returns 0 for a mouse-up event if a time threshold has passed since the corresponding mouse-down event. This is because if this time threshold passes before the mouse button is released, it is no longer considered a mouse click, but a mouse-down event followed by a mouse-up event.

The return value of this method is meaningless for events other than mouse-down or mouse-up events.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.data1 as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.1 Yes No No Yes, macOS only No
Function: Returns additional data associated with the receiver.
Notes:
The value returned by this method is dependent on the event type, and is defined by the originator of the event. Raises an NSInternalInconsistencyException if sent to an event not of type NSAppKitDefined, NSSystemDefined, NSApplicationDefined, or NSPeriodic.

NSPeriodic events don't use this attribute.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.data2 as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.1 Yes No No Yes, macOS only No
Function: Returns additional data associated with the receiver.
Notes:
The value returned by this method is dependent on the event type, and is defined by the originator of the event. Raises an NSInternalInconsistencyException if sent to an event not of type NSAppKitDefined, NSSystemDefined, NSApplicationDefined, or NSPeriodic.

NSPeriodic events don't use this attribute.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.deltaX as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the x-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
Notes: (Read only property)

Feedback, Comments & Corrections

NSEventMBS.deltaY as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the y-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
Notes:
The behavior of this method may seem counter-intuitive: as the mouse moves up the screen, the value is negative; and as it moves down the screen, the value is positive. The reason for this behavior is that NSEvent computes this delta value in device space, which is flipped, but both the screen and the window's base coordinate system are not flipped.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.deltaZ as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the z-coordinate change for a scroll wheel, mouse-move, or mouse-drag event.
Notes: (Read only property)

Feedback, Comments & Corrections

NSEventMBS.description as string
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 11.0 Yes No No Yes, macOS only No
Function: Returns the description for this object.
Notes: (Read only property)

Feedback, Comments & Corrections

NSEventMBS.deviceID as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns a special identifier that is used to match tablet-pointer events with the tablet-proximity event represented by the receiver.
Notes:
All tablet-pointer events generated in the period between the device entering and leaving tablet proximity have the same device ID. This message is valid only for mouse events with subtype NSTabletPointEventSubtype or NSTabletProximityEventSubtype, and for NSTabletPoint and NSTabletProximity events.
Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.eventNumber as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the counter value of the latest mouse or tracking-rectangle event object; every system-generated mouse and tracking-rectangle event increments this counter.
Notes:
Raises an NSInternalInconsistencyException if sent to any other type of event object.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: The handle to the internal used NSEvent class.
Notes: (Read and Write property)

Feedback, Comments & Corrections

NSEventMBS.hasPreciseScrollingDeltas as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 13.1 Yes No No Yes, macOS only No
Function: Returns whether there are precise scrolling deltas available.
Notes:
Returns true if precise scrolling deltas are available; false otherwise.

This method is valid for NSScrollWheel events. A generic scroll wheel issues rather coarse scroll deltas. Some mice and trackpads provide much more precise delta. This method determines how the values of the scrollingDeltaX and scrollingDeltaY should be interpreted.
Available in OS X v10.7 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.isARepeat as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns true if the receiving key event is a repeat caused by the user holding the key down, false if the key event is new.
Notes:
Raises an NSInternalInconsistencyException if sent to an NSFlagsChanged event or other nonkey event.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.isDirectionInvertedFromDevice as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 13.1 Yes No No Yes, macOS only No
Function: Returns whether the user has changed the device inversion.
Notes:
This method valid for NSEventScrollWheel and NSEventTypeSwipe events. The user may choose to change the scrolling behavior such that it feels like they are moving the content instead of the scroll bar.

To accomplish this, deltaX and deltaY and scrollingDeltaX and scrollingDeltaY values are automatically inverted for NSEventScrollWheel events according to the user's preferences.

The direction of fluid swipes matches the direction of scrolling and as such for NSEventTypeSwipe events gestureAmount is inverted. However, for some uses of NSEventScrollWheel and NSEventTypeSwipe events, the behavior should not respect the user preference. This method allows you to determine when the event has been inverted and compensate by multiplying -1 if needed.

Available in OS X v10.7 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.isEnteringProximity as boolean
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns true to indicate that a pointing device is entering the proximity of its tablet and false when it is leaving it.
Notes:
This method is valid for mouse events with subtype NSTabletProximityEventSubtype and for NSTabletProximity events.
Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.keyCode as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns the virtual key code for the keyboard key associated with the receiving key event.
Notes:
The virtual key code. The returned value is hardware-independent. The value returned is the same as the value returned in the kEventParamKeyCode when using Carbon Events.

Raises an NSInternalInconsistencyException if sent to a non-key event.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.locationInWindow as NSPointMBS
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.1 Yes No No Yes, macOS only No
Function: Returns the receiver's location in the base coordinate system of the associated window.
Notes:
For nonmouse events the return value of this method is undefined.

With NSMouseMoved and possibly other events, the receiver can have a nil window (that is, window returns nil). In this case, locationInWindow returns the event location in screen coordinates.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.magnification as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns the change in magnification.
Notes:
The change in magnification that should be added to the current scaling of an item to achieve the new scale factor.
This message is valid for events of type NSEventTypeMagnify.
Available in Mac OS X v10.6 and later.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.modifierFlags as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 7.7 Yes No No Yes, macOS only No
Function: Returns an integer bit field indicating the modifier keys in effect for the receiver.
Notes:
You can examine individual flag settings using the C bitwise AND operator with the predefined key masks. The lower 16 bits of the modifier flags are reserved for device-dependent bits.
(Read only property)

Feedback, Comments & Corrections

NSEventMBS.pointingDeviceID as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Cocoa MBS MacBase Plugin 9.6 Yes No No Yes, macOS only No
Function: Returns the index of the pointing device currently in proximity with the tablet.
Notes:
This index is significant for multimode (or Dual Tracking) tablets that support multiple concurrent pointing devices; the index is incremented for each pointing device that comes into proximity. Otherwise, zero is always returned. The receiver of this message should be a mouse event object with subtype NSTabletProximityEventSubtype or an event of type NSTabletProximity.

Available in Mac OS X v10.4 and later.
(Read only property)

Feedback, Comments & Corrections

Next items

The items on this page are in the following plugins: MBS MacBase Plugin.




Links
MBS Xojo Plugins