Kaleidoscope_ Class Reference

#include <Kaleidoscope.h>

Public Types
typedef Key(*	eventHandlerHook) (Key mappedKey, byte row, byte col, uint8_t keyState)
typedef void(*	loopHook) (bool postClear)

Public Member Functions
	Kaleidoscope_ (void)
void	setup (const byte keymap_count)
void	setup (void)
void	loop (void)
void	use ()
void	use (KaleidoscopePlugin *p)
void	use (int)
template<typename... Plugins>
void	use (KaleidoscopePlugin *first, Plugins &&... plugins)

Static Public Member Functions
static void	replaceEventHandlerHook (eventHandlerHook oldHook, eventHandlerHook newHook)
static void	appendEventHandlerHook (eventHandlerHook hook)
static void	useEventHandlerHook (eventHandlerHook hook)
static void	replaceLoopHook (loopHook oldHook, loopHook newHook)
static void	appendLoopHook (loopHook hook)
static void	useLoopHook (loopHook hook)
static bool	focusHook (const char *command)

Static Public Attributes
static eventHandlerHook	eventHandlers [HOOK_MAX]
static loopHook	loopHooks [HOOK_MAX]

Member Typedef Documentation

eventHandlerHook

typedef Key(* Kaleidoscope_::eventHandlerHook) (Key mappedKey, byte row, byte col, uint8_t keyState)

loopHook

typedef void(* Kaleidoscope_::loopHook) (bool postClear)

Constructor & Destructor Documentation

Kaleidoscope_()

Kaleidoscope_::Kaleidoscope_

(

void

)

Member Function Documentation

appendEventHandlerHook()

void Kaleidoscope_::appendEventHandlerHook ( eventHandlerHook  hook )

static

appendLoopHook()

void Kaleidoscope_::appendLoopHook ( loopHook  hook )

static

focusHook()

bool Kaleidoscope_::focusHook ( const char *  command )

static

loop()

void Kaleidoscope_::loop

(

void

)

replaceEventHandlerHook()

void Kaleidoscope_::replaceEventHandlerHook ( eventHandlerHook  oldHook, eventHandlerHook  newHook  )

static

replaceLoopHook()

void Kaleidoscope_::replaceLoopHook ( loopHook  oldHook, loopHook  newHook  )

static

setup() [1/2]

void Kaleidoscope_::setup ( const byte  keymap_count )

inline

setup() [2/2]

void Kaleidoscope_::setup

(

void

)

use() [1/4]

void Kaleidoscope_::use ( )

inline

use() [2/4]

void Kaleidoscope_::use ( KaleidoscopePlugin *  p )

inline

use() [3/4]

void Kaleidoscope_::use ( int  )

inline

use() [4/4]

template<typename... Plugins>

void Kaleidoscope_::use ( KaleidoscopePlugin *  first, Plugins &&...  plugins  )

inline

useEventHandlerHook()

void Kaleidoscope_::useEventHandlerHook ( eventHandlerHook  hook )

static

useLoopHook()

void Kaleidoscope_::useLoopHook ( loopHook  hook )

static

Member Data Documentation

eventHandlers

Kaleidoscope_::eventHandlerHook Kaleidoscope_::eventHandlers

static

loopHooks

Kaleidoscope_::loopHook Kaleidoscope_::loopHooks

static

---

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

• Kaleidoscope/src/Kaleidoscope.h
• Kaleidoscope/src/Kaleidoscope.cpp