src/eric7/Documentation/Source/eric7.EricXML.ShortcutsReader.html

<!DOCTYPE html>
<html><head>
<title>eric7.EricXML.ShortcutsReader</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricXML.ShortcutsReader</h1>

<p>
Module implementing a class for reading an XML shortcuts file.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#ShortcutsReader">ShortcutsReader</a></td>
<td>Class for reading an XML shortcuts file.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="ShortcutsReader" ID="ShortcutsReader"></a>
<h2>ShortcutsReader</h2>

<p>
    Class for reading an XML shortcuts file.
</p>
<h3>Derived from</h3>
XMLStreamReaderBase
<h3>Class Attributes</h3>

<table>
<tr><td>supportedVersions</td></tr>
</table>
<h3>Class Methods</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>

<table>

<tr>
<td><a href="#ShortcutsReader.__init__">ShortcutsReader</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ShortcutsReader.__readShortCut">__readShortCut</a></td>
<td>Private method to read the shortcut data.</td>
</tr>
<tr>
<td><a href="#ShortcutsReader.getShortcuts">getShortcuts</a></td>
<td>Public method to retrieve the shortcuts.</td>
</tr>
<tr>
<td><a href="#ShortcutsReader.readXML">readXML</a></td>
<td>Public method to read and parse the XML document.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="ShortcutsReader.__init__" ID="ShortcutsReader.__init__"></a>
<h4>ShortcutsReader (Constructor)</h4>
<b>ShortcutsReader</b>(<i>device</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>device</i></dt>
<dd>
reference to the I/O device to read from (QIODevice)
</dd>
</dl>
<a NAME="ShortcutsReader.__readShortCut" ID="ShortcutsReader.__readShortCut"></a>
<h4>ShortcutsReader.__readShortCut</h4>
<b>__readShortCut</b>(<i></i>)

<p>
        Private method to read the shortcut data.
</p>
<a NAME="ShortcutsReader.getShortcuts" ID="ShortcutsReader.getShortcuts"></a>
<h4>ShortcutsReader.getShortcuts</h4>
<b>getShortcuts</b>(<i></i>)

<p>
        Public method to retrieve the shortcuts.
</p>
<dl>
<dt>Return:</dt>
<dd>
Dictionary of dictionaries of shortcuts. The keys of the
            dictionary are the categories, the values are dictionaries.
            These dictionaries have the shortcut name as their key and
            a tuple of accelerators as their value.
</dd>
</dl>
<a NAME="ShortcutsReader.readXML" ID="ShortcutsReader.readXML"></a>
<h4>ShortcutsReader.readXML</h4>
<b>readXML</b>(<i></i>)

<p>
        Public method to read and parse the XML document.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>