diff options
Diffstat (limited to 'backends/vkeybd/virtual-keyboard-parser.h')
| -rw-r--r-- | backends/vkeybd/virtual-keyboard-parser.h | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/backends/vkeybd/virtual-keyboard-parser.h b/backends/vkeybd/virtual-keyboard-parser.h index 12adcd61c2..eeea1995c7 100644 --- a/backends/vkeybd/virtual-keyboard-parser.h +++ b/backends/vkeybd/virtual-keyboard-parser.h @@ -38,13 +38,13 @@ ** Virtual Keyboard Pack File Format ** *************************************** -The new virtual keyboard for ScummVM is implemented in the same way as a HTML -ImageMap. It uses a single bitmap of the entire keyboard layout and then a -image map description allows certain areas of the bitmap to be given special -actions. Most of these actions will be a virtual key press event, but there -will also be special keys that will change the keyboard layout or close the +The new virtual keyboard for ScummVM is implemented in the same way as a HTML +ImageMap. It uses a single bitmap of the entire keyboard layout and then a +image map description allows certain areas of the bitmap to be given special +actions. Most of these actions will be a virtual key press event, but there +will also be special keys that will change the keyboard layout or close the keyboard. The HTML image map description is contained in a larger XML file that -can describe all the different modes of the keyboard, and also different +can describe all the different modes of the keyboard, and also different keyboard layouts for different screen resolutions. ******************************************** @@ -92,7 +92,7 @@ keyboard layouts for different screen resolutions. <keyboard> -This is the required, root element of the file format. +This is the required, root element of the file format. required attributes: - initial_mode: name of the mode the keyboard will show initially @@ -108,12 +108,12 @@ child tags: <mode> -This tag encapsulates a single mode of the keyboard. Within are a number of +This tag encapsulates a single mode of the keyboard. Within are a number of layouts, which provide the specific implementation at different resolutions. required attributes: - - name: the name of the mode - - resolutions: list of the different layout resolutions + - name: the name of the mode + - resolutions: list of the different layout resolutions child tags: - layout @@ -129,12 +129,12 @@ same as an event's name. required attributes: - name: name of the event - - type: key | modifier | switch_mode | submit | cancel | clear | delete | + - type: key | modifier | switch_mode | submit | cancel | clear | delete | move_left | move_right - see VirtualKeyboard::EventType for explanation for key events - code / ascii: describe a key press in ScummVM KeyState format for key and modifier events - - modifiers: modifier keystate as comma-separated list of shift, ctrl and/or + - modifiers: modifier keystate as comma-separated list of shift, ctrl and/or alt. for switch_mode events - mode: name of the mode that should be switched to @@ -148,8 +148,8 @@ required attributes: - resolution: the screen resolution that this layout is designed for - bitmap: filename of the 24-bit bitmap that will be used for this layout -optional attributes: - - transparent_color: color in r,g,b format that will be used for keycolor +optional attributes: + - transparent_color: color in r,g,b format that will be used for keycolor transparency (defaults to (255,0,255). - display_font_color: color in r,g,b format that will be used for the text of the keyboard display (defaults to (0,0,0). @@ -161,13 +161,13 @@ child nodes: <map> -These tags describe the image map for a particular layout. It uses the same -format as HTML image maps. The only area shapes that are supported are +These tags describe the image map for a particular layout. It uses the same +format as HTML image maps. The only area shapes that are supported are rectangles and polygons. The target attribute of each area should be the name of an event for this mode (see <event> tag). They will usually be generated by -an external tool such as GIMP's Image Map plugin, and so will not be written -by hand, but for more information on HTML image map format see - - http://www.w3schools.com/TAGS/tag_map.asp +an external tool such as GIMP's Image Map plugin, and so will not be written +by hand, but for more information on HTML image map format see + - http://www.w3schools.com/TAGS/tag_map.asp - http://www.w3schools.com/TAGS/tag_area.asp */ @@ -177,21 +177,21 @@ namespace Common { /** * Subclass of Common::XMLParser that parses the virtual keyboard pack * description file - */ + */ class VirtualKeyboardParser : public XMLParser { public: /** - * Enum dictating how extensive a parse will be + * Enum dictating how extensive a parse will be */ enum ParseMode { /** * Full parse - when loading keyboard pack for first time */ - kParseFull, - /** - * Just check resolutions and reload layouts if needed - following a + kParseFull, + /** + * Just check resolutions and reload layouts if needed - following a * change in screen size */ kParseCheckResolutions |