MouseButtons Enumeration
Specifies constants that define which mouse buttons are pressed.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public enum MouseButtonsValues
| Value name | Value | Description |
|---|---|---|
| None | 0 | Indicates that no mouse button is pressed. |
| Left | 1 | Indicates that the left mouse button is pressed. |
| Right | 2 | Indicates that the right mouse button is pressed. |
| Middle | 4 | Indicates that the middle mouse button is pressed. |
| X1 | 8 | Indicates that the first X button is pressed. |
| X2 | 16 | Indicates that the second X button is pressed. |
Remarks
Values of the MouseButtons type are used to tell Carmenta Engine which mouse buttons are pressed in a platform and GUI framework agnostic way. In particular, C++ applications that derive a new control from the MapControl will usually have to translate from how the GUI framework represents mouse button states to MouseButtons values which are then forwarded to Carmenta Engine so all tools can work as expected.
The enumeration is a bit field. In mouse up and mouse down events, only a single value will be passed (the button being pressed or released), but in mouse move events, several values may be used together, indicating all buttons that were pressed when the mouse was moved.
Platforms
Windows, Linux, Android