|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Helpviewer.Bookmarks.XbelWriter</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Helpviewer.Bookmarks.XbelWriter</h1> |
|
12 <p> |
|
13 Module implementing a class to write XBEL bookmark files. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#XbelWriter">XbelWriter</a></td> |
|
23 <td>Class implementing a writer object to generate XBEL bookmark files.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="XbelWriter" ID="XbelWriter"></a> |
|
32 <h2>XbelWriter</h2> |
|
33 <p> |
|
34 Class implementing a writer object to generate XBEL bookmark files. |
|
35 </p> |
|
36 <h3>Derived from</h3> |
|
37 QXmlStreamWriter |
|
38 <h3>Class Attributes</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <h3>Methods</h3> |
|
43 <table> |
|
44 <tr> |
|
45 <td><a href="#XbelWriter.__init__">XbelWriter</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#XbelWriter.__write">__write</a></td> |
|
49 <td>Private method to write an XBEL bookmark file.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#XbelWriter.__writeItem">__writeItem</a></td> |
|
52 <td>Private method to write an entry for a node.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#XbelWriter.write">write</a></td> |
|
55 <td>Public method to write an XBEL bookmark file.</td> |
|
56 </tr> |
|
57 </table> |
|
58 <a NAME="XbelWriter.__init__" ID="XbelWriter.__init__"></a> |
|
59 <h4>XbelWriter (Constructor)</h4> |
|
60 <b>XbelWriter</b>(<i></i>) |
|
61 <p> |
|
62 Constructor |
|
63 </p><a NAME="XbelWriter.__write" ID="XbelWriter.__write"></a> |
|
64 <h4>XbelWriter.__write</h4> |
|
65 <b>__write</b>(<i>root</i>) |
|
66 <p> |
|
67 Private method to write an XBEL bookmark file. |
|
68 </p><dl> |
|
69 <dt><i>root</i></dt> |
|
70 <dd> |
|
71 root node of the bookmark tree (BookmarkNode) |
|
72 </dd> |
|
73 </dl><a NAME="XbelWriter.__writeItem" ID="XbelWriter.__writeItem"></a> |
|
74 <h4>XbelWriter.__writeItem</h4> |
|
75 <b>__writeItem</b>(<i>node</i>) |
|
76 <p> |
|
77 Private method to write an entry for a node. |
|
78 </p><dl> |
|
79 <dt><i>node</i></dt> |
|
80 <dd> |
|
81 reference to the node to be written (BookmarkNode) |
|
82 </dd> |
|
83 </dl><a NAME="XbelWriter.write" ID="XbelWriter.write"></a> |
|
84 <h4>XbelWriter.write</h4> |
|
85 <b>write</b>(<i>fileNameOrDevice, root</i>) |
|
86 <p> |
|
87 Public method to write an XBEL bookmark file. |
|
88 </p><dl> |
|
89 <dt><i>fileNameOrDevice</i></dt> |
|
90 <dd> |
|
91 name of the file to write (string) |
|
92 or device to write to (QIODevice) |
|
93 </dd><dt><i>root</i></dt> |
|
94 <dd> |
|
95 root node of the bookmark tree (BookmarkNode) |
|
96 </dd> |
|
97 </dl> |
|
98 <div align="right"><a href="#top">Up</a></div> |
|
99 <hr /> |
|
100 </body></html> |