Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.E5XML.ShortcutsReader.html
Documentation/Source/eric5.E5XML.ShortcutsReader.html
- changeset 603
- 7f620c649182
- child 1228
- 7afaf2fca55b
- child 1278
- fb0460fd00b9
equal
deleted
inserted
replaced
| 602:2f32aef5cc67 | 603:7f620c649182 |
|---|---|
| 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.ShortcutsReader</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.E5XML.ShortcutsReader</h1> | |
| 24 <p> | |
| 25 Module implementing a class for reading an XML 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="#ShortcutsReader">ShortcutsReader</a></td> | |
| 35 <td>Class for reading an XML 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="ShortcutsReader" ID="ShortcutsReader"></a> | |
| 44 <h2>ShortcutsReader</h2> | |
| 45 <p> | |
| 46 Class for reading an XML shortcuts file. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 XMLStreamReaderBase | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>supportedVersions</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ShortcutsReader.__readShortCut">__readShortCut</a></td> | |
| 61 <td>Private method to read the shortcut data.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ShortcutsReader.getShortcuts">getShortcuts</a></td> | |
| 64 <td>Public method to retrieve the shortcuts.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ShortcutsReader.readXML">readXML</a></td> | |
| 67 <td>Public method to read and parse the XML document.</td> | |
| 68 </tr> | |
| 69 </table> | |
| 70 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> | |
| 71 <h4>ShortcutsReader (Constructor)</h4> | |
| 72 <b>ShortcutsReader</b>(<i>device</i>) | |
| 73 <p> | |
| 74 Constructor | |
| 75 </p><dl> | |
| 76 <dt><i>device</i></dt> | |
| 77 <dd> | |
| 78 reference to the I/O device to read from (QIODevice) | |
| 79 </dd> | |
| 80 </dl><a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> | |
| 81 <h4>ShortcutsReader.__readShortCut</h4> | |
| 82 <b>__readShortCut</b>(<i></i>) | |
| 83 <p> | |
| 84 Private method to read the shortcut data. | |
| 85 </p><a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> | |
| 86 <h4>ShortcutsReader.getShortcuts</h4> | |
| 87 <b>getShortcuts</b>(<i></i>) | |
| 88 <p> | |
| 89 Public method to retrieve the shortcuts. | |
| 90 </p><dl> | |
| 91 <dt>Returns:</dt> | |
| 92 <dd> | |
| 93 Dictionary of dictionaries of shortcuts. The keys of the | |
| 94 dictionary are the categories, the values are dictionaries. | |
| 95 These dictionaries have the shortcut name as their key and | |
| 96 a tuple of accelerators as their value. | |
| 97 </dd> | |
| 98 </dl><a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> | |
| 99 <h4>ShortcutsReader.readXML</h4> | |
| 100 <b>readXML</b>(<i></i>) | |
| 101 <p> | |
| 102 Public method to read and parse the XML document. | |
| 103 </p> | |
| 104 <div align="right"><a href="#top">Up</a></div> | |
| 105 <hr /> | |
| 106 </body></html> |
