|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E4XML.ShortcutsHandler</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.E4XML.ShortcutsHandler</h1> |
|
12 <p> |
|
13 Module implementing the handler class for reading a keyboard shortcuts file. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#ShortcutsHandler">ShortcutsHandler</a></td> |
|
23 <td>Class implementing a sax handler to read a keyboard shortcuts file.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="ShortcutsHandler" ID="ShortcutsHandler"></a> |
|
32 <h2>ShortcutsHandler</h2> |
|
33 <p> |
|
34 Class implementing a sax handler to read a keyboard shortcuts file. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 XMLHandlerBase |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#ShortcutsHandler.__init__">ShortcutsHandler</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#ShortcutsHandler.endAccel">endAccel</a></td> |
|
49 <td>Handler method for the "Accel" end tag.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#ShortcutsHandler.endAltAccel">endAltAccel</a></td> |
|
52 <td>Handler method for the "AltAccel" end tag.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#ShortcutsHandler.endName">endName</a></td> |
|
55 <td>Handler method for the "Name" end tag.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#ShortcutsHandler.endShortcut">endShortcut</a></td> |
|
58 <td>Handler method for the "Shortcut" end tag.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#ShortcutsHandler.getShortcuts">getShortcuts</a></td> |
|
61 <td>Public method to retrieve the shortcuts.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ShortcutsHandler.getVersion">getVersion</a></td> |
|
64 <td>Public method to retrieve the version of the shortcuts.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#ShortcutsHandler.startDocumentShortcuts">startDocumentShortcuts</a></td> |
|
67 <td>Handler called, when the document parsing is started.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#ShortcutsHandler.startShortcut">startShortcut</a></td> |
|
70 <td>Handler method for the "Shortcut" start tag.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#ShortcutsHandler.startShortcuts">startShortcuts</a></td> |
|
73 <td>Handler method for the "Shortcuts" start tag.</td> |
|
74 </tr> |
|
75 </table> |
|
76 <a NAME="ShortcutsHandler.__init__" ID="ShortcutsHandler.__init__"></a> |
|
77 <h4>ShortcutsHandler (Constructor)</h4> |
|
78 <b>ShortcutsHandler</b>(<i></i>) |
|
79 <p> |
|
80 Constructor |
|
81 </p><a NAME="ShortcutsHandler.endAccel" ID="ShortcutsHandler.endAccel"></a> |
|
82 <h4>ShortcutsHandler.endAccel</h4> |
|
83 <b>endAccel</b>(<i></i>) |
|
84 <p> |
|
85 Handler method for the "Accel" end tag. |
|
86 </p><a NAME="ShortcutsHandler.endAltAccel" ID="ShortcutsHandler.endAltAccel"></a> |
|
87 <h4>ShortcutsHandler.endAltAccel</h4> |
|
88 <b>endAltAccel</b>(<i></i>) |
|
89 <p> |
|
90 Handler method for the "AltAccel" end tag. |
|
91 </p><a NAME="ShortcutsHandler.endName" ID="ShortcutsHandler.endName"></a> |
|
92 <h4>ShortcutsHandler.endName</h4> |
|
93 <b>endName</b>(<i></i>) |
|
94 <p> |
|
95 Handler method for the "Name" end tag. |
|
96 </p><a NAME="ShortcutsHandler.endShortcut" ID="ShortcutsHandler.endShortcut"></a> |
|
97 <h4>ShortcutsHandler.endShortcut</h4> |
|
98 <b>endShortcut</b>(<i></i>) |
|
99 <p> |
|
100 Handler method for the "Shortcut" end tag. |
|
101 </p><a NAME="ShortcutsHandler.getShortcuts" ID="ShortcutsHandler.getShortcuts"></a> |
|
102 <h4>ShortcutsHandler.getShortcuts</h4> |
|
103 <b>getShortcuts</b>(<i></i>) |
|
104 <p> |
|
105 Public method to retrieve the shortcuts. |
|
106 </p><dl> |
|
107 <dt>Returns:</dt> |
|
108 <dd> |
|
109 Dictionary of dictionaries of shortcuts. The keys of the |
|
110 dictionary are the categories, the values are dictionaries. |
|
111 These dictionaries have the shortcut name as their key and |
|
112 a tuple of accelerators as their value. |
|
113 </dd> |
|
114 </dl><a NAME="ShortcutsHandler.getVersion" ID="ShortcutsHandler.getVersion"></a> |
|
115 <h4>ShortcutsHandler.getVersion</h4> |
|
116 <b>getVersion</b>(<i></i>) |
|
117 <p> |
|
118 Public method to retrieve the version of the shortcuts. |
|
119 </p><dl> |
|
120 <dt>Returns:</dt> |
|
121 <dd> |
|
122 String containing the version number. |
|
123 </dd> |
|
124 </dl><a NAME="ShortcutsHandler.startDocumentShortcuts" ID="ShortcutsHandler.startDocumentShortcuts"></a> |
|
125 <h4>ShortcutsHandler.startDocumentShortcuts</h4> |
|
126 <b>startDocumentShortcuts</b>(<i></i>) |
|
127 <p> |
|
128 Handler called, when the document parsing is started. |
|
129 </p><a NAME="ShortcutsHandler.startShortcut" ID="ShortcutsHandler.startShortcut"></a> |
|
130 <h4>ShortcutsHandler.startShortcut</h4> |
|
131 <b>startShortcut</b>(<i>attrs</i>) |
|
132 <p> |
|
133 Handler method for the "Shortcut" start tag. |
|
134 </p><dl> |
|
135 <dt><i>attrs</i></dt> |
|
136 <dd> |
|
137 list of tag attributes |
|
138 </dd> |
|
139 </dl><a NAME="ShortcutsHandler.startShortcuts" ID="ShortcutsHandler.startShortcuts"></a> |
|
140 <h4>ShortcutsHandler.startShortcuts</h4> |
|
141 <b>startShortcuts</b>(<i>attrs</i>) |
|
142 <p> |
|
143 Handler method for the "Shortcuts" start tag. |
|
144 </p><dl> |
|
145 <dt><i>attrs</i></dt> |
|
146 <dd> |
|
147 list of tag attributes |
|
148 </dd> |
|
149 </dl> |
|
150 <div align="right"><a href="#top">Up</a></div> |
|
151 <hr /> |
|
152 </body></html> |