VuoKeyboard.h File Reference

Description

VuoKeyboard interface.

Copyright

Copyright © 2012–2020 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoKeyboard.h.

Go to the source code of this file.

Typedefs
typedef void *	VuoKeyboard
	Handle returned when starting to listen for events, to be used when stopping listening. More...

Functions
VuoKeyboard *	VuoKeyboard_make (void)
	Creates a handle for starting and stopping event listeners. 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_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_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...

Typedef Documentation

VuoKeyboard

typedef void* VuoKeyboard

Handle returned when starting to listen for events, to be used when stopping listening.

Definition at line 14 of file VuoKeyboard.h.

Function Documentation

VuoKeyboard_make()

VuoKeyboard* VuoKeyboard_make

(

void

)

Creates a handle for starting and stopping event listeners.

Definition at line 48 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 225 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 209 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 188 of file VuoKeyboard.m.

VuoKeyboard_stopListening()

void VuoKeyboard_stopListening

(

VuoKeyboard *

keyboardListener

)

Stops listening for keyboard events for the given handle.

Definition at line 247 of file VuoKeyboard.m.