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