Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.E5XML.ShortcutsReader.html
eric6/Documentation/Source/eric6.E5XML.ShortcutsReader.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.E5XML.ShortcutsReader</h1> | 23 <h1>eric6.E5XML.ShortcutsReader</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a class for reading an XML shortcuts file. | 26 Module implementing a class for reading an XML shortcuts file. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#ShortcutsReader">ShortcutsReader</a></td> | 38 <td><a href="#ShortcutsReader">ShortcutsReader</a></td> |
| 34 <td>Class for reading an XML shortcuts file.</td> | 39 <td>Class for reading an XML shortcuts file.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="ShortcutsReader" ID="ShortcutsReader"></a> | 49 <a NAME="ShortcutsReader" ID="ShortcutsReader"></a> |
| 43 <h2>ShortcutsReader</h2> | 50 <h2>ShortcutsReader</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class for reading an XML shortcuts file. | 53 Class for reading an XML shortcuts file. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 XMLStreamReaderBase | 56 XMLStreamReaderBase |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>supportedVersions</td></tr> | 60 <tr><td>supportedVersions</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> | 72 <td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#ShortcutsReader.__readShortCut">__readShortCut</a></td> | 76 <td><a href="#ShortcutsReader.__readShortCut">__readShortCut</a></td> |
| 64 <td>Private method to read the shortcut data.</td> | 77 <td>Private method to read the shortcut data.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#ShortcutsReader.getShortcuts">getShortcuts</a></td> | 80 <td><a href="#ShortcutsReader.getShortcuts">getShortcuts</a></td> |
| 67 <td>Public method to retrieve the shortcuts.</td> | 81 <td>Public method to retrieve the shortcuts.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#ShortcutsReader.readXML">readXML</a></td> | 84 <td><a href="#ShortcutsReader.readXML">readXML</a></td> |
| 70 <td>Public method to read and parse the XML document.</td> | 85 <td>Public method to read and parse the XML document.</td> |
| 71 </tr> | 86 </tr> |
| 72 </table> | 87 </table> |
| 73 <h3>Static Methods</h3> | 88 <h3>Static Methods</h3> |
| 89 | |
| 74 <table> | 90 <table> |
| 75 <tr><td>None</td></tr> | 91 <tr><td>None</td></tr> |
| 76 </table> | 92 </table> |
| 93 | |
| 77 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> | 94 <a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a> |
| 78 <h4>ShortcutsReader (Constructor)</h4> | 95 <h4>ShortcutsReader (Constructor)</h4> |
| 79 <b>ShortcutsReader</b>(<i>device</i>) | 96 <b>ShortcutsReader</b>(<i>device</i>) |
| 97 | |
| 80 <p> | 98 <p> |
| 81 Constructor | 99 Constructor |
| 82 </p><dl> | 100 </p> |
| 101 <dl> | |
| 102 | |
| 83 <dt><i>device</i></dt> | 103 <dt><i>device</i></dt> |
| 84 <dd> | 104 <dd> |
| 85 reference to the I/O device to read from (QIODevice) | 105 reference to the I/O device to read from (QIODevice) |
| 86 </dd> | 106 </dd> |
| 87 </dl><a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> | 107 </dl> |
| 108 <a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a> | |
| 88 <h4>ShortcutsReader.__readShortCut</h4> | 109 <h4>ShortcutsReader.__readShortCut</h4> |
| 89 <b>__readShortCut</b>(<i></i>) | 110 <b>__readShortCut</b>(<i></i>) |
| 111 | |
| 90 <p> | 112 <p> |
| 91 Private method to read the shortcut data. | 113 Private method to read the shortcut data. |
| 92 </p><a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> | 114 </p> |
| 115 <a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a> | |
| 93 <h4>ShortcutsReader.getShortcuts</h4> | 116 <h4>ShortcutsReader.getShortcuts</h4> |
| 94 <b>getShortcuts</b>(<i></i>) | 117 <b>getShortcuts</b>(<i></i>) |
| 118 | |
| 95 <p> | 119 <p> |
| 96 Public method to retrieve the shortcuts. | 120 Public method to retrieve the shortcuts. |
| 97 </p><dl> | 121 </p> |
| 122 <dl> | |
| 98 <dt>Returns:</dt> | 123 <dt>Returns:</dt> |
| 99 <dd> | 124 <dd> |
| 100 Dictionary of dictionaries of shortcuts. The keys of the | 125 Dictionary of dictionaries of shortcuts. The keys of the |
| 101 dictionary are the categories, the values are dictionaries. | 126 dictionary are the categories, the values are dictionaries. |
| 102 These dictionaries have the shortcut name as their key and | 127 These dictionaries have the shortcut name as their key and |
| 103 a tuple of accelerators as their value. | 128 a tuple of accelerators as their value. |
| 104 </dd> | 129 </dd> |
| 105 </dl><a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> | 130 </dl> |
| 131 <a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a> | |
| 106 <h4>ShortcutsReader.readXML</h4> | 132 <h4>ShortcutsReader.readXML</h4> |
| 107 <b>readXML</b>(<i></i>) | 133 <b>readXML</b>(<i></i>) |
| 134 | |
| 108 <p> | 135 <p> |
| 109 Public method to read and parse the XML document. | 136 Public method to read and parse the XML document. |
| 110 </p> | 137 </p> |
| 111 <div align="right"><a href="#top">Up</a></div> | 138 <div align="right"><a href="#top">Up</a></div> |
| 112 <hr /> | 139 <hr /> |
