OFX::KeyArgs Struct Reference

struct to pass arguments into OFX::Interact key actions More...

#include <ofxsInteract.h>

Inheritance diagram for OFX::KeyArgs:

Collaboration diagram for OFX::KeyArgs:

Public Member Functions
	KeyArgs (const PropertySet &props)
	ctor
Data Fields
int	keySymbol
	The key represented as one of the entries in ofxKeySyms.h, see note in OFX::KeyArgs.
std::string	keyString
	That key as a UTF8 string, see note in OFX::KeyArgs.

---

Detailed Description

struct to pass arguments into OFX::Interact key actions

Note

• some keys cannot be represented as UTF8 strings (eg: the key pad page down key kOfxKey_KP_Page_Up), in which case the key string will be set to "".
• some UTF8 symbols (generally non-English language ones) cannot be represented by one of the keySymbols, in which case the UTF8 string will be set to some non empty value, but the keySymbol will be set to kOfxKey_Unknown.
• in no case will keyString be set to "" and keySymbol be set to kOfxKey_Unknown.

Definition at line 98 of file ofxsInteract.h.

---

Constructor & Destructor Documentation

OFX::KeyArgs::KeyArgs

(

const PropertySet &

props

)

ctor

Definition at line 335 of file ofxsInteract.cpp.

References OFX::getRenderScale(), keyString, keySymbol, kOfxPropKeyString, kOfxPropKeySym, kOfxPropTime, OFX::PropertySet::propGetDouble(), OFX::PropertySet::propGetInt(), OFX::PropertySet::propGetString(), OFX::InteractArgs::renderScale, and OFX::InteractArgs::time.

Here is the call graph for this function:

---

Field Documentation

std::string OFX::KeyArgs::keyString

That key as a UTF8 string, see note in OFX::KeyArgs.

Definition at line 103 of file ofxsInteract.h.

Referenced by KeyArgs().

int OFX::KeyArgs::keySymbol

The key represented as one of the entries in ofxKeySyms.h, see note in OFX::KeyArgs.

Definition at line 102 of file ofxsInteract.h.

Referenced by KeyArgs(), tuttle::plugin::warp::WarpOverlayInteract::keyDown(), tuttle::plugin::colorCubeViewer::ColorCubeViewerOverlay::keyDown(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerOverlay::keyDown(), tuttle::plugin::histogram::HistogramOverlay::keyDown(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::keyDown(), tuttle::plugin::colorSpaceKeyer::ColorSpaceKeyerOverlay::keyUp(), tuttle::plugin::colorCubeViewer::ColorCubeViewerOverlay::keyUp(), tuttle::plugin::histogramKeyer::HistogramKeyerOverlay::keyUp(), and tuttle::plugin::histogram::HistogramOverlay::keyUp().

---

The documentation for this struct was generated from the following files:

• libraries/openfxHack/Support/include/ofxsInteract.h
• libraries/openfxHack/Support/Library/ofxsInteract.cpp