| GL Studio C++ Runtime API

Public Types | Public Member Functions | Public Attributes | List of all members
RSOInterface1::MouseEvent Class Reference

`#include <rso_interface_1.h>`

Inheritance diagram for RSOInterface1::MouseEvent:

## Public Types
enum | MouseButtonType { MOUSE_LBUTTON = 1 , MOUSE_MBUTTON = 2 , MOUSE_RBUTTON = 4 , MOUSE_BUTTON_ANY = 7 }
Public Types inherited from RSOInterface1::Event
enum | EventTypeEnum { EVENT_MOUSE = 0 , EVENT_KEYBOARD , EVENT_TIMER , EVENT_OBJECT , EVENT_KEYBOARD_UP }
enum | EventSubtypeEnum { MOUSE_DOWN = 0 , MOUSE_UP , MOUSE_MOVE , MOUSE_DRAG , MOUSE_LEAVE , MOUSE_ENTER , MOUSE_WHEEL_MINUS , MOUSE_WHEEL_PLUS }
enum | SpecialKeyState { NONE_STATE = 0 , SHIFT_STATE = 0x00010000 , CAPS_LOCK_STATE = 0x00020000 , CTRL_STATE = 0x00040000 , ALT_STATE = 0x00080000 , NUM_LOCK_STATE = 0x00100000 , META_STATE = 0x00400000 , SCROLL_LOCK_STATE = 0x00800000 , BUTTON1_STATE = 0x01000000 , BUTTON2_STATE = 0x02000000 , BUTTON3_STATE = 0x04000000 }

## Public Member Functions
unsigned char | ButtonMask ()
void | ButtonMask (unsigned char value)
unsigned char | Clicks ()
void | Clicks (unsigned char value)
int | Modifiers ()
void | Modifiers (int value)
Public Member Functions inherited from RSOInterface1::LocationEvent
Vector | WinLoc ()
void | WinLoc (Vector value)
Public Member Functions inherited from RSOInterface1::Event
unsigned short | EventType ()
void | EventType (unsigned short value)
unsigned short | EventSubType ()
void | EventSubType (unsigned short value)

## Public Attributes
unsigned char | _buttonMask
unsigned char | _clicks
int | _modifiers
Public Attributes inherited from RSOInterface1::LocationEvent
Vector | _winLoc
Public Attributes inherited from RSOInterface1::Event
unsigned short | _eventType
unsigned short | _eventSubtype

## Detailed Description

An event containing mouse input.

## Member Enumeration Documentation

## ◆ MouseButtonType

enum MouseButtonType

Mouse Button Type

Enumerator
MOUSE_LBUTTON | Mask that matches only left mouse button
MOUSE_MBUTTON | Mask that matches only middle mouse button
MOUSE_RBUTTON | Mask that matches only right mouse button
MOUSE_BUTTON_ANY | Mask that matches any mouse button

## Member Function Documentation

## ◆ ButtonMask() [1/2]

unsigned char ButtonMask | ( |  | ) |
| inline

Returns
  The current button mask of this event.

## ◆ ButtonMask() [2/2]

void ButtonMask | ( | unsigned char | value | ) |
| inline

Set the button mask for this event. i.e. Which buttons are down.

Parameters

  value | The new button mask to set.

## ◆ Clicks() [1/2]

unsigned char Clicks | ( |  | ) |
| inline

Returns
  The number of clicks associated with this event.

## ◆ Clicks() [2/2]

void Clicks | ( | unsigned char | value | ) |
| inline

Set the number of clicks associated with this event. i.e. single or double click

Parameters

  value | The new number of clicks to set

## ◆ Modifiers() [1/2]

int Modifiers | ( |  | ) |
| inline

Returns
  The current keyboard modifers of this event.

## ◆ Modifiers() [2/2]

void Modifiers | ( | int | value | ) |
| inline

Set the keyboard modifers for this event. e.g. control being held.

Parameters

  value | The new keyboard modifers to set.

## Member Data Documentation

## ◆ _buttonMask

unsigned char _buttonMask

bitfield: which button was pressed for this event ( MouseButtonType )

## ◆ _clicks

unsigned char _clicks

# of times a button was pressed

## ◆ _modifiers

int _modifiers

bitfield: which buttons or modifiers were depressed before event (

See also
  SpecialKeyState)

The documentation for this class was generated from the following file:

- rso_interface_1.h