Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Helpviewer.Bookmarks.AddBookmarkDialog.html

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

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Helpviewer.Bookmarks.AddBookmarkDialog</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Helpviewer.Bookmarks.AddBookmarkDialog</h1>
24 <p>
25 Module implementing a dialog to add a bookmark or a bookmark folder.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#AddBookmarkDialog">AddBookmarkDialog</a></td>
35 <td>Class implementing a dialog to add a bookmark or a bookmark folder.</td>
36 </tr><tr>
37 <td><a href="#AddBookmarkProxyModel">AddBookmarkProxyModel</a></td>
38 <td>Class implementing a proxy model used by the AddBookmarkDialog dialog.</td>
39 </tr>
40 </table>
41 <h3>Functions</h3>
42 <table>
43 <tr><td>None</td></tr>
44 </table>
45 <hr /><hr />
46 <a NAME="AddBookmarkDialog" ID="AddBookmarkDialog"></a>
47 <h2>AddBookmarkDialog</h2>
48 <p>
49 Class implementing a dialog to add a bookmark or a bookmark folder.
50 </p>
51 <h3>Derived from</h3>
52 QDialog, Ui_AddBookmarkDialog
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#AddBookmarkDialog.__init__">AddBookmarkDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#AddBookmarkDialog.accept">accept</a></td>
64 <td>Public slot handling the acceptance of the dialog.</td>
65 </tr><tr>
66 <td><a href="#AddBookmarkDialog.addedNode">addedNode</a></td>
67 <td>Public method to get a reference to the added bookmark node.</td>
68 </tr><tr>
69 <td><a href="#AddBookmarkDialog.currentIndex">currentIndex</a></td>
70 <td>Public method to get the current index.</td>
71 </tr><tr>
72 <td><a href="#AddBookmarkDialog.isFolder">isFolder</a></td>
73 <td>Public method to test, if the dialog is in "Add Folder" mode.</td>
74 </tr><tr>
75 <td><a href="#AddBookmarkDialog.setCurrentIndex">setCurrentIndex</a></td>
76 <td>Public method to set the current index.</td>
77 </tr><tr>
78 <td><a href="#AddBookmarkDialog.setFolder">setFolder</a></td>
79 <td>Public method to set the dialog to "Add Folder" mode.</td>
80 </tr><tr>
81 <td><a href="#AddBookmarkDialog.setTitle">setTitle</a></td>
82 <td>Public method to set the title of the new bookmark.</td>
83 </tr><tr>
84 <td><a href="#AddBookmarkDialog.setUrl">setUrl</a></td>
85 <td>Public slot to set the URL of the new bookmark.</td>
86 </tr><tr>
87 <td><a href="#AddBookmarkDialog.title">title</a></td>
88 <td>Public method to get the title of the bookmark.</td>
89 </tr><tr>
90 <td><a href="#AddBookmarkDialog.url">url</a></td>
91 <td>Public method to get the URL of the bookmark.</td>
92 </tr>
93 </table>
94 <a NAME="AddBookmarkDialog.__init__" ID="AddBookmarkDialog.__init__"></a>
95 <h4>AddBookmarkDialog (Constructor)</h4>
96 <b>AddBookmarkDialog</b>(<i>parent = None, bookmarksManager = None</i>)
97 <p>
98 Constructor
99 </p><dl>
100 <dt><i>parent</i></dt>
101 <dd>
102 reference to the parent widget (QWidget)
103 </dd><dt><i>bookmarksManager</i></dt>
104 <dd>
105 reference to the bookmarks manager
106 object (BookmarksManager)
107 </dd>
108 </dl><a NAME="AddBookmarkDialog.accept" ID="AddBookmarkDialog.accept"></a>
109 <h4>AddBookmarkDialog.accept</h4>
110 <b>accept</b>(<i></i>)
111 <p>
112 Public slot handling the acceptance of the dialog.
113 </p><a NAME="AddBookmarkDialog.addedNode" ID="AddBookmarkDialog.addedNode"></a>
114 <h4>AddBookmarkDialog.addedNode</h4>
115 <b>addedNode</b>(<i></i>)
116 <p>
117 Public method to get a reference to the added bookmark node.
118 </p><dl>
119 <dt>Returns:</dt>
120 <dd>
121 reference to the added bookmark node (BookmarkNode)
122 </dd>
123 </dl><a NAME="AddBookmarkDialog.currentIndex" ID="AddBookmarkDialog.currentIndex"></a>
124 <h4>AddBookmarkDialog.currentIndex</h4>
125 <b>currentIndex</b>(<i></i>)
126 <p>
127 Public method to get the current index.
128 </p><dl>
129 <dt>Returns:</dt>
130 <dd>
131 current index (QModelIndex)
132 </dd>
133 </dl><a NAME="AddBookmarkDialog.isFolder" ID="AddBookmarkDialog.isFolder"></a>
134 <h4>AddBookmarkDialog.isFolder</h4>
135 <b>isFolder</b>(<i></i>)
136 <p>
137 Public method to test, if the dialog is in "Add Folder" mode.
138 </p><dl>
139 <dt>Returns:</dt>
140 <dd>
141 flag indicating "Add Folder" mode (boolean)
142 </dd>
143 </dl><a NAME="AddBookmarkDialog.setCurrentIndex" ID="AddBookmarkDialog.setCurrentIndex"></a>
144 <h4>AddBookmarkDialog.setCurrentIndex</h4>
145 <b>setCurrentIndex</b>(<i>idx</i>)
146 <p>
147 Public method to set the current index.
148 </p><dl>
149 <dt><i>idx</i></dt>
150 <dd>
151 current index to be set (QModelIndex)
152 </dd>
153 </dl><a NAME="AddBookmarkDialog.setFolder" ID="AddBookmarkDialog.setFolder"></a>
154 <h4>AddBookmarkDialog.setFolder</h4>
155 <b>setFolder</b>(<i>folder</i>)
156 <p>
157 Public method to set the dialog to "Add Folder" mode.
158 </p><dl>
159 <dt><i>folder</i></dt>
160 <dd>
161 flag indicating "Add Folder" mode (boolean)
162 </dd>
163 </dl><a NAME="AddBookmarkDialog.setTitle" ID="AddBookmarkDialog.setTitle"></a>
164 <h4>AddBookmarkDialog.setTitle</h4>
165 <b>setTitle</b>(<i>title</i>)
166 <p>
167 Public method to set the title of the new bookmark.
168 </p><dl>
169 <dt><i>title</i></dt>
170 <dd>
171 title of the bookmark (string)
172 </dd>
173 </dl><a NAME="AddBookmarkDialog.setUrl" ID="AddBookmarkDialog.setUrl"></a>
174 <h4>AddBookmarkDialog.setUrl</h4>
175 <b>setUrl</b>(<i>url</i>)
176 <p>
177 Public slot to set the URL of the new bookmark.
178 </p><dl>
179 <dt><i>url</i></dt>
180 <dd>
181 URL of the bookmark (string)
182 </dd>
183 </dl><a NAME="AddBookmarkDialog.title" ID="AddBookmarkDialog.title"></a>
184 <h4>AddBookmarkDialog.title</h4>
185 <b>title</b>(<i></i>)
186 <p>
187 Public method to get the title of the bookmark.
188 </p><dl>
189 <dt>Returns:</dt>
190 <dd>
191 title of the bookmark (string)
192 </dd>
193 </dl><a NAME="AddBookmarkDialog.url" ID="AddBookmarkDialog.url"></a>
194 <h4>AddBookmarkDialog.url</h4>
195 <b>url</b>(<i></i>)
196 <p>
197 Public method to get the URL of the bookmark.
198 </p><dl>
199 <dt>Returns:</dt>
200 <dd>
201 URL of the bookmark (string)
202 </dd>
203 </dl>
204 <div align="right"><a href="#top">Up</a></div>
205 <hr /><hr />
206 <a NAME="AddBookmarkProxyModel" ID="AddBookmarkProxyModel"></a>
207 <h2>AddBookmarkProxyModel</h2>
208 <p>
209 Class implementing a proxy model used by the AddBookmarkDialog dialog.
210 </p>
211 <h3>Derived from</h3>
212 QSortFilterProxyModel
213 <h3>Class Attributes</h3>
214 <table>
215 <tr><td>None</td></tr>
216 </table>
217 <h3>Methods</h3>
218 <table>
219 <tr>
220 <td><a href="#AddBookmarkProxyModel.__init__">AddBookmarkProxyModel</a></td>
221 <td>Constructor</td>
222 </tr><tr>
223 <td><a href="#AddBookmarkProxyModel.columnCount">columnCount</a></td>
224 <td>Public method to return the number of columns.</td>
225 </tr><tr>
226 <td><a href="#AddBookmarkProxyModel.filterAcceptsColumn">filterAcceptsColumn</a></td>
227 <td>Protected method to determine, if the column is acceptable.</td>
228 </tr><tr>
229 <td><a href="#AddBookmarkProxyModel.filterAcceptsRow">filterAcceptsRow</a></td>
230 <td>Protected method to determine, if the row is acceptable.</td>
231 </tr><tr>
232 <td><a href="#AddBookmarkProxyModel.hasChildren">hasChildren</a></td>
233 <td>Public method to check, if a parent node has some children.</td>
234 </tr>
235 </table>
236 <a NAME="AddBookmarkProxyModel.__init__" ID="AddBookmarkProxyModel.__init__"></a>
237 <h4>AddBookmarkProxyModel (Constructor)</h4>
238 <b>AddBookmarkProxyModel</b>(<i>parent = None</i>)
239 <p>
240 Constructor
241 </p><dl>
242 <dt><i>parent</i></dt>
243 <dd>
244 reference to the parent object (QObject)
245 </dd>
246 </dl><a NAME="AddBookmarkProxyModel.columnCount" ID="AddBookmarkProxyModel.columnCount"></a>
247 <h4>AddBookmarkProxyModel.columnCount</h4>
248 <b>columnCount</b>(<i>parent</i>)
249 <p>
250 Public method to return the number of columns.
251 </p><dl>
252 <dt><i>parent</i></dt>
253 <dd>
254 index of the parent (QModelIndex)
255 </dd>
256 </dl><dl>
257 <dt>Returns:</dt>
258 <dd>
259 number of columns (integer)
260 </dd>
261 </dl><a NAME="AddBookmarkProxyModel.filterAcceptsColumn" ID="AddBookmarkProxyModel.filterAcceptsColumn"></a>
262 <h4>AddBookmarkProxyModel.filterAcceptsColumn</h4>
263 <b>filterAcceptsColumn</b>(<i>sourceColumn, sourceParent</i>)
264 <p>
265 Protected method to determine, if the column is acceptable.
266 </p><dl>
267 <dt><i>sourceColumn</i></dt>
268 <dd>
269 column number in the source model (integer)
270 </dd><dt><i>sourceParent</i></dt>
271 <dd>
272 index of the source item (QModelIndex)
273 </dd>
274 </dl><dl>
275 <dt>Returns:</dt>
276 <dd>
277 flag indicating acceptance (boolean)
278 </dd>
279 </dl><a NAME="AddBookmarkProxyModel.filterAcceptsRow" ID="AddBookmarkProxyModel.filterAcceptsRow"></a>
280 <h4>AddBookmarkProxyModel.filterAcceptsRow</h4>
281 <b>filterAcceptsRow</b>(<i>sourceRow, sourceParent</i>)
282 <p>
283 Protected method to determine, if the row is acceptable.
284 </p><dl>
285 <dt><i>sourceRow</i></dt>
286 <dd>
287 row number in the source model (integer)
288 </dd><dt><i>sourceParent</i></dt>
289 <dd>
290 index of the source item (QModelIndex)
291 </dd>
292 </dl><dl>
293 <dt>Returns:</dt>
294 <dd>
295 flag indicating acceptance (boolean)
296 </dd>
297 </dl><a NAME="AddBookmarkProxyModel.hasChildren" ID="AddBookmarkProxyModel.hasChildren"></a>
298 <h4>AddBookmarkProxyModel.hasChildren</h4>
299 <b>hasChildren</b>(<i>parent = QModelIndex()</i>)
300 <p>
301 Public method to check, if a parent node has some children.
302 </p><dl>
303 <dt><i>parent</i></dt>
304 <dd>
305 index of the parent node (QModelIndex)
306 </dd>
307 </dl><dl>
308 <dt>Returns:</dt>
309 <dd>
310 flag indicating the presence of children (boolean)
311 </dd>
312 </dl>
313 <div align="right"><a href="#top">Up</a></div>
314 <hr />
315 </body></html>

Mercurial Repository: eric

eric ide

mercurial