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