--- a/eric6/Documentation/Source/eric6.WebBrowser.SpeedDial.SpeedDialWriter.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.SpeedDial.SpeedDialWriter.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,106 +18,138 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.SpeedDial.SpeedDialWriter</h1> + <p> Module implementing a class to write speed dial data files. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SpeedDialWriter">SpeedDialWriter</a></td> <td>Class implementing a writer object to generate speed dial data files.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SpeedDialWriter" ID="SpeedDialWriter"></a> <h2>SpeedDialWriter</h2> + <p> Class implementing a writer object to generate speed dial data files. </p> <h3>Derived from</h3> QXmlStreamWriter <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="#SpeedDialWriter.__init__">SpeedDialWriter</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SpeedDialWriter.__write">__write</a></td> <td>Private method to write a speed dial file.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SpeedDialWriter.write">write</a></td> <td>Public method to write a speed dial data file.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SpeedDialWriter.__init__" ID="SpeedDialWriter.__init__"></a> <h4>SpeedDialWriter (Constructor)</h4> <b>SpeedDialWriter</b>(<i></i>) + <p> Constructor -</p><a NAME="SpeedDialWriter.__write" ID="SpeedDialWriter.__write"></a> +</p> +<a NAME="SpeedDialWriter.__write" ID="SpeedDialWriter.__write"></a> <h4>SpeedDialWriter.__write</h4> <b>__write</b>(<i>pages, pagesPerRow, speedDialSize</i>) + <p> Private method to write a speed dial file. -</p><dl> +</p> +<dl> + <dt><i>pages</i></dt> <dd> list of speed dial pages (list of Page) -</dd><dt><i>pagesPerRow</i></dt> +</dd> +<dt><i>pagesPerRow</i></dt> <dd> number of pages per row (integer) -</dd><dt><i>speedDialSize</i></dt> +</dd> +<dt><i>speedDialSize</i></dt> <dd> size of the speed dial pages (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean) </dd> -</dl><a NAME="SpeedDialWriter.write" ID="SpeedDialWriter.write"></a> +</dl> +<a NAME="SpeedDialWriter.write" ID="SpeedDialWriter.write"></a> <h4>SpeedDialWriter.write</h4> <b>write</b>(<i>fileNameOrDevice, pages, pagesPerRow, speedDialSize</i>) + <p> Public method to write a speed dial data file. -</p><dl> +</p> +<dl> + <dt><i>fileNameOrDevice</i></dt> <dd> name of the file to write (string) or device to write to (QIODevice) -</dd><dt><i>pages</i></dt> +</dd> +<dt><i>pages</i></dt> <dd> list of speed dial pages (list of Page) -</dd><dt><i>pagesPerRow</i></dt> +</dd> +<dt><i>pagesPerRow</i></dt> <dd> number of pages per row (integer) -</dd><dt><i>speedDialSize</i></dt> +</dd> +<dt><i>speedDialSize</i></dt> <dd> size of the speed dial pages (integer) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean)