qmk_firmware/internals/ucis.md

group ucis

Summary

Members	Descriptions
define UCIS_MAX_INPUT_LENGTH
define UCIS_MAX_CODE_POINTS
define UCIS_TABLE
define UCIS_SYM
public void ucis_start(void)	Begin the input sequence.
public bool ucis_active(void)	Whether UCIS is currently active.
public uint8_t ucis_count(void)	Get the number of characters in the input sequence buffer.
public bool ucis_add(uint16_t keycode)	Add the given keycode to the input sequence buffer.
public bool ucis_remove_last(void)	Remove the last character from the input sequence.
public void ucis_finish(void)	Mark the input sequence as complete, and attempt to match.
public void ucis_cancel(void)	Cancel the input sequence.
public void register_ucis(uint8_t index)	Send the code point(s) for the given UCIS index.
struct ucis_symbol_t

Members

define UCIS_MAX_INPUT_LENGTH

define UCIS_MAX_CODE_POINTS

define UCIS_TABLE

define UCIS_SYM

public void ucis_start(void)

Begin the input sequence.

public bool ucis_active(void)

Whether UCIS is currently active.

Returns

true if UCIS is active.

public uint8_t ucis_count(void)

Get the number of characters in the input sequence buffer.

Returns

The current input sequence buffer length.

public bool ucis_add(uint16_t keycode)

Add the given keycode to the input sequence buffer.

Parameters

• keycode The keycode to add. Must be between KC_A and KC_Z, or KC_1 and KC_0.

Returns

true if the keycode was added.

public bool ucis_remove_last(void)

Remove the last character from the input sequence.

Returns

true if the sequence was not empty.

public void ucis_finish(void)

Mark the input sequence as complete, and attempt to match.

public void ucis_cancel(void)

Cancel the input sequence.

public void register_ucis(uint8_t index)

Send the code point(s) for the given UCIS index.

Parameters

• index The index into the UCIS symbol table.

struct ucis_symbol_t

Summary

Members	Descriptions
public char * mnemonic
public uint32_t code_points

Members

public char * mnemonic

public uint32_t code_points