Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
diff -r 81326a94fdca -r 37f0444c3479 Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html
--- a/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Helpviewer.Bookmarks.XbelWriter.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Helpviewer.Bookmarks.XbelWriter</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#99;&#108;&#97;&#115;&#115; &#116;&#111; w&#114;&#105;&#116;&#101; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.
+Module implementing a class to write XBEL bookmark files.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#XbelWriter">XbelWriter</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#114;&#105;&#116;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.</td>
+<td>Class implementing a writer object to generate XBEL bookmark files.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,7 +43,7 @@
 <a NAME="XbelWriter" ID="XbelWriter"></a>
 <h2>XbelWriter</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; w&#114;&#105;&#116;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;&#115;.
+    Class implementing a writer object to generate XBEL bookmark files.
 </p>
 <h3>Derived from</h3>
 QXmlStreamWriter
@@ -55,56 +55,56 @@
 <table>
 <tr>
 <td><a href="#XbelWriter.__init__">XbelWriter</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#XbelWriter.__write">__write</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.</td>
+<td>Private method to write an XBEL bookmark file.</td>
 </tr><tr>
 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#101;&#110;&#116;&#114;y &#102;&#111;&#114; &#97; &#110;&#111;&#100;&#101;.</td>
+<td>Private method to write an entry for a node.</td>
 </tr><tr>
 <td><a href="#XbelWriter.write">write</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to write an XBEL bookmark file.</td>
 </tr>
 </table>
 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a>
 <h4>XbelWriter (Constructor)</h4>
 <b>XbelWriter</b>(<i></i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a>
 <h4>XbelWriter.__write</h4>
 <b>__write</b>(<i>root</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.
+        Private method to write an XBEL bookmark file.
 </p><dl>
 <dt><i>root</i></dt>
 <dd>
-&#114;&#111;&#111;&#116; &#110;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#101; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#116;&#114;&#101;&#101; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+root node of the bookmark tree (BookmarkNode)
 </dd>
 </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a>
 <h4>XbelWriter.__writeItem</h4>
 <b>__writeItem</b>(<i>node</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#101;&#110;&#116;&#114;y &#102;&#111;&#114; &#97; &#110;&#111;&#100;&#101;.
+        Private method to write an entry for a node.
 </p><dl>
 <dt><i>node</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#110;&#111;&#100;&#101; &#116;&#111; &#98;&#101; w&#114;&#105;&#116;&#116;&#101;&#110; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+reference to the node to be written (BookmarkNode)
 </dd>
 </dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a>
 <h4>XbelWriter.write</h4>
 <b>write</b>(<i>fileNameOrDevice, root</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; w&#114;&#105;&#116;&#101; &#97;&#110; &#88;&#66;&#69;&#76; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#102;&#105;&#108;&#101;.
+        Public method to write an XBEL bookmark file.
 </p><dl>
 <dt><i>fileNameOrDevice</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#116;&#111; w&#114;&#105;&#116;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
-            &#111;&#114; &#100;&#101;v&#105;&#99;&#101; &#116;&#111; w&#114;&#105;&#116;&#101; &#116;&#111; (&#81;&#73;&#79;&#68;&#101;v&#105;&#99;&#101;)
+name of the file to write (string)
+            or device to write to (QIODevice)
 </dd><dt><i>root</i></dt>
 <dd>
-&#114;&#111;&#111;&#116; &#110;&#111;&#100;&#101; &#111;&#102; &#116;&#104;&#101; &#98;&#111;&#111;&#107;&#109;&#97;&#114;&#107; &#116;&#114;&#101;&#101; (&#66;&#111;&#111;&#107;&#109;&#97;&#114;&#107;&#78;&#111;&#100;&#101;)
+root node of the bookmark tree (BookmarkNode)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial