src/eric7/Documentation/Source/eric7.WebBrowser.Bookmarks.BookmarkNode.html

branch
eric7
changeset 10493
f795d68d8e09
parent 10479
856476537696
equal deleted inserted replaced
10492:53eac4c7d10b 10493:f795d68d8e09
20 <table> 20 <table>
21 <tr> 21 <tr>
22 <td><a href="#BookmarkNode">BookmarkNode</a></td> 22 <td><a href="#BookmarkNode">BookmarkNode</a></td>
23 <td>Class implementing the bookmark node type.</td> 23 <td>Class implementing the bookmark node type.</td>
24 </tr> 24 </tr>
25 <tr>
26 <td><a href="#BookmarkNodeType">BookmarkNodeType</a></td>
27 <td>Class defining the bookmark node types.</td>
28 </tr>
29 <tr>
30 <td><a href="#BookmarkTimestampType">BookmarkTimestampType</a></td>
31 <td>Class defining the bookmark timestamp types.</td>
32 </tr>
25 </table> 33 </table>
26 34
27 <h3>Functions</h3> 35 <h3>Functions</h3>
28 <table> 36 <table>
29 <tr><td>None</td></tr> 37 <tr><td>None</td></tr>
37 Class implementing the bookmark node type. 45 Class implementing the bookmark node type.
38 </p> 46 </p>
39 47
40 <h3>Derived from</h3> 48 <h3>Derived from</h3>
41 None 49 None
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54
55 <h3>Class Methods</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#BookmarkNode.__init__">BookmarkNode</a></td>
64 <td>Constructor</td>
65 </tr>
66 <tr>
67 <td><a href="#BookmarkNode.add">add</a></td>
68 <td>Public method to add/insert a child node.</td>
69 </tr>
70 <tr>
71 <td><a href="#BookmarkNode.children">children</a></td>
72 <td>Public method to get the list of child nodes.</td>
73 </tr>
74 <tr>
75 <td><a href="#BookmarkNode.parent">parent</a></td>
76 <td>Public method to get a reference to the parent node.</td>
77 </tr>
78 <tr>
79 <td><a href="#BookmarkNode.remove">remove</a></td>
80 <td>Public method to remove a child node.</td>
81 </tr>
82 <tr>
83 <td><a href="#BookmarkNode.setType">setType</a></td>
84 <td>Public method to set the bookmark's type.</td>
85 </tr>
86 <tr>
87 <td><a href="#BookmarkNode.type">type</a></td>
88 <td>Public method to get the bookmark's type.</td>
89 </tr>
90 </table>
91
92 <h3>Static Methods</h3>
93 <table>
94 <tr><td>None</td></tr>
95 </table>
96
97
98 <a NAME="BookmarkNode.__init__" ID="BookmarkNode.__init__"></a>
99 <h4>BookmarkNode (Constructor)</h4>
100 <b>BookmarkNode</b>(<i>type_=BookmarkNodeType.Root, parent=None</i>)
101 <p>
102 Constructor
103 </p>
104
105 <dl>
106
107 <dt><i>type_</i> (BookmarkNode.Type)</dt>
108 <dd>
109 type of the bookmark node
110 </dd>
111 <dt><i>parent</i> (BookmarkNode)</dt>
112 <dd>
113 reference to the parent node
114 </dd>
115 </dl>
116 <a NAME="BookmarkNode.add" ID="BookmarkNode.add"></a>
117 <h4>BookmarkNode.add</h4>
118 <b>add</b>(<i>child, offset=-1</i>)
119 <p>
120 Public method to add/insert a child node.
121 </p>
122
123 <dl>
124
125 <dt><i>child</i> (BookmarkNode)</dt>
126 <dd>
127 reference to the node to add
128 </dd>
129 <dt><i>offset</i> (int)</dt>
130 <dd>
131 position where to insert child (-1 = append)
132 </dd>
133 </dl>
134 <a NAME="BookmarkNode.children" ID="BookmarkNode.children"></a>
135 <h4>BookmarkNode.children</h4>
136 <b>children</b>(<i></i>)
137 <p>
138 Public method to get the list of child nodes.
139 </p>
140
141 <dl>
142 <dt>Return:</dt>
143 <dd>
144 list of all child nodes
145 </dd>
146 </dl>
147 <dl>
148 <dt>Return Type:</dt>
149 <dd>
150 list of BookmarkNode
151 </dd>
152 </dl>
153 <a NAME="BookmarkNode.parent" ID="BookmarkNode.parent"></a>
154 <h4>BookmarkNode.parent</h4>
155 <b>parent</b>(<i></i>)
156 <p>
157 Public method to get a reference to the parent node.
158 </p>
159
160 <dl>
161 <dt>Return:</dt>
162 <dd>
163 reference to the parent node
164 </dd>
165 </dl>
166 <dl>
167 <dt>Return Type:</dt>
168 <dd>
169 BookmarkNode
170 </dd>
171 </dl>
172 <a NAME="BookmarkNode.remove" ID="BookmarkNode.remove"></a>
173 <h4>BookmarkNode.remove</h4>
174 <b>remove</b>(<i>child</i>)
175 <p>
176 Public method to remove a child node.
177 </p>
178
179 <dl>
180
181 <dt><i>child</i> (BookmarkNode)</dt>
182 <dd>
183 reference to the child node
184 </dd>
185 </dl>
186 <a NAME="BookmarkNode.setType" ID="BookmarkNode.setType"></a>
187 <h4>BookmarkNode.setType</h4>
188 <b>setType</b>(<i>type_</i>)
189 <p>
190 Public method to set the bookmark's type.
191 </p>
192
193 <dl>
194
195 <dt><i>type_</i> (BookmarkNode.Type)</dt>
196 <dd>
197 type of the bookmark node
198 </dd>
199 </dl>
200 <a NAME="BookmarkNode.type" ID="BookmarkNode.type"></a>
201 <h4>BookmarkNode.type</h4>
202 <b>type</b>(<i></i>)
203 <p>
204 Public method to get the bookmark's type.
205 </p>
206
207 <dl>
208 <dt>Return:</dt>
209 <dd>
210 bookmark type
211 </dd>
212 </dl>
213 <dl>
214 <dt>Return Type:</dt>
215 <dd>
216 BookmarkNode.Type
217 </dd>
218 </dl>
219 <div align="right"><a href="#top">Up</a></div>
220 <hr />
221 <hr />
222 <a NAME="BookmarkNodeType" ID="BookmarkNodeType"></a>
223 <h2>BookmarkNodeType</h2>
224 <p>
225 Class defining the bookmark node types.
226 </p>
227
228 <h3>Derived from</h3>
229 enum.Enum
42 <h3>Class Attributes</h3> 230 <h3>Class Attributes</h3>
43 <table> 231 <table>
44 <tr><td>Bookmark</td></tr> 232 <tr><td>Bookmark</td></tr>
45 <tr><td>Folder</td></tr> 233 <tr><td>Folder</td></tr>
46 <tr><td>Root</td></tr> 234 <tr><td>Root</td></tr>
47 <tr><td>Separator</td></tr> 235 <tr><td>Separator</td></tr>
48 <tr><td>TsAdded</td></tr>
49 <tr><td>TsModified</td></tr>
50 <tr><td>TsVisited</td></tr>
51 </table> 236 </table>
52 237
53 <h3>Class Methods</h3> 238 <h3>Class Methods</h3>
54 <table> 239 <table>
55 <tr><td>None</td></tr> 240 <tr><td>None</td></tr>
56 </table> 241 </table>
57 242
58 <h3>Methods</h3> 243 <h3>Methods</h3>
59 <table> 244 <table>
60 <tr> 245 <tr><td>None</td></tr>
61 <td><a href="#BookmarkNode.__init__">BookmarkNode</a></td>
62 <td>Constructor</td>
63 </tr>
64 <tr>
65 <td><a href="#BookmarkNode.add">add</a></td>
66 <td>Public method to add/insert a child node.</td>
67 </tr>
68 <tr>
69 <td><a href="#BookmarkNode.children">children</a></td>
70 <td>Public method to get the list of child nodes.</td>
71 </tr>
72 <tr>
73 <td><a href="#BookmarkNode.parent">parent</a></td>
74 <td>Public method to get a reference to the parent node.</td>
75 </tr>
76 <tr>
77 <td><a href="#BookmarkNode.remove">remove</a></td>
78 <td>Public method to remove a child node.</td>
79 </tr>
80 <tr>
81 <td><a href="#BookmarkNode.setType">setType</a></td>
82 <td>Public method to set the bookmark's type.</td>
83 </tr>
84 <tr>
85 <td><a href="#BookmarkNode.type">type</a></td>
86 <td>Public method to get the bookmark's type.</td>
87 </tr>
88 </table> 246 </table>
89 247
90 <h3>Static Methods</h3> 248 <h3>Static Methods</h3>
91 <table> 249 <table>
92 <tr><td>None</td></tr> 250 <tr><td>None</td></tr>
93 </table> 251 </table>
94 252
95 253
96 <a NAME="BookmarkNode.__init__" ID="BookmarkNode.__init__"></a>
97 <h4>BookmarkNode (Constructor)</h4>
98 <b>BookmarkNode</b>(<i>type_=Root, parent=None</i>)
99 <p>
100 Constructor
101 </p>
102
103 <dl>
104
105 <dt><i>type_</i> (BookmarkNode.Type)</dt>
106 <dd>
107 type of the bookmark node
108 </dd>
109 <dt><i>parent</i> (BookmarkNode)</dt>
110 <dd>
111 reference to the parent node
112 </dd>
113 </dl>
114 <a NAME="BookmarkNode.add" ID="BookmarkNode.add"></a>
115 <h4>BookmarkNode.add</h4>
116 <b>add</b>(<i>child, offset=-1</i>)
117 <p>
118 Public method to add/insert a child node.
119 </p>
120
121 <dl>
122
123 <dt><i>child</i> (BookmarkNode)</dt>
124 <dd>
125 reference to the node to add
126 </dd>
127 <dt><i>offset</i> (int)</dt>
128 <dd>
129 position where to insert child (-1 = append)
130 </dd>
131 </dl>
132 <a NAME="BookmarkNode.children" ID="BookmarkNode.children"></a>
133 <h4>BookmarkNode.children</h4>
134 <b>children</b>(<i></i>)
135 <p>
136 Public method to get the list of child nodes.
137 </p>
138
139 <dl>
140 <dt>Return:</dt>
141 <dd>
142 list of all child nodes
143 </dd>
144 </dl>
145 <dl>
146 <dt>Return Type:</dt>
147 <dd>
148 list of BookmarkNode
149 </dd>
150 </dl>
151 <a NAME="BookmarkNode.parent" ID="BookmarkNode.parent"></a>
152 <h4>BookmarkNode.parent</h4>
153 <b>parent</b>(<i></i>)
154 <p>
155 Public method to get a reference to the parent node.
156 </p>
157
158 <dl>
159 <dt>Return:</dt>
160 <dd>
161 reference to the parent node
162 </dd>
163 </dl>
164 <dl>
165 <dt>Return Type:</dt>
166 <dd>
167 BookmarkNode
168 </dd>
169 </dl>
170 <a NAME="BookmarkNode.remove" ID="BookmarkNode.remove"></a>
171 <h4>BookmarkNode.remove</h4>
172 <b>remove</b>(<i>child</i>)
173 <p>
174 Public method to remove a child node.
175 </p>
176
177 <dl>
178
179 <dt><i>child</i> (BookmarkNode)</dt>
180 <dd>
181 reference to the child node
182 </dd>
183 </dl>
184 <a NAME="BookmarkNode.setType" ID="BookmarkNode.setType"></a>
185 <h4>BookmarkNode.setType</h4>
186 <b>setType</b>(<i>type_</i>)
187 <p>
188 Public method to set the bookmark's type.
189 </p>
190
191 <dl>
192
193 <dt><i>type_</i> (BookmarkNode.Type)</dt>
194 <dd>
195 type of the bookmark node
196 </dd>
197 </dl>
198 <a NAME="BookmarkNode.type" ID="BookmarkNode.type"></a>
199 <h4>BookmarkNode.type</h4>
200 <b>type</b>(<i></i>)
201 <p>
202 Public method to get the bookmark's type.
203 </p>
204
205 <dl>
206 <dt>Return:</dt>
207 <dd>
208 bookmark type
209 </dd>
210 </dl>
211 <dl>
212 <dt>Return Type:</dt>
213 <dd>
214 BookmarkNode.Type
215 </dd>
216 </dl>
217 <div align="right"><a href="#top">Up</a></div> 254 <div align="right"><a href="#top">Up</a></div>
218 <hr /> 255 <hr />
256 <hr />
257 <a NAME="BookmarkTimestampType" ID="BookmarkTimestampType"></a>
258 <h2>BookmarkTimestampType</h2>
259 <p>
260 Class defining the bookmark timestamp types.
261 </p>
262
263 <h3>Derived from</h3>
264 enum.Enum
265 <h3>Class Attributes</h3>
266 <table>
267 <tr><td>Added</td></tr>
268 <tr><td>Modified</td></tr>
269 <tr><td>Visited</td></tr>
270 </table>
271
272 <h3>Class Methods</h3>
273 <table>
274 <tr><td>None</td></tr>
275 </table>
276
277 <h3>Methods</h3>
278 <table>
279 <tr><td>None</td></tr>
280 </table>
281
282 <h3>Static Methods</h3>
283 <table>
284 <tr><td>None</td></tr>
285 </table>
286
287
288 <div align="right"><a href="#top">Up</a></div>
289 <hr />
219 </body></html> 290 </body></html>

eric ide

mercurial