eric6/Documentation/Source/eric6.Helpviewer.Bookmarks.AddBookmarkDialog.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Bookmarks.AddBookmarkDialog</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><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.Bookmarks.AddBookmarkDialog</h1>
23 <p>
24 Module implementing a dialog to add a bookmark or a bookmark folder.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#AddBookmarkDialog">AddBookmarkDialog</a></td>
34 <td>Class implementing a dialog to add a bookmark or a bookmark folder.</td>
35 </tr><tr>
36 <td><a href="#AddBookmarkProxyModel">AddBookmarkProxyModel</a></td>
37 <td>Class implementing a proxy model used by the AddBookmarkDialog dialog.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="AddBookmarkDialog" ID="AddBookmarkDialog"></a>
46 <h2>AddBookmarkDialog</h2>
47 <p>
48 Class implementing a dialog to add a bookmark or a bookmark folder.
49 </p>
50 <h3>Derived from</h3>
51 QDialog, Ui_AddBookmarkDialog
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#AddBookmarkDialog.__init__">AddBookmarkDialog</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#AddBookmarkDialog.accept">accept</a></td>
67 <td>Public slot handling the acceptance of the dialog.</td>
68 </tr><tr>
69 <td><a href="#AddBookmarkDialog.addedNode">addedNode</a></td>
70 <td>Public method to get a reference to the added bookmark node.</td>
71 </tr><tr>
72 <td><a href="#AddBookmarkDialog.currentIndex">currentIndex</a></td>
73 <td>Public method to get the current index.</td>
74 </tr><tr>
75 <td><a href="#AddBookmarkDialog.description">description</a></td>
76 <td>Public method to get the description of the bookmark.</td>
77 </tr><tr>
78 <td><a href="#AddBookmarkDialog.isFolder">isFolder</a></td>
79 <td>Public method to test, if the dialog is in "Add Folder" mode.</td>
80 </tr><tr>
81 <td><a href="#AddBookmarkDialog.setCurrentIndex">setCurrentIndex</a></td>
82 <td>Public method to set the current index.</td>
83 </tr><tr>
84 <td><a href="#AddBookmarkDialog.setDescription">setDescription</a></td>
85 <td>Public method to set the description of the new bookmark.</td>
86 </tr><tr>
87 <td><a href="#AddBookmarkDialog.setFolder">setFolder</a></td>
88 <td>Public method to set the dialog to "Add Folder" mode.</td>
89 </tr><tr>
90 <td><a href="#AddBookmarkDialog.setTitle">setTitle</a></td>
91 <td>Public method to set the title of the new bookmark.</td>
92 </tr><tr>
93 <td><a href="#AddBookmarkDialog.setUrl">setUrl</a></td>
94 <td>Public slot to set the URL of the new bookmark.</td>
95 </tr><tr>
96 <td><a href="#AddBookmarkDialog.title">title</a></td>
97 <td>Public method to get the title of the bookmark.</td>
98 </tr><tr>
99 <td><a href="#AddBookmarkDialog.url">url</a></td>
100 <td>Public method to get the URL of the bookmark.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="AddBookmarkDialog.__init__" ID="AddBookmarkDialog.__init__"></a>
108 <h4>AddBookmarkDialog (Constructor)</h4>
109 <b>AddBookmarkDialog</b>(<i>parent=None, bookmarksManager=None</i>)
110 <p>
111 Constructor
112 </p><dl>
113 <dt><i>parent</i></dt>
114 <dd>
115 reference to the parent widget (QWidget)
116 </dd><dt><i>bookmarksManager</i></dt>
117 <dd>
118 reference to the bookmarks manager
119 object (BookmarksManager)
120 </dd>
121 </dl><a NAME="AddBookmarkDialog.accept" ID="AddBookmarkDialog.accept"></a>
122 <h4>AddBookmarkDialog.accept</h4>
123 <b>accept</b>(<i></i>)
124 <p>
125 Public slot handling the acceptance of the dialog.
126 </p><a NAME="AddBookmarkDialog.addedNode" ID="AddBookmarkDialog.addedNode"></a>
127 <h4>AddBookmarkDialog.addedNode</h4>
128 <b>addedNode</b>(<i></i>)
129 <p>
130 Public method to get a reference to the added bookmark node.
131 </p><dl>
132 <dt>Returns:</dt>
133 <dd>
134 reference to the added bookmark node (BookmarkNode)
135 </dd>
136 </dl><a NAME="AddBookmarkDialog.currentIndex" ID="AddBookmarkDialog.currentIndex"></a>
137 <h4>AddBookmarkDialog.currentIndex</h4>
138 <b>currentIndex</b>(<i></i>)
139 <p>
140 Public method to get the current index.
141 </p><dl>
142 <dt>Returns:</dt>
143 <dd>
144 current index (QModelIndex)
145 </dd>
146 </dl><a NAME="AddBookmarkDialog.description" ID="AddBookmarkDialog.description"></a>
147 <h4>AddBookmarkDialog.description</h4>
148 <b>description</b>(<i></i>)
149 <p>
150 Public method to get the description of the bookmark.
151 </p><dl>
152 <dt>Returns:</dt>
153 <dd>
154 description of the bookamrk (string)
155 </dd>
156 </dl><a NAME="AddBookmarkDialog.isFolder" ID="AddBookmarkDialog.isFolder"></a>
157 <h4>AddBookmarkDialog.isFolder</h4>
158 <b>isFolder</b>(<i></i>)
159 <p>
160 Public method to test, if the dialog is in "Add Folder" mode.
161 </p><dl>
162 <dt>Returns:</dt>
163 <dd>
164 flag indicating "Add Folder" mode (boolean)
165 </dd>
166 </dl><a NAME="AddBookmarkDialog.setCurrentIndex" ID="AddBookmarkDialog.setCurrentIndex"></a>
167 <h4>AddBookmarkDialog.setCurrentIndex</h4>
168 <b>setCurrentIndex</b>(<i>idx</i>)
169 <p>
170 Public method to set the current index.
171 </p><dl>
172 <dt><i>idx</i></dt>
173 <dd>
174 current index to be set (QModelIndex)
175 </dd>
176 </dl><a NAME="AddBookmarkDialog.setDescription" ID="AddBookmarkDialog.setDescription"></a>
177 <h4>AddBookmarkDialog.setDescription</h4>
178 <b>setDescription</b>(<i>description</i>)
179 <p>
180 Public method to set the description of the new bookmark.
181 </p><dl>
182 <dt><i>description</i></dt>
183 <dd>
184 description of the bookamrk (string)
185 </dd>
186 </dl><a NAME="AddBookmarkDialog.setFolder" ID="AddBookmarkDialog.setFolder"></a>
187 <h4>AddBookmarkDialog.setFolder</h4>
188 <b>setFolder</b>(<i>folder</i>)
189 <p>
190 Public method to set the dialog to "Add Folder" mode.
191 </p><dl>
192 <dt><i>folder</i></dt>
193 <dd>
194 flag indicating "Add Folder" mode (boolean)
195 </dd>
196 </dl><a NAME="AddBookmarkDialog.setTitle" ID="AddBookmarkDialog.setTitle"></a>
197 <h4>AddBookmarkDialog.setTitle</h4>
198 <b>setTitle</b>(<i>title</i>)
199 <p>
200 Public method to set the title of the new bookmark.
201 </p><dl>
202 <dt><i>title</i></dt>
203 <dd>
204 title of the bookmark (string)
205 </dd>
206 </dl><a NAME="AddBookmarkDialog.setUrl" ID="AddBookmarkDialog.setUrl"></a>
207 <h4>AddBookmarkDialog.setUrl</h4>
208 <b>setUrl</b>(<i>url</i>)
209 <p>
210 Public slot to set the URL of the new bookmark.
211 </p><dl>
212 <dt><i>url</i></dt>
213 <dd>
214 URL of the bookmark (string)
215 </dd>
216 </dl><a NAME="AddBookmarkDialog.title" ID="AddBookmarkDialog.title"></a>
217 <h4>AddBookmarkDialog.title</h4>
218 <b>title</b>(<i></i>)
219 <p>
220 Public method to get the title of the bookmark.
221 </p><dl>
222 <dt>Returns:</dt>
223 <dd>
224 title of the bookmark (string)
225 </dd>
226 </dl><a NAME="AddBookmarkDialog.url" ID="AddBookmarkDialog.url"></a>
227 <h4>AddBookmarkDialog.url</h4>
228 <b>url</b>(<i></i>)
229 <p>
230 Public method to get the URL of the bookmark.
231 </p><dl>
232 <dt>Returns:</dt>
233 <dd>
234 URL of the bookmark (string)
235 </dd>
236 </dl>
237 <div align="right"><a href="#top">Up</a></div>
238 <hr /><hr />
239 <a NAME="AddBookmarkProxyModel" ID="AddBookmarkProxyModel"></a>
240 <h2>AddBookmarkProxyModel</h2>
241 <p>
242 Class implementing a proxy model used by the AddBookmarkDialog dialog.
243 </p>
244 <h3>Derived from</h3>
245 QSortFilterProxyModel
246 <h3>Class Attributes</h3>
247 <table>
248 <tr><td>None</td></tr>
249 </table>
250 <h3>Class Methods</h3>
251 <table>
252 <tr><td>None</td></tr>
253 </table>
254 <h3>Methods</h3>
255 <table>
256 <tr>
257 <td><a href="#AddBookmarkProxyModel.__init__">AddBookmarkProxyModel</a></td>
258 <td>Constructor</td>
259 </tr><tr>
260 <td><a href="#AddBookmarkProxyModel.columnCount">columnCount</a></td>
261 <td>Public method to return the number of columns.</td>
262 </tr><tr>
263 <td><a href="#AddBookmarkProxyModel.filterAcceptsColumn">filterAcceptsColumn</a></td>
264 <td>Public method to determine, if the column is acceptable.</td>
265 </tr><tr>
266 <td><a href="#AddBookmarkProxyModel.filterAcceptsRow">filterAcceptsRow</a></td>
267 <td>Public method to determine, if the row is acceptable.</td>
268 </tr><tr>
269 <td><a href="#AddBookmarkProxyModel.hasChildren">hasChildren</a></td>
270 <td>Public method to check, if a parent node has some children.</td>
271 </tr>
272 </table>
273 <h3>Static Methods</h3>
274 <table>
275 <tr><td>None</td></tr>
276 </table>
277 <a NAME="AddBookmarkProxyModel.__init__" ID="AddBookmarkProxyModel.__init__"></a>
278 <h4>AddBookmarkProxyModel (Constructor)</h4>
279 <b>AddBookmarkProxyModel</b>(<i>parent=None</i>)
280 <p>
281 Constructor
282 </p><dl>
283 <dt><i>parent</i></dt>
284 <dd>
285 reference to the parent object (QObject)
286 </dd>
287 </dl><a NAME="AddBookmarkProxyModel.columnCount" ID="AddBookmarkProxyModel.columnCount"></a>
288 <h4>AddBookmarkProxyModel.columnCount</h4>
289 <b>columnCount</b>(<i>parent</i>)
290 <p>
291 Public method to return the number of columns.
292 </p><dl>
293 <dt><i>parent</i></dt>
294 <dd>
295 index of the parent (QModelIndex)
296 </dd>
297 </dl><dl>
298 <dt>Returns:</dt>
299 <dd>
300 number of columns (integer)
301 </dd>
302 </dl><a NAME="AddBookmarkProxyModel.filterAcceptsColumn" ID="AddBookmarkProxyModel.filterAcceptsColumn"></a>
303 <h4>AddBookmarkProxyModel.filterAcceptsColumn</h4>
304 <b>filterAcceptsColumn</b>(<i>sourceColumn, sourceParent</i>)
305 <p>
306 Public method to determine, if the column is acceptable.
307 </p><dl>
308 <dt><i>sourceColumn</i></dt>
309 <dd>
310 column number in the source model (integer)
311 </dd><dt><i>sourceParent</i></dt>
312 <dd>
313 index of the source item (QModelIndex)
314 </dd>
315 </dl><dl>
316 <dt>Returns:</dt>
317 <dd>
318 flag indicating acceptance (boolean)
319 </dd>
320 </dl><a NAME="AddBookmarkProxyModel.filterAcceptsRow" ID="AddBookmarkProxyModel.filterAcceptsRow"></a>
321 <h4>AddBookmarkProxyModel.filterAcceptsRow</h4>
322 <b>filterAcceptsRow</b>(<i>sourceRow, sourceParent</i>)
323 <p>
324 Public method to determine, if the row is acceptable.
325 </p><dl>
326 <dt><i>sourceRow</i></dt>
327 <dd>
328 row number in the source model (integer)
329 </dd><dt><i>sourceParent</i></dt>
330 <dd>
331 index of the source item (QModelIndex)
332 </dd>
333 </dl><dl>
334 <dt>Returns:</dt>
335 <dd>
336 flag indicating acceptance (boolean)
337 </dd>
338 </dl><a NAME="AddBookmarkProxyModel.hasChildren" ID="AddBookmarkProxyModel.hasChildren"></a>
339 <h4>AddBookmarkProxyModel.hasChildren</h4>
340 <b>hasChildren</b>(<i>parent=None</i>)
341 <p>
342 Public method to check, if a parent node has some children.
343 </p><dl>
344 <dt><i>parent</i></dt>
345 <dd>
346 index of the parent node (QModelIndex)
347 </dd>
348 </dl><dl>
349 <dt>Returns:</dt>
350 <dd>
351 flag indicating the presence of children (boolean)
352 </dd>
353 </dl>
354 <div align="right"><a href="#top">Up</a></div>
355 <hr />
356 </body></html>

eric ide

mercurial