Difference between revisions of "Virtual Keyboard"

Virtual Keyboard (view source)

Revision as of 17:53, 8 June 2009

3 bytes removed , 17:53, 8 June 2009

→‎Information for porters

DJWillis

208

edits

@@ Line 158: / Line 158: @@
 By default the virtual keyboard code is disabled from a ScummVM build. In order to enable it use the '''--enable-vkeybd''' flag when running the configure script.
-After you have enabled the virtual keyboard in a build the loading code must be provided with a path to find the keyboard pack(s), and the name of the keyboard pack to use. For the path the loading code uses the value of the''' 'vkeybdpath' '''config file variable if it is defined. If it is not defined it will revert to the 'extrapath' variable. Likewise, if that is not defined it defaults to the current directory.
+After you have enabled the virtual keyboard in a build the loading code must be provided with a path to find the keyboard pack(s), and the name of the keyboard pack to use.
-For the name of the keyboard pack, the loading code uses the''' 'vkeybd_pack_name' '''variable if defined, if not it defaults to using 'vkeybd' for the pack name.
+For the path the loading code uses the value of the''' 'vkeybdpath' '''config file variable if it is defined. If it is not defined it will revert to the 'extrapath' variable. Likewise, if that is not defined it default to the current directory.
+For the name of the keyboard pack, the loading code uses the''' 'vkeybd_pack_name' '''variable if defined, if not it defaults to using''' 'vkeybd_default' '''for the pack name.
 Once the keyboard pack path and name are defined the loading code looks for a valid keyboard pack. First it looks for an uncompressed pack by looking for a file with the name ''[packname]''.xml in the keyboard pack directory. If it does not find this it will look for a compressed pack by looking for a file with the name ''[packname]''.zip.
-''Maybe the loading process should be simplified to use a single path variable that could point to a single xml or zip file (the facility for naming a pack was meant to allow switching between packs at runtime, but this is probably not required)''
+To use the keyboard within your port ensure that your choice of keyboard pack has a suitable resolution (<= your overlay resolution) and that you have wired up something in your event handling code to generate Common::KEYCODE_F7.
 == Information for users ==