Quick Native Keyboard C++ Wrapper

Quick wrapper to Marmalade's s3eKeyboard features.

The basic idea is to be able to quickly use a native keyboard from Marmalade QUICK without the need of much coding from the quick side of things.

This wrapper uses the char_event event, so it's quite usefull for keyboard input. It should be quite straightforward to add support for key events and be able to handle different key events (ie Volume keys). That can be currently done straight from quick

Requirements

• This extension has been tested to be compatible with Marmalade 7.7.x. It should work with 7.8.x as well but I didn't had the time to test is properly.

How to install

• Clone this repo somewhere
• Add the following lines to add something like the following to /s3e/s3e-default.mkf:

options
{
    module_paths="c:/full/path/to/my/root/github/folder"
}

This will be super helpfull when building extensions

• Tell tolua++ to include the new code:
  • Edit quick/quickuser_tolua.pkg and add something like:

  $cfile "s3eKeyboard/quick/QNativeKeyboard.h"
  

• Rebuild lua bindings:
  • Run /quick/quickuser_tolua (.bat on Windows, bash script on Mac).

*Rebuild Quick Binaries:

• Add the new files to quick/quickuser.mkf:

files
{
  quickuser_tolua.cpp
  quickuser_tolua.pkg
  quickuser.h

  # Our new files
  quick-native-keyboard/quick/QNativeKeyboard.h
  quick-native-keyboard/quick/QNativeKeyboard.cpp
} 

• Follow the guide here: http://docs.madewithmarmalade.com/display/MD/Extending+Quick#ExtendingQuick-rebuild

Using the extension from LUA

Hide/Show Keyboard

In order to use the extension you can use any of the two following methods:

nativeKeyboard.showKeyboard()

or

nativeKeyboard.showKeyboard()

to show/hide the keyboard.

Getting the input text form the keyboard

This extension throws a char_event event to the lua layer with the following fields

Key	Description
regular_char	event->m_Char value from the s3eKeyboardEvent
multibyte_char	regular_char as multibyte character using wctomb
command	BACKSPACE or ENTER

Bind listener

You should bind your listener to listen for char_event like this:

system:addEventListener("char_event", char_event)

Implement listener method

Implement your own logic, such as:

function char_event(event)
  console:dbg("Received char [" .. event.regular_char .. "]")

  if event.command == "ENTER" then
    nativeKeyboard.hideKeyboard()
    return
  end
end

Credits

KUDOS to Kidloom for leting me share this code with the community.