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