C3D Toolkit  Kernel - 117982, Vision - 2.9.2.2

InputEvent class is the base class for events that describes user input. More...

#include <vsn_processevent.h>

+ Inheritance diagram for VSN::InputEvent:
+ Collaboration diagram for VSN::InputEvent:

Public Member Functions

 InputEvent (EventType type)
 Default constructor.
 
 InputEvent (const InputEvent &other)
 Copy constructor.
 
 ~InputEvent ()
 Destructor.
 
bool Control () const
 True if Ctrl key is currently pressed.
 
bool Shift () const
 True if Shift key is currently pressed.
 
bool Alt () const
 True if Alt key is currently pressed.
 
bool LeftAlt () const
 True if the left Alt key is pressed.
 
bool LeftControl () const
 True if the left Ctrl key is pressed.
 
bool LeftShift () const
 True if the left Shift key is pressed.
 
bool RightAlt () const
 True if the right Alt key is pressed.
 
bool RightControl () const
 True if the right Ctrl key is pressed.
 
bool RightShift () const
 True if the right Shift key is pressed.
 
unsigned int GetFlags () const
 Returns ProcessEvent bit flags like mb_LButton for special events of Shift and Ctrl keys as well as left, middle and right mouse buttons.
 
void SetFlags (int flags)
 This method sets bitwise flags that shows the state of mouse buttons, Shift and Ctrl keys. More...
 
- Public Member Functions inherited from VSN::ProcessEvent
 ProcessEvent (EventType type)
 Default constructor.
 
 ProcessEvent (const ProcessEvent &other)
 Copy constructor.
 
virtual ~ProcessEvent ()
 Destructor.
 
EventType GetType () const
 Returns event type identifier.
 

Protected Attributes

unsigned int m_flags
 Flags indicate which of mouse buttons is pressed and if Shift and Ctrl keyboard keys are pressed.
 

Additional Inherited Members

- Public Types inherited from VSN::ProcessEvent
enum  EventType {
  None = 0 , LButtonDown = 1 , LButtonUp = 2 , LButtonDblClk = 3 ,
  MButtonDown = 4 , MButtonUp = 5 , MButtonDblClk = 6 , RButtonDown = 7 ,
  RButtonUp = 8 , RButtonDblClk = 9 , MouseMove = 10 , HoverMove = 11 ,
  MouseEnter = 12 , MouseLeave = 13 , MouseWheel = 14 , MouseWheelUp = 15 ,
  MouseWheelDown = 16 , Close = 18 , Timer = 19 , KeyDown = 20 ,
  KeyUp = 21 , Selection = 22 , JoyStickTranslate = 23 , JoyStickRotate = 24 ,
  JoyStickButton = 25 , Camera = 26 , ChildRemoved = 27 , Draw = 29 ,
  WindowStateModified = 30 , UpdateInquiry = 31 , WinEventAct = 33 , ThreadChange = 34 ,
  DeferredDelete = 35 , NonClientAreaMouseMove = 36 , SockAct = 37 , Quit = 38 ,
  FutureCallOut = 39 , MetaCall = 40 , NullTimerEvent = 41 , PlatformRenderingArea = 42 ,
  ChildAdded = 43 , User = 500 , MaxUser = 65535
}
 The event type defines state of mouse, keyboard and such devices in real time mode. More...
 

Detailed Description

InputEvent class is the base class for events that describes user input.

Member Function Documentation

◆ SetFlags()

void VSN::InputEvent::SetFlags ( int  flags)
inline

This method sets bitwise flags that shows the state of mouse buttons, Shift and Ctrl keys.

Parameters
[in]flags- Bitwise flags for mouse and key states. For example, if both Shift key and left mouse button are pressed, pass mb_Shift|mb_LButton.

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