Event Wrapper

group FnEventWrapper

class FnEventWrapper

#include <FnEventWrapper.h>

A Wrapper for UI events.

The event is used to pass UI event data from the viewport widget in Katana to Viewports. Events are generated by “EventTranslator” python plug-ins which convert Qt QEvents into attributes.

Public Types

enum MouseButtons

Mouse button enumeration used in the “button” event data attribute.

Values:

enumerator kNoButton

enumerator kLeftButton

enumerator kRightButton

enumerator kMidButton

enumerator kMiddleButton

enumerator kXButton1

enumerator kXButton2

enum KeyboardModifiers

Keyboard modifier enumeration used in the “modifiers” event data attribute.

Values:

enumerator kNoModifier

enumerator kShiftModifier

enumerator kControlModifier

enumerator kAltModifier

enumerator kMetaModifier

enumerator kKeypadModifier

enumerator kGroupSwitchModifier

Public Functions

FnEventWrapper()

FnEventWrapper(const FnAttribute::GroupAttribute &attr)

FnEventWrapper(const FnEventWrapper &other)

~FnEventWrapper()

std::string getType() const: Returns the type of event as a string.

FnAttribute::Hash getTypeHash() const: Returns the hash of the eventType StringAttribute for faster comparisons.

FnAttribute::GroupAttribute getData() const: Returns a GroupAttribute containing the additional event data.

FnAttributeHandle getHandle() const: Returns an attribute handle for the event data.

FnAttributeHandle getRetainedHandle() const: Returns a retained attribute handle for the event data.