Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.Bookmarks.BookmarksManager.html

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

changeset 646
aa422d7436a7
parent 501
5c615a85241a
child 767
27554f80d08f
equal deleted inserted replaced
644:7c1c3abedf1c 646:aa422d7436a7
24 <p> 24 <p>
25 Module implementing the bookmarks manager. 25 Module implementing the bookmarks manager.
26 </p> 26 </p>
27 <h3>Global Attributes</h3> 27 <h3>Global Attributes</h3>
28 <table> 28 <table>
29 <tr><td>BOOKMARKBAR</td></tr><tr><td>BOOKMARKMENU</td></tr><tr><td>extract_js</td></tr> 29 <tr><td>BOOKMARKBAR</td></tr><tr><td>BOOKMARKMENU</td></tr><tr><td>StartMenu</td></tr><tr><td>StartRoot</td></tr><tr><td>StartToolBar</td></tr><tr><td>extract_js</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#BookmarksManager">BookmarksManager</a></td> 34 <td><a href="#BookmarksManager">BookmarksManager</a></td>
80 <td>Constructor</td> 80 <td>Constructor</td>
81 </tr><tr> 81 </tr><tr>
82 <td><a href="#BookmarksManager.__convertFromOldBookmarks">__convertFromOldBookmarks</a></td> 82 <td><a href="#BookmarksManager.__convertFromOldBookmarks">__convertFromOldBookmarks</a></td>
83 <td>Private method to convert the old bookmarks into the new ones.</td> 83 <td>Private method to convert the old bookmarks into the new ones.</td>
84 </tr><tr> 84 </tr><tr>
85 <td><a href="#BookmarksManager.__searchBookmark">__searchBookmark</a></td>
86 <td>Private method get a bookmark node for a given URL.</td>
87 </tr><tr>
88 <td><a href="#BookmarksManager.__searchBookmarks">__searchBookmarks</a></td>
89 <td>Private method get a list of bookmark nodes for a given URL.</td>
90 </tr><tr>
85 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td> 91 <td><a href="#BookmarksManager.addBookmark">addBookmark</a></td>
86 <td>Public method to add a bookmark.</td> 92 <td>Public method to add a bookmark.</td>
87 </tr><tr> 93 </tr><tr>
94 <td><a href="#BookmarksManager.bookmarkForUrl">bookmarkForUrl</a></td>
95 <td>Public method to get a bookmark node for a given URL.</td>
96 </tr><tr>
88 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td> 97 <td><a href="#BookmarksManager.bookmarks">bookmarks</a></td>
89 <td>Public method to get a reference to the root bookmark node.</td> 98 <td>Public method to get a reference to the root bookmark node.</td>
90 </tr><tr> 99 </tr><tr>
100 <td><a href="#BookmarksManager.bookmarksForUrl">bookmarksForUrl</a></td>
101 <td>Public method to get a list of bookmark nodes for a given URL.</td>
102 </tr><tr>
91 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td> 103 <td><a href="#BookmarksManager.bookmarksModel">bookmarksModel</a></td>
92 <td>Public method to get a reference to the bookmarks model.</td> 104 <td>Public method to get a reference to the bookmarks model.</td>
93 </tr><tr> 105 </tr><tr>
94 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td> 106 <td><a href="#BookmarksManager.changeExpanded">changeExpanded</a></td>
95 <td>Public method to handle a change of the expanded state.</td> 107 <td>Public method to handle a change of the expanded state.</td>
97 <td><a href="#BookmarksManager.close">close</a></td> 109 <td><a href="#BookmarksManager.close">close</a></td>
98 <td>Public method to close the bookmark manager.</td> 110 <td>Public method to close the bookmark manager.</td>
99 </tr><tr> 111 </tr><tr>
100 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td> 112 <td><a href="#BookmarksManager.exportBookmarks">exportBookmarks</a></td>
101 <td>Public method to export the bookmarks.</td> 113 <td>Public method to export the bookmarks.</td>
114 </tr><tr>
115 <td><a href="#BookmarksManager.iconChanged">iconChanged</a></td>
116 <td>Public slot to update the icon image for an URL.</td>
102 </tr><tr> 117 </tr><tr>
103 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td> 118 <td><a href="#BookmarksManager.importBookmarks">importBookmarks</a></td>
104 <td>Public method to import bookmarks.</td> 119 <td>Public method to import bookmarks.</td>
105 </tr><tr> 120 </tr><tr>
106 <td><a href="#BookmarksManager.load">load</a></td> 121 <td><a href="#BookmarksManager.load">load</a></td>
141 </dl><a NAME="BookmarksManager.__convertFromOldBookmarks" ID="BookmarksManager.__convertFromOldBookmarks"></a> 156 </dl><a NAME="BookmarksManager.__convertFromOldBookmarks" ID="BookmarksManager.__convertFromOldBookmarks"></a>
142 <h4>BookmarksManager.__convertFromOldBookmarks</h4> 157 <h4>BookmarksManager.__convertFromOldBookmarks</h4>
143 <b>__convertFromOldBookmarks</b>(<i></i>) 158 <b>__convertFromOldBookmarks</b>(<i></i>)
144 <p> 159 <p>
145 Private method to convert the old bookmarks into the new ones. 160 Private method to convert the old bookmarks into the new ones.
146 </p><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a> 161 </p><a NAME="BookmarksManager.__searchBookmark" ID="BookmarksManager.__searchBookmark"></a>
162 <h4>BookmarksManager.__searchBookmark</h4>
163 <b>__searchBookmark</b>(<i>url, startNode</i>)
164 <p>
165 Private method get a bookmark node for a given URL.
166 </p><dl>
167 <dt><i>url</i></dt>
168 <dd>
169 URL of the bookmark to search for (string)
170 </dd><dt><i>startNode</i></dt>
171 <dd>
172 reference to the node to start searching (BookmarkNode)
173 </dd>
174 </dl><dl>
175 <dt>Returns:</dt>
176 <dd>
177 bookmark node for the given url (BookmarkNode)
178 </dd>
179 </dl><a NAME="BookmarksManager.__searchBookmarks" ID="BookmarksManager.__searchBookmarks"></a>
180 <h4>BookmarksManager.__searchBookmarks</h4>
181 <b>__searchBookmarks</b>(<i>url, startNode</i>)
182 <p>
183 Private method get a list of bookmark nodes for a given URL.
184 </p><dl>
185 <dt><i>url</i></dt>
186 <dd>
187 URL of the bookmarks to search for (string)
188 </dd><dt><i>startNode</i></dt>
189 <dd>
190 reference to the node to start searching (BookmarkNode)
191 </dd>
192 </dl><dl>
193 <dt>Returns:</dt>
194 <dd>
195 list of bookmark nodes for the given url (list of BookmarkNode)
196 </dd>
197 </dl><a NAME="BookmarksManager.addBookmark" ID="BookmarksManager.addBookmark"></a>
147 <h4>BookmarksManager.addBookmark</h4> 198 <h4>BookmarksManager.addBookmark</h4>
148 <b>addBookmark</b>(<i>parent, node, row = -1</i>) 199 <b>addBookmark</b>(<i>parent, node, row = -1</i>)
149 <p> 200 <p>
150 Public method to add a bookmark. 201 Public method to add a bookmark.
151 </p><dl> 202 </p><dl>
156 <dd> 207 <dd>
157 reference to the node to add (BookmarkNode) 208 reference to the node to add (BookmarkNode)
158 </dd><dt><i>row</i></dt> 209 </dd><dt><i>row</i></dt>
159 <dd> 210 <dd>
160 row number (integer) 211 row number (integer)
212 </dd>
213 </dl><a NAME="BookmarksManager.bookmarkForUrl" ID="BookmarksManager.bookmarkForUrl"></a>
214 <h4>BookmarksManager.bookmarkForUrl</h4>
215 <b>bookmarkForUrl</b>(<i>url, start = StartRoot</i>)
216 <p>
217 Public method to get a bookmark node for a given URL.
218 </p><dl>
219 <dt><i>url</i></dt>
220 <dd>
221 URL of the bookmark to search for (QUrl or string)
222 </dd><dt><i>start=</i></dt>
223 <dd>
224 indicator for the start of the search
225 (StartRoot, StartMenu, StartToolBar)
226 </dd>
227 </dl><dl>
228 <dt>Returns:</dt>
229 <dd>
230 bookmark node for the given url (BookmarkNode)
161 </dd> 231 </dd>
162 </dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a> 232 </dl><a NAME="BookmarksManager.bookmarks" ID="BookmarksManager.bookmarks"></a>
163 <h4>BookmarksManager.bookmarks</h4> 233 <h4>BookmarksManager.bookmarks</h4>
164 <b>bookmarks</b>(<i></i>) 234 <b>bookmarks</b>(<i></i>)
165 <p> 235 <p>
166 Public method to get a reference to the root bookmark node. 236 Public method to get a reference to the root bookmark node.
167 </p><dl> 237 </p><dl>
168 <dt>Returns:</dt> 238 <dt>Returns:</dt>
169 <dd> 239 <dd>
170 reference to the root bookmark node (BookmarkNode) 240 reference to the root bookmark node (BookmarkNode)
241 </dd>
242 </dl><a NAME="BookmarksManager.bookmarksForUrl" ID="BookmarksManager.bookmarksForUrl"></a>
243 <h4>BookmarksManager.bookmarksForUrl</h4>
244 <b>bookmarksForUrl</b>(<i>url, start = StartRoot</i>)
245 <p>
246 Public method to get a list of bookmark nodes for a given URL.
247 </p><dl>
248 <dt><i>url</i></dt>
249 <dd>
250 URL of the bookmarks to search for (QUrl or string)
251 </dd><dt><i>start=</i></dt>
252 <dd>
253 indicator for the start of the search
254 (StartRoot, StartMenu, StartToolBar)
255 </dd>
256 </dl><dl>
257 <dt>Returns:</dt>
258 <dd>
259 list of bookmark nodes for the given url (list of BookmarkNode)
171 </dd> 260 </dd>
172 </dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a> 261 </dl><a NAME="BookmarksManager.bookmarksModel" ID="BookmarksManager.bookmarksModel"></a>
173 <h4>BookmarksManager.bookmarksModel</h4> 262 <h4>BookmarksManager.bookmarksModel</h4>
174 <b>bookmarksModel</b>(<i></i>) 263 <b>bookmarksModel</b>(<i></i>)
175 <p> 264 <p>
192 </p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a> 281 </p><a NAME="BookmarksManager.exportBookmarks" ID="BookmarksManager.exportBookmarks"></a>
193 <h4>BookmarksManager.exportBookmarks</h4> 282 <h4>BookmarksManager.exportBookmarks</h4>
194 <b>exportBookmarks</b>(<i></i>) 283 <b>exportBookmarks</b>(<i></i>)
195 <p> 284 <p>
196 Public method to export the bookmarks. 285 Public method to export the bookmarks.
197 </p><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a> 286 </p><a NAME="BookmarksManager.iconChanged" ID="BookmarksManager.iconChanged"></a>
287 <h4>BookmarksManager.iconChanged</h4>
288 <b>iconChanged</b>(<i>url</i>)
289 <p>
290 Public slot to update the icon image for an URL.
291 </p><dl>
292 <dt><i>url</i></dt>
293 <dd>
294 URL of the icon to update (QUrl or string)
295 </dd>
296 </dl><a NAME="BookmarksManager.importBookmarks" ID="BookmarksManager.importBookmarks"></a>
198 <h4>BookmarksManager.importBookmarks</h4> 297 <h4>BookmarksManager.importBookmarks</h4>
199 <b>importBookmarks</b>(<i></i>) 298 <b>importBookmarks</b>(<i></i>)
200 <p> 299 <p>
201 Public method to import bookmarks. 300 Public method to import bookmarks.
202 </p><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a> 301 </p><a NAME="BookmarksManager.load" ID="BookmarksManager.load"></a>

Mercurial Repository: eric

eric ide

mercurial