55 lines
1.7 KiB
Plaintext
55 lines
1.7 KiB
Plaintext
EekBoard - Easy Embedded Keyboard -*- outline -*-
|
|
|
|
*NOTE* This is not usable by now. The code has still a lot of bugs and
|
|
lacks documentation.
|
|
|
|
* What's this?
|
|
|
|
EekBoard is a virtual keyboard software package which ships with a
|
|
standalone virtual keyboard application ("eekboard"), and a library to
|
|
create keyboard-like UI ("libeek").
|
|
|
|
* Quick look
|
|
|
|
http://ueno.fedorapeople.org/eek/eek-in-demo.ogv (2MB, Ogg Theora video)
|
|
|
|
* How to test
|
|
|
|
$ git clone git://github.com/ueno/eek.git eekboard
|
|
$ cd eekboard
|
|
$ ./autogen.sh --prefix=/usr --enable-gtk-doc
|
|
$ make
|
|
$ sudo make install
|
|
$ eekboard
|
|
|
|
* libeek API (not fixed)
|
|
|
|
libeek provides only two kinds of objects. One is "keyboard element"
|
|
and another is "keyboard layout engine". A keyboard element
|
|
represents either a keyboard, a section, or a key. Each element
|
|
implements the Builder pattern[1] so that it can be converted into a
|
|
UI widget (ClutterActor, GTK+ button, ...). A layout engine arranges
|
|
keyboard elements using information from external configuration
|
|
mechanisms (XKB, matchbox-keyboard layouts in XML, ...)
|
|
|
|
Here is a sample code which utilizes Clutter-based keyboard elements
|
|
and an XKB-based layout engine:
|
|
|
|
1: EekKeyboard *keyboard;
|
|
2: EekLayout *layout;
|
|
3:
|
|
4: /* Create a keyboard layout using XKB configuration. */
|
|
5: layout = eek_xkb_layout_new (NULL, "kinesis", "in");
|
|
6:
|
|
7: /* Create a keyboard implemented as ClutterActor. */
|
|
8: keyboard = eek_clutter_keyboard_new (640, 480);
|
|
9:
|
|
10: /* Apply the layout to the keyboard. */
|
|
11: eek_keyboard_set_layout (keyboard, layout);
|
|
12:
|
|
13: clutter_group_add (CLUTTER_GROUP(stage),
|
|
14: eek_clutter_keyboard_get_actor (EEK_CLUTTER_KEYBOARD(keyboard)));
|
|
|
|
Footnotes:
|
|
[1] http://en.wikipedia.org/wiki/Builder_pattern
|