HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UI_DeviceEvent Class Reference

#include <UI_DeviceEvent.h>

Public Types

enum  ScrollPhase {
  SCROLL_NO_PHASE = 0, SCROLL_BEGIN = 1, SCROLL_UPDATE = 2, SCROLL_END = 3,
  SCROLL_MOMENTUM = 4
}
 Scroll phase of a touchpad wheel event. Values match Qt::ScrollPhase. More...
 

Public Member Functions

 UI_DeviceEvent (int event_id=0)
 
bool getTypedCharacters (UT_Array< utf32 > &cps) const
 
bool isTouchPad () const
 
ScrollPhase scrollPhase () const
 

Static Public Member Functions

static void setTouchPadGestures (bool flag)
 Master switch for touchpad gestures, set from the preference. More...
 
static bool getTouchPadGestures ()
 

Public Attributes

UI_EventType type
 
RE_IDType context
 
double time
 
int64 serialId
 
exint data
 
int values [UI_DEVICE_DIMENSIONS]
 
short altFlags
 
int id
 
int qt_key
 
UT_StringHolder key
 

Detailed Description

Definition at line 75 of file UI_DeviceEvent.h.

Member Enumeration Documentation

Scroll phase of a touchpad wheel event. Values match Qt::ScrollPhase.

Enumerator
SCROLL_NO_PHASE 
SCROLL_BEGIN 
SCROLL_UPDATE 
SCROLL_END 
SCROLL_MOMENTUM 

Definition at line 85 of file UI_DeviceEvent.h.

Constructor & Destructor Documentation

UI_DeviceEvent::UI_DeviceEvent ( int  event_id = 0)
inline

Definition at line 127 of file UI_DeviceEvent.h.

Member Function Documentation

static bool UI_DeviceEvent::getTouchPadGestures ( )
inlinestatic

Definition at line 104 of file UI_DeviceEvent.h.

bool UI_DeviceEvent::getTypedCharacters ( UT_Array< utf32 > &  cps) const

Returns an array of Unicode code points corresponding to typed in characters from a keyboard event.

bool UI_DeviceEvent::isTouchPad ( ) const

Queries for a mouse wheel event that came from a touchpad. The bits are packed into DEVICE_DIM_T by UI_QtGeneratorThread. Always false when touchpad gestures are turned off, so every consumer falls back to plain mouse wheel behaviour.

ScrollPhase UI_DeviceEvent::scrollPhase ( ) const
static void UI_DeviceEvent::setTouchPadGestures ( bool  flag)
inlinestatic

Master switch for touchpad gestures, set from the preference.

Definition at line 102 of file UI_DeviceEvent.h.

Member Data Documentation

short UI_DeviceEvent::altFlags
Examples:
SOP/MSS_CustomBrushState.C.

Definition at line 115 of file UI_DeviceEvent.h.

RE_IDType UI_DeviceEvent::context

Definition at line 109 of file UI_DeviceEvent.h.

exint UI_DeviceEvent::data

Definition at line 113 of file UI_DeviceEvent.h.

int UI_DeviceEvent::id

Definition at line 117 of file UI_DeviceEvent.h.

UT_StringHolder UI_DeviceEvent::key

Definition at line 120 of file UI_DeviceEvent.h.

int UI_DeviceEvent::qt_key

Definition at line 119 of file UI_DeviceEvent.h.

int64 UI_DeviceEvent::serialId

Definition at line 111 of file UI_DeviceEvent.h.

double UI_DeviceEvent::time

Definition at line 110 of file UI_DeviceEvent.h.

UI_EventType UI_DeviceEvent::type

Definition at line 107 of file UI_DeviceEvent.h.

int UI_DeviceEvent::values[UI_DEVICE_DIMENSIONS]
Examples:
DM/DM_GreedyMouseHook.C.

Definition at line 114 of file UI_DeviceEvent.h.


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