Foundry::Katana::ViewerAPI::FnEventWrapper Class Reference

A Wrapper for UI events. More...

#include <FnEventWrapper.h>

List of all members.

Public Types
enum	MouseButtons
	Mouse button enumeration used in the "button" event data attribute.
enum	KeyboardModifiers
	Keyboard modifier enumeration used in the "modifiers" event data attribute.
Public Member Functions
std::string	getType () const
	Returns the type of event as a string.
FnAttribute::Hash	getTypeHash () const
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.

---

Detailed Description

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.

---

Member Function Documentation

FnAttribute::Hash Foundry::Katana::ViewerAPI::FnEventWrapper::getTypeHash

(

)

const

Returns the hash of the eventType StringAttribute for faster comparisons.

---

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

• FnEventWrapper.h