|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.Bookmarks.BookmarkNode</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.WebBrowser.Bookmarks.BookmarkNode</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the bookmark node. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#BookmarkNode">BookmarkNode</a></td> |
|
25 <td>Class implementing the bookmark node type.</td> |
|
26 </tr> |
|
27 </table> |
|
28 <h3>Functions</h3> |
|
29 |
|
30 <table> |
|
31 <tr><td>None</td></tr> |
|
32 </table> |
|
33 <hr /> |
|
34 <hr /> |
|
35 <a NAME="BookmarkNode" ID="BookmarkNode"></a> |
|
36 <h2>BookmarkNode</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing the bookmark node type. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 None |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>Bookmark</td></tr><tr><td>Folder</td></tr><tr><td>Root</td></tr><tr><td>Separator</td></tr><tr><td>TsAdded</td></tr><tr><td>TsModified</td></tr><tr><td>TsVisited</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#BookmarkNode.__init__">BookmarkNode</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#BookmarkNode.add">add</a></td> |
|
63 <td>Public method to add/insert a child node.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#BookmarkNode.children">children</a></td> |
|
67 <td>Public method to get the list of child nodes.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#BookmarkNode.parent">parent</a></td> |
|
71 <td>Public method to get a reference to the parent node.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#BookmarkNode.remove">remove</a></td> |
|
75 <td>Public method to remove a child node.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#BookmarkNode.setType">setType</a></td> |
|
79 <td>Public method to set the bookmark's type.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#BookmarkNode.type">type</a></td> |
|
83 <td>Public method to get the bookmark's type.</td> |
|
84 </tr> |
|
85 </table> |
|
86 <h3>Static Methods</h3> |
|
87 |
|
88 <table> |
|
89 <tr><td>None</td></tr> |
|
90 </table> |
|
91 |
|
92 <a NAME="BookmarkNode.__init__" ID="BookmarkNode.__init__"></a> |
|
93 <h4>BookmarkNode (Constructor)</h4> |
|
94 <b>BookmarkNode</b>(<i>type_=Root, parent=None</i>) |
|
95 |
|
96 <p> |
|
97 Constructor |
|
98 </p> |
|
99 <dl> |
|
100 |
|
101 <dt><i>type_</i></dt> |
|
102 <dd> |
|
103 type of the bookmark node (BookmarkNode.Type) |
|
104 </dd> |
|
105 <dt><i>parent</i></dt> |
|
106 <dd> |
|
107 reference to the parent node (BookmarkNode) |
|
108 </dd> |
|
109 </dl> |
|
110 <a NAME="BookmarkNode.add" ID="BookmarkNode.add"></a> |
|
111 <h4>BookmarkNode.add</h4> |
|
112 <b>add</b>(<i>child, offset=-1</i>) |
|
113 |
|
114 <p> |
|
115 Public method to add/insert a child node. |
|
116 </p> |
|
117 <dl> |
|
118 |
|
119 <dt><i>child</i></dt> |
|
120 <dd> |
|
121 reference to the node to add (BookmarkNode) |
|
122 </dd> |
|
123 <dt><i>offset</i></dt> |
|
124 <dd> |
|
125 position where to insert child (integer, -1 = append) |
|
126 </dd> |
|
127 </dl> |
|
128 <a NAME="BookmarkNode.children" ID="BookmarkNode.children"></a> |
|
129 <h4>BookmarkNode.children</h4> |
|
130 <b>children</b>(<i></i>) |
|
131 |
|
132 <p> |
|
133 Public method to get the list of child nodes. |
|
134 </p> |
|
135 <dl> |
|
136 <dt>Return:</dt> |
|
137 <dd> |
|
138 list of all child nodes (list of BookmarkNode) |
|
139 </dd> |
|
140 </dl> |
|
141 <a NAME="BookmarkNode.parent" ID="BookmarkNode.parent"></a> |
|
142 <h4>BookmarkNode.parent</h4> |
|
143 <b>parent</b>(<i></i>) |
|
144 |
|
145 <p> |
|
146 Public method to get a reference to the parent node. |
|
147 </p> |
|
148 <dl> |
|
149 <dt>Return:</dt> |
|
150 <dd> |
|
151 reference to the parent node (BookmarkNode) |
|
152 </dd> |
|
153 </dl> |
|
154 <a NAME="BookmarkNode.remove" ID="BookmarkNode.remove"></a> |
|
155 <h4>BookmarkNode.remove</h4> |
|
156 <b>remove</b>(<i>child</i>) |
|
157 |
|
158 <p> |
|
159 Public method to remove a child node. |
|
160 </p> |
|
161 <dl> |
|
162 |
|
163 <dt><i>child</i></dt> |
|
164 <dd> |
|
165 reference to the child node (BookmarkNode) |
|
166 </dd> |
|
167 </dl> |
|
168 <a NAME="BookmarkNode.setType" ID="BookmarkNode.setType"></a> |
|
169 <h4>BookmarkNode.setType</h4> |
|
170 <b>setType</b>(<i>type_</i>) |
|
171 |
|
172 <p> |
|
173 Public method to set the bookmark's type. |
|
174 </p> |
|
175 <dl> |
|
176 |
|
177 <dt><i>type_</i></dt> |
|
178 <dd> |
|
179 type of the bookmark node (BookmarkNode.Type) |
|
180 </dd> |
|
181 </dl> |
|
182 <a NAME="BookmarkNode.type" ID="BookmarkNode.type"></a> |
|
183 <h4>BookmarkNode.type</h4> |
|
184 <b>type</b>(<i></i>) |
|
185 |
|
186 <p> |
|
187 Public method to get the bookmark's type. |
|
188 </p> |
|
189 <dl> |
|
190 <dt>Return:</dt> |
|
191 <dd> |
|
192 bookmark type (BookmarkNode.Type) |
|
193 </dd> |
|
194 </dl> |
|
195 <div align="right"><a href="#top">Up</a></div> |
|
196 <hr /> |
|
197 </body></html> |