crystalspace.jbind.interfaces.iutil.csinput
Interface iKeyComposer

All Superinterfaces:

iBase, iPointer

All Known Implementing Classes:

csKeyComposer

public interface iKeyComposer

extends iBase

Keyboard input handler.

Author:

Java wrapper - Quentin Anciaux, c++ version - http://crystal.sourceforge.net/docs/online/devapi/structiKeyComposer.php

Method Summary

csNativeIntArray	handleKey(csKeyEventData keyEventData, csNativeIntArray buf) Handle keyboard input.
void	resetState() Reset the composer's internal state.

Methods inherited from interface crystalspace.jbind.interfaces.iutil.scf.iBase

decRef, getName, getRefCount, getVersion, incRef, queryInterface, queryInterfaceSafe

Methods inherited from interface crystalspace.jbind.interfaces.iPointer

changePointer, getPointer, isMemoryOwner, setMemoryOwner

Method Detail

handleKey

public csNativeIntArray handleKey(csKeyEventData keyEventData,
                                  csNativeIntArray buf)

Handle keyboard input. Converts the input to characters, if possible. If the key passed in is a dead key, it will be stored internally and affect the returned data of the subsequent keypress. Parameters: keyEventData Information from a keyboard event. buf Buffer to store the output in. Should be at least contain 2 characters (however, the method will work with smaller buffers as well.) bufChars Number of characters the output buffer is actually sized. return[1] returns the number of characters written to the outpuit buffer. return[0] The type of character(s) that has been written to the output buffer.

Parameters:

keyEventData -

buf -

Returns:

resetState

public void resetState()

Reset the composer's internal state. Specifically, it will clear any stored dead key - the next key won't be combined with it.