Vuo  2.3.2
Classes | Functions
VuoKeyboard.m File Reference

Description

VuoKeyboard implementation.

Definition in file VuoKeyboard.m.

Go to the source code of this file.

Classes

struct  VuoKeyboardContext
 Handle for starting and stopping event listeners. More...
 

Functions

VuoKeyboardVuoKeyboard_make (void)
 Creates a handle for starting and stopping event listeners. More...
 
static void VuoKeyboard_fireTypingIfNeeded (NSEvent *event, struct VuoKeyboardContext *context, void(^typedLine)(VuoText), void(^typedWord)(VuoText), void(^typedCharacter)(VuoText, VuoModifierKey), VuoWindowReference windowRef)
 If the keypress event is not ignored, calls the trigger function(s) if this event completes a character (Unicode), word, and/or line. More...
 
static void VuoKeyboard_fireButtonsIfNeeded (NSEvent *event, VuoOutputTrigger(pressed, void), VuoOutputTrigger(released, void), VuoWindowReference windowRef, VuoKey key, VuoModifierKey modifierKey, bool shouldFireForRepeat)
 If the key event is not ignored, calls one of the trigger functions. More...
 
void VuoKeyboard_startListeningForTypingWithCallback (VuoKeyboard *keyboardListener, void(^typedLine)(VuoText), void(^typedWord)(VuoText), void(^typedCharacter)(VuoText, VuoModifierKey), VuoWindowReference window)
 Starts listening for key presses, and calling the trigger function each time a character (Unicode), word, or line is typed. More...
 
void VuoKeyboard_startListeningForTyping (VuoKeyboard *keyboardListener, VuoOutputTrigger(typedLine, VuoText), VuoOutputTrigger(typedWord, VuoText), VuoOutputTrigger(typedCharacter, VuoText), VuoWindowReference window)
 Starts listening for key presses, and calling the trigger function each time a character (Unicode), word, or line is typed. More...
 
void VuoKeyboard_startListeningForButtons (VuoKeyboard *keyboardListener, VuoOutputTrigger(pressed, void), VuoOutputTrigger(released, void), VuoWindowReference window, VuoKey key, VuoModifierKey modifierKey, bool shouldFireForRepeat)
 Starts listening or key presses and releases, and calling the trigger function for each one. More...
 
void VuoKeyboard_stopListening (VuoKeyboard *keyboardListener)
 Stops listening for keyboard events for the given handle. More...
 

Function Documentation

◆ VuoKeyboard_fireButtonsIfNeeded()

static void VuoKeyboard_fireButtonsIfNeeded ( NSEvent *  event,
VuoOutputTrigger(pressed, void)  ,
VuoOutputTrigger(released, void)  ,
VuoWindowReference  windowRef,
VuoKey  key,
VuoModifierKey  modifierKey,
bool  shouldFireForRepeat 
)
static

If the key event is not ignored, calls one of the trigger functions.

Definition at line 143 of file VuoKeyboard.m.

◆ VuoKeyboard_fireTypingIfNeeded()

static void VuoKeyboard_fireTypingIfNeeded ( NSEvent *  event,
struct VuoKeyboardContext context,
void(^)(VuoText typedLine,
void(^)(VuoText typedWord,
void(^)(VuoText, VuoModifierKey typedCharacter,
VuoWindowReference  windowRef 
)
static

If the keypress event is not ignored, calls the trigger function(s) if this event completes a character (Unicode), word, and/or line.

Definition at line 61 of file VuoKeyboard.m.

◆ VuoKeyboard_make()

VuoKeyboard* VuoKeyboard_make ( void  )

Creates a handle for starting and stopping event listeners.

Definition at line 46 of file VuoKeyboard.m.

◆ VuoKeyboard_startListeningForButtons()

void VuoKeyboard_startListeningForButtons ( VuoKeyboard keyboardListener,
VuoOutputTrigger(pressed, void)  ,
VuoOutputTrigger(released, void)  ,
VuoWindowReference  window,
VuoKey  key,
VuoModifierKey  modifierKey,
bool  shouldFireForRepeat 
)

Starts listening or key presses and releases, and calling the trigger function for each one.

Definition at line 223 of file VuoKeyboard.m.

◆ VuoKeyboard_startListeningForTyping()

void VuoKeyboard_startListeningForTyping ( VuoKeyboard keyboardListener,
VuoOutputTrigger(typedLine, VuoText ,
VuoOutputTrigger(typedWord, VuoText ,
VuoOutputTrigger(typedCharacter, VuoText ,
VuoWindowReference  window 
)

Starts listening for key presses, and calling the trigger function each time a character (Unicode), word, or line is typed.

Definition at line 207 of file VuoKeyboard.m.

◆ VuoKeyboard_startListeningForTypingWithCallback()

void VuoKeyboard_startListeningForTypingWithCallback ( VuoKeyboard keyboardListener,
void(^)(VuoText typedLine,
void(^)(VuoText typedWord,
void(^)(VuoText, VuoModifierKey typedCharacter,
VuoWindowReference  window 
)

Starts listening for key presses, and calling the trigger function each time a character (Unicode), word, or line is typed.

Changed in Vuo 2.0.0:
New.

Definition at line 186 of file VuoKeyboard.m.

◆ VuoKeyboard_stopListening()

void VuoKeyboard_stopListening ( VuoKeyboard keyboardListener)

Stops listening for keyboard events for the given handle.

Definition at line 245 of file VuoKeyboard.m.