Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricXML.ShortcutsReader.html
src/eric7/Documentation/Source/eric7.EricXML.ShortcutsReader.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricXML.ShortcutsReader</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.EricXML.ShortcutsReader</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a class for reading an XML shortcuts file. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#ShortcutsReader">ShortcutsReader</a></td> | |
| 25 <td>Class for reading an XML shortcuts file.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="ShortcutsReader" ID="ShortcutsReader"></a> | |
| 36 <h2>ShortcutsReader</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class for reading an XML shortcuts file. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 XMLStreamReaderBase | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>supportedVersions</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#ShortcutsReader.__readShortCut">__readShortCut</a></td> | |
| 63 <td>Private method to read the shortcut data.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#ShortcutsReader.getShortcuts">getShortcuts</a></td> | |
| 67 <td>Public method to retrieve the shortcuts.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#ShortcutsReader.readXML">readXML</a></td> | |
| 71 <td>Public method to read and parse the XML document.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> | |
| 81 <h4>ShortcutsReader (Constructor)</h4> | |
| 82 <b>ShortcutsReader</b>(<i>device</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>device</i></dt> | |
| 90 <dd> | |
| 91 reference to the I/O device to read from (QIODevice) | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> | |
| 95 <h4>ShortcutsReader.__readShortCut</h4> | |
| 96 <b>__readShortCut</b>(<i></i>) | |
| 97 | |
| 98 <p> | |
| 99 Private method to read the shortcut data. | |
| 100 </p> | |
| 101 <a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> | |
| 102 <h4>ShortcutsReader.getShortcuts</h4> | |
| 103 <b>getShortcuts</b>(<i></i>) | |
| 104 | |
| 105 <p> | |
| 106 Public method to retrieve the shortcuts. | |
| 107 </p> | |
| 108 <dl> | |
| 109 <dt>Return:</dt> | |
| 110 <dd> | |
| 111 Dictionary of dictionaries of shortcuts. The keys of the | |
| 112 dictionary are the categories, the values are dictionaries. | |
| 113 These dictionaries have the shortcut name as their key and | |
| 114 a tuple of accelerators as their value. | |
| 115 </dd> | |
| 116 </dl> | |
| 117 <a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> | |
| 118 <h4>ShortcutsReader.readXML</h4> | |
| 119 <b>readXML</b>(<i></i>) | |
| 120 | |
| 121 <p> | |
| 122 Public method to read and parse the XML document. | |
| 123 </p> | |
| 124 <div align="right"><a href="#top">Up</a></div> | |
| 125 <hr /> | |
| 126 </body></html> |
