1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
// This file is part of the Noddybox.Emulation C# suite.
//
// Noddybox.Emulation is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Noddybox.Emulation is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Noddybox.Emulation. If not, see <http://www.gnu.org/licenses/>.
//
// Copyright (c) 2012 Ian Cowburn
//
using System;
using System.Xml;
namespace Noddybox.Emulation.Keyboard.Schema
{
/// <summary>
/// Provides an element for the keyboard definition.
/// </summary>
public class KeyboardKey
{
#region Properties
/// <summary>
/// The symbol the key will be represented by in an enumerated type.
/// Type checking will only be performed by the actual keyboard implementation
/// where the value will be used as a key (the other sort).
/// </summary>
public string KeySymbol {get; set;}
/// <summary>
/// The X-offset of the hit box
/// </summary>
public int X { get; set; }
/// <summary>
/// The Y-offset of the hit box
/// </summary>
public int Y { get; set; }
/// <summary>
/// The width of the hit box
/// </summary>
public int Width { get; set; }
/// <summary>
/// The height of the hit box
/// </summary>
public int Height { get; set; }
/// <summary>
/// Whether the key is sticky (stays pressed until pressed again).
/// </summary>
public bool Sticky { get; set; }
#endregion
#region Xml members
/// <summary>
/// Set up an XmlElement with the contents of this object.
/// </summary>
/// <param name="doc">The document the element is to be attached to.</param>
public void SetElement(XmlElement element)
{
element.SetAttribute("KeySymbol", KeySymbol);
element.SetAttribute("X", X.ToString());
element.SetAttribute("Y", Y.ToString());
element.SetAttribute("Width", Width.ToString());
element.SetAttribute("Height", Height.ToString());
element.SetAttribute("Sticky", Sticky.ToString());
}
/// <summary>
/// Create an instance of this object from an XmlElement.
/// </summary>
/// <param name="doc">The document the element is to be attached to.</param>
/// <returns>The XML element.</returns>
public static KeyboardKey CreateFromElement(XmlElement element)
{
XmlAttribute symbol = element.Attributes["KeySymbol"];
XmlAttribute x = element.Attributes["X"];
XmlAttribute y = element.Attributes["Y"];
XmlAttribute width = element.Attributes["Width"];
XmlAttribute height = element.Attributes["Height"];
XmlAttribute sticky = element.Attributes["Sticky"];
if (symbol == null || x == null || y == null || width == null || height == null || sticky == null)
{
throw new ArgumentException("Element does not contain expected attributes");
}
return new KeyboardKey()
{
KeySymbol = symbol.Value,
X = Convert.ToInt32(x.Value),
Y = Convert.ToInt32(y.Value),
Width = Convert.ToInt32(width.Value),
Height = Convert.ToInt32(height.Value),
Sticky = Convert.ToBoolean(sticky.Value)
};
}
#endregion
}
}
|
