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 10479
- 856476537696
- parent 10423
- 299802979277
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.EricXML.ShortcutsReader</h1> | 9 <h1>eric7.EricXML.ShortcutsReader</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a class for reading an XML shortcuts file. | 11 Module implementing a class for reading an XML shortcuts file. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | |
| 16 <table> | 15 <table> |
| 17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
| 18 </table> | 17 </table> |
| 18 | |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | |
| 21 <table> | 20 <table> |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#ShortcutsReader">ShortcutsReader</a></td> | 22 <td><a href="#ShortcutsReader">ShortcutsReader</a></td> |
| 25 <td>Class for reading an XML shortcuts file.</td> | 23 <td>Class for reading an XML shortcuts file.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | |
| 30 <table> | 28 <table> |
| 31 <tr><td>None</td></tr> | 29 <tr><td>None</td></tr> |
| 32 </table> | 30 </table> |
| 31 | |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="ShortcutsReader" ID="ShortcutsReader"></a> | 34 <a NAME="ShortcutsReader" ID="ShortcutsReader"></a> |
| 36 <h2>ShortcutsReader</h2> | 35 <h2>ShortcutsReader</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class for reading an XML shortcuts file. | 37 Class for reading an XML shortcuts file. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 XMLStreamReaderBase | 41 XMLStreamReaderBase |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | |
| 45 <table> | 43 <table> |
| 46 <tr><td>supportedVersions</td></tr> | 44 <tr><td>supportedVersions</td></tr> |
| 47 </table> | 45 </table> |
| 46 | |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | |
| 50 <table> | 48 <table> |
| 51 <tr><td>None</td></tr> | 49 <tr><td>None</td></tr> |
| 52 </table> | 50 </table> |
| 51 | |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | |
| 55 <table> | 53 <table> |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> | 55 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 69 <tr> | 66 <tr> |
| 70 <td><a href="#ShortcutsReader.readXML">readXML</a></td> | 67 <td><a href="#ShortcutsReader.readXML">readXML</a></td> |
| 71 <td>Public method to read and parse the XML document.</td> | 68 <td>Public method to read and parse the XML document.</td> |
| 72 </tr> | 69 </tr> |
| 73 </table> | 70 </table> |
| 71 | |
| 74 <h3>Static Methods</h3> | 72 <h3>Static Methods</h3> |
| 75 | |
| 76 <table> | 73 <table> |
| 77 <tr><td>None</td></tr> | 74 <tr><td>None</td></tr> |
| 78 </table> | 75 </table> |
| 79 | 76 |
| 77 | |
| 80 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> | 78 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> |
| 81 <h4>ShortcutsReader (Constructor)</h4> | 79 <h4>ShortcutsReader (Constructor)</h4> |
| 82 <b>ShortcutsReader</b>(<i>device</i>) | 80 <b>ShortcutsReader</b>(<i>device</i>) |
| 83 | |
| 84 <p> | 81 <p> |
| 85 Constructor | 82 Constructor |
| 86 </p> | 83 </p> |
| 84 | |
| 87 <dl> | 85 <dl> |
| 88 | 86 |
| 89 <dt><i>device</i> (QIODevice)</dt> | 87 <dt><i>device</i> (QIODevice)</dt> |
| 90 <dd> | 88 <dd> |
| 91 reference to the I/O device to read from | 89 reference to the I/O device to read from |
| 92 </dd> | 90 </dd> |
| 93 </dl> | 91 </dl> |
| 94 <a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> | 92 <a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> |
| 95 <h4>ShortcutsReader.__readShortCut</h4> | 93 <h4>ShortcutsReader.__readShortCut</h4> |
| 96 <b>__readShortCut</b>(<i></i>) | 94 <b>__readShortCut</b>(<i></i>) |
| 97 | |
| 98 <p> | 95 <p> |
| 99 Private method to read the shortcut data. | 96 Private method to read the shortcut data. |
| 100 </p> | 97 </p> |
| 98 | |
| 101 <a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> | 99 <a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> |
| 102 <h4>ShortcutsReader.getShortcuts</h4> | 100 <h4>ShortcutsReader.getShortcuts</h4> |
| 103 <b>getShortcuts</b>(<i></i>) | 101 <b>getShortcuts</b>(<i></i>) |
| 104 | |
| 105 <p> | 102 <p> |
| 106 Public method to retrieve the shortcuts. | 103 Public method to retrieve the shortcuts. |
| 107 </p> | 104 </p> |
| 105 | |
| 108 <dl> | 106 <dl> |
| 109 <dt>Return:</dt> | 107 <dt>Return:</dt> |
| 110 <dd> | 108 <dd> |
| 111 Dictionary of dictionaries of shortcuts. The keys of the | 109 Dictionary of dictionaries of shortcuts. The keys of the |
| 112 dictionary are the categories, the values are dictionaries. | 110 dictionary are the categories, the values are dictionaries. |
| 121 </dd> | 119 </dd> |
| 122 </dl> | 120 </dl> |
| 123 <a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> | 121 <a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> |
| 124 <h4>ShortcutsReader.readXML</h4> | 122 <h4>ShortcutsReader.readXML</h4> |
| 125 <b>readXML</b>(<i></i>) | 123 <b>readXML</b>(<i></i>) |
| 126 | |
| 127 <p> | 124 <p> |
| 128 Public method to read and parse the XML document. | 125 Public method to read and parse the XML document. |
| 129 </p> | 126 </p> |
| 127 | |
| 130 <div align="right"><a href="#top">Up</a></div> | 128 <div align="right"><a href="#top">Up</a></div> |
| 131 <hr /> | 129 <hr /> |
| 132 </body></html> | 130 </body></html> |
