diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.E5XML.ShortcutsWriter.html --- a/eric6/Documentation/Source/eric6.E5XML.ShortcutsWriter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.E5XML.ShortcutsWriter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,88 +18,116 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.E5XML.ShortcutsWriter</h1> + <p> Module implementing the writer class for writing an XML shortcuts file. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ShortcutsWriter">ShortcutsWriter</a></td> <td>Class implementing the writer class for writing an XML shortcuts file.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ShortcutsWriter" ID="ShortcutsWriter"></a> <h2>ShortcutsWriter</h2> + <p> Class implementing the writer class for writing an XML shortcuts file. </p> <h3>Derived from</h3> XMLStreamWriterBase <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#ShortcutsWriter.__init__">ShortcutsWriter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ShortcutsWriter.__writeActions">__writeActions</a></td> <td>Private method to write the shortcuts for the given actions.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ShortcutsWriter.writeXML">writeXML</a></td> <td>Public method to write the XML to the file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ShortcutsWriter.__init__" ID="ShortcutsWriter.__init__"></a> <h4>ShortcutsWriter (Constructor)</h4> <b>ShortcutsWriter</b>(<i>device</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>device</i></dt> <dd> reference to the I/O device to write to (QIODevice) </dd> -</dl><a NAME="ShortcutsWriter.__writeActions" ID="ShortcutsWriter.__writeActions"></a> +</dl> +<a NAME="ShortcutsWriter.__writeActions" ID="ShortcutsWriter.__writeActions"></a> <h4>ShortcutsWriter.__writeActions</h4> <b>__writeActions</b>(<i>category, actions</i>) + <p> Private method to write the shortcuts for the given actions. -</p><dl> +</p> +<dl> + <dt><i>category</i></dt> <dd> category the actions belong to (string) -</dd><dt><i>actions</i></dt> +</dd> +<dt><i>actions</i></dt> <dd> list of actions to write (E5Action) </dd> -</dl><a NAME="ShortcutsWriter.writeXML" ID="ShortcutsWriter.writeXML"></a> +</dl> +<a NAME="ShortcutsWriter.writeXML" ID="ShortcutsWriter.writeXML"></a> <h4>ShortcutsWriter.writeXML</h4> <b>writeXML</b>(<i>helpViewer=None</i>) + <p> Public method to write the XML to the file. -</p><dl> +</p> +<dl> + <dt><i>helpViewer</i></dt> <dd> reference to the help window object