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 ()
 
static void setTouchPadInvert (bool flag)
 
static bool getTouchPadInvert ()
 
static void setTouchPadZoomInvert (bool flag)
 
static bool getTouchPadZoomInvert ()
 

Public Attributes

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

Detailed Description

Definition at line 101 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 111 of file UI_DeviceEvent.h.

Constructor & Destructor Documentation

UI_DeviceEvent::UI_DeviceEvent ( int  event_id = 0)
inline

Definition at line 166 of file UI_DeviceEvent.h.

Member Function Documentation

static bool UI_DeviceEvent::getTouchPadGestures ( )
inlinestatic

Definition at line 130 of file UI_DeviceEvent.h.

static bool UI_DeviceEvent::getTouchPadInvert ( )
inlinestatic

Definition at line 137 of file UI_DeviceEvent.h.

static bool UI_DeviceEvent::getTouchPadZoomInvert ( )
inlinestatic

Definition at line 141 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 128 of file UI_DeviceEvent.h.

static void UI_DeviceEvent::setTouchPadInvert ( bool  flag)
inlinestatic

Flip the direction of a touchpad scroll that pans or tumbles, and of one that zooms. Set from the preferences.

Definition at line 135 of file UI_DeviceEvent.h.

static void UI_DeviceEvent::setTouchPadZoomInvert ( bool  flag)
inlinestatic

Definition at line 139 of file UI_DeviceEvent.h.

Member Data Documentation

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

Definition at line 152 of file UI_DeviceEvent.h.

RE_IDType UI_DeviceEvent::context

Definition at line 146 of file UI_DeviceEvent.h.

exint UI_DeviceEvent::data

Definition at line 150 of file UI_DeviceEvent.h.

short UI_DeviceEvent::deviceFlags

Definition at line 153 of file UI_DeviceEvent.h.

int UI_DeviceEvent::id

Definition at line 154 of file UI_DeviceEvent.h.

UT_StringHolder UI_DeviceEvent::key

Definition at line 157 of file UI_DeviceEvent.h.

int UI_DeviceEvent::qt_key

Definition at line 156 of file UI_DeviceEvent.h.

int64 UI_DeviceEvent::serialId

Definition at line 148 of file UI_DeviceEvent.h.

double UI_DeviceEvent::time

Definition at line 147 of file UI_DeviceEvent.h.

UI_EventType UI_DeviceEvent::type

Definition at line 144 of file UI_DeviceEvent.h.

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

Definition at line 151 of file UI_DeviceEvent.h.


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