Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.Feeds.FeedsManager.html

eric6/Documentation/Source/eric6.WebBrowser.Feeds.FeedsManager.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.Feeds.FeedsManager</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.WebBrowser.Feeds.FeedsManager</h1>
23 <p>
24 Module implementing a RSS feeds manager dialog.
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="#FeedsManager">FeedsManager</a></td>
34 <td>Class implementing a RSS feeds manager dialog.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="FeedsManager" ID="FeedsManager"></a>
43 <h2>FeedsManager</h2>
44 <p>
45 Class implementing a RSS feeds manager dialog.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>newBackgroundTab(QUrl, str)</dt>
49 <dd>
50 emitted to open a URL in a new
51 background tab
52 </dd><dt>newPrivateWindow(QUrl, str)</dt>
53 <dd>
54 emitted to open a URL in a new
55 private window
56 </dd><dt>newTab(QUrl, str)</dt>
57 <dd>
58 emitted to open a URL in a new tab
59 </dd><dt>newWindow(QUrl, str)</dt>
60 <dd>
61 emitted to open a URL in a new window
62 </dd><dt>openUrl(QUrl, str)</dt>
63 <dd>
64 emitted to open a URL in the current tab
65 </dd>
66 </dl>
67 <h3>Derived from</h3>
68 QDialog, Ui_FeedsManager
69 <h3>Class Attributes</h3>
70 <table>
71 <tr><td>ErrorDataRole</td></tr><tr><td>UrlStringRole</td></tr>
72 </table>
73 <h3>Class Methods</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <h3>Methods</h3>
78 <table>
79 <tr>
80 <td><a href="#FeedsManager.__init__">FeedsManager</a></td>
81 <td>Constructor</td>
82 </tr><tr>
83 <td><a href="#FeedsManager.__addFeedItem">__addFeedItem</a></td>
84 <td>Private slot to add a top level feed item.</td>
85 </tr><tr>
86 <td><a href="#FeedsManager.__copyUrlToClipboard">__copyUrlToClipboard</a></td>
87 <td>Private slot to copy the URL of the selected item to the clipboard.</td>
88 </tr><tr>
89 <td><a href="#FeedsManager.__customContextMenuRequested">__customContextMenuRequested</a></td>
90 <td>Private slot to handle the context menu request for the feeds tree.</td>
91 </tr><tr>
92 <td><a href="#FeedsManager.__enableButtons">__enableButtons</a></td>
93 <td>Private slot to disable/enable various buttons.</td>
94 </tr><tr>
95 <td><a href="#FeedsManager.__feedLoaded">__feedLoaded</a></td>
96 <td>Private slot to extract the loaded feed data.</td>
97 </tr><tr>
98 <td><a href="#FeedsManager.__itemActivated">__itemActivated</a></td>
99 <td>Private slot to handle the activation of an item.</td>
100 </tr><tr>
101 <td><a href="#FeedsManager.__load">__load</a></td>
102 <td>Private method to load the feeds data.</td>
103 </tr><tr>
104 <td><a href="#FeedsManager.__openMessage">__openMessage</a></td>
105 <td>Private method to open a feed message.</td>
106 </tr><tr>
107 <td><a href="#FeedsManager.__openMessageInCurrentTab">__openMessageInCurrentTab</a></td>
108 <td>Private slot to open a feed message in the current browser tab.</td>
109 </tr><tr>
110 <td><a href="#FeedsManager.__openMessageInNewBackgroundTab">__openMessageInNewBackgroundTab</a></td>
111 <td>Private slot to open a feed message in a new background tab.</td>
112 </tr><tr>
113 <td><a href="#FeedsManager.__openMessageInNewTab">__openMessageInNewTab</a></td>
114 <td>Private slot to open a feed message in a new browser tab.</td>
115 </tr><tr>
116 <td><a href="#FeedsManager.__openMessageInNewWindow">__openMessageInNewWindow</a></td>
117 <td>Private slot to open a feed message in a new browser window.</td>
118 </tr><tr>
119 <td><a href="#FeedsManager.__openMessageInPrivateWindow">__openMessageInPrivateWindow</a></td>
120 <td>Private slot to open a feed message in a new private browser window.</td>
121 </tr><tr>
122 <td><a href="#FeedsManager.__reloadFeed">__reloadFeed</a></td>
123 <td>Private method to reload the given feed.</td>
124 </tr><tr>
125 <td><a href="#FeedsManager.__save">__save</a></td>
126 <td>Private method to store the feeds data.</td>
127 </tr><tr>
128 <td><a href="#FeedsManager.__showError">__showError</a></td>
129 <td>Private slot to show error info for a failed load operation.</td>
130 </tr><tr>
131 <td><a href="#FeedsManager.addFeed">addFeed</a></td>
132 <td>Public method to add a feed.</td>
133 </tr><tr>
134 <td><a href="#FeedsManager.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
135 <td>Private slot to delete the selected feed.</td>
136 </tr><tr>
137 <td><a href="#FeedsManager.on_editButton_clicked">on_editButton_clicked</a></td>
138 <td>Private slot to edit the selected feed.</td>
139 </tr><tr>
140 <td><a href="#FeedsManager.on_feedsTree_itemSelectionChanged">on_feedsTree_itemSelectionChanged</a></td>
141 <td>Private slot to enable the various buttons depending on the selection.</td>
142 </tr><tr>
143 <td><a href="#FeedsManager.on_reloadAllButton_clicked">on_reloadAllButton_clicked</a></td>
144 <td>Private slot to reload all feeds.</td>
145 </tr><tr>
146 <td><a href="#FeedsManager.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
147 <td>Private slot to reload the selected feed.</td>
148 </tr><tr>
149 <td><a href="#FeedsManager.show">show</a></td>
150 <td>Public slot to show the feeds manager dialog.</td>
151 </tr>
152 </table>
153 <h3>Static Methods</h3>
154 <table>
155 <tr><td>None</td></tr>
156 </table>
157 <a NAME="FeedsManager.__init__" ID="FeedsManager.__init__"></a>
158 <h4>FeedsManager (Constructor)</h4>
159 <b>FeedsManager</b>(<i>parent=None</i>)
160 <p>
161 Constructor
162 </p><dl>
163 <dt><i>parent</i></dt>
164 <dd>
165 reference to the parent widget (QWidget)
166 </dd>
167 </dl><a NAME="FeedsManager.__addFeedItem" ID="FeedsManager.__addFeedItem"></a>
168 <h4>FeedsManager.__addFeedItem</h4>
169 <b>__addFeedItem</b>(<i>feed</i>)
170 <p>
171 Private slot to add a top level feed item.
172 </p><dl>
173 <dt><i>feed</i></dt>
174 <dd>
175 tuple containing feed info (URL, title, icon)
176 (string, string, QIcon)
177 </dd>
178 </dl><a NAME="FeedsManager.__copyUrlToClipboard" ID="FeedsManager.__copyUrlToClipboard"></a>
179 <h4>FeedsManager.__copyUrlToClipboard</h4>
180 <b>__copyUrlToClipboard</b>(<i></i>)
181 <p>
182 Private slot to copy the URL of the selected item to the clipboard.
183 </p><a NAME="FeedsManager.__customContextMenuRequested" ID="FeedsManager.__customContextMenuRequested"></a>
184 <h4>FeedsManager.__customContextMenuRequested</h4>
185 <b>__customContextMenuRequested</b>(<i>pos</i>)
186 <p>
187 Private slot to handle the context menu request for the feeds tree.
188 </p><dl>
189 <dt><i>pos</i></dt>
190 <dd>
191 position the context menu was requested (QPoint)
192 </dd>
193 </dl><a NAME="FeedsManager.__enableButtons" ID="FeedsManager.__enableButtons"></a>
194 <h4>FeedsManager.__enableButtons</h4>
195 <b>__enableButtons</b>(<i></i>)
196 <p>
197 Private slot to disable/enable various buttons.
198 </p><a NAME="FeedsManager.__feedLoaded" ID="FeedsManager.__feedLoaded"></a>
199 <h4>FeedsManager.__feedLoaded</h4>
200 <b>__feedLoaded</b>(<i>reply</i>)
201 <p>
202 Private slot to extract the loaded feed data.
203 </p><dl>
204 <dt><i>reply</i> (QNetworkReply)</dt>
205 <dd>
206 reference to the network reply
207 </dd>
208 </dl><a NAME="FeedsManager.__itemActivated" ID="FeedsManager.__itemActivated"></a>
209 <h4>FeedsManager.__itemActivated</h4>
210 <b>__itemActivated</b>(<i>itm, column</i>)
211 <p>
212 Private slot to handle the activation of an item.
213 </p><dl>
214 <dt><i>itm</i></dt>
215 <dd>
216 reference to the activated item (QTreeWidgetItem)
217 </dd><dt><i>column</i></dt>
218 <dd>
219 column of the activation (integer)
220 </dd>
221 </dl><a NAME="FeedsManager.__load" ID="FeedsManager.__load"></a>
222 <h4>FeedsManager.__load</h4>
223 <b>__load</b>(<i></i>)
224 <p>
225 Private method to load the feeds data.
226 </p><a NAME="FeedsManager.__openMessage" ID="FeedsManager.__openMessage"></a>
227 <h4>FeedsManager.__openMessage</h4>
228 <b>__openMessage</b>(<i>newTab=False, background=False, newWindow=False, privateWindow=False</i>)
229 <p>
230 Private method to open a feed message.
231 </p><dl>
232 <dt><i>newTab</i> (bool)</dt>
233 <dd>
234 flag indicating to open the feed message in a new tab
235 </dd><dt><i>background</i> (bool)</dt>
236 <dd>
237 flag indicating to open the bookmark in a new
238 background tab
239 </dd><dt><i>newWindow</i> (bool)</dt>
240 <dd>
241 flag indicating to open the bookmark in a new window
242 </dd><dt><i>privateWindow</i> (bool)</dt>
243 <dd>
244 flag indicating to open the bookmark in a new
245 private window
246 </dd>
247 </dl><a NAME="FeedsManager.__openMessageInCurrentTab" ID="FeedsManager.__openMessageInCurrentTab"></a>
248 <h4>FeedsManager.__openMessageInCurrentTab</h4>
249 <b>__openMessageInCurrentTab</b>(<i></i>)
250 <p>
251 Private slot to open a feed message in the current browser tab.
252 </p><a NAME="FeedsManager.__openMessageInNewBackgroundTab" ID="FeedsManager.__openMessageInNewBackgroundTab"></a>
253 <h4>FeedsManager.__openMessageInNewBackgroundTab</h4>
254 <b>__openMessageInNewBackgroundTab</b>(<i></i>)
255 <p>
256 Private slot to open a feed message in a new background tab.
257 </p><a NAME="FeedsManager.__openMessageInNewTab" ID="FeedsManager.__openMessageInNewTab"></a>
258 <h4>FeedsManager.__openMessageInNewTab</h4>
259 <b>__openMessageInNewTab</b>(<i></i>)
260 <p>
261 Private slot to open a feed message in a new browser tab.
262 </p><a NAME="FeedsManager.__openMessageInNewWindow" ID="FeedsManager.__openMessageInNewWindow"></a>
263 <h4>FeedsManager.__openMessageInNewWindow</h4>
264 <b>__openMessageInNewWindow</b>(<i></i>)
265 <p>
266 Private slot to open a feed message in a new browser window.
267 </p><a NAME="FeedsManager.__openMessageInPrivateWindow" ID="FeedsManager.__openMessageInPrivateWindow"></a>
268 <h4>FeedsManager.__openMessageInPrivateWindow</h4>
269 <b>__openMessageInPrivateWindow</b>(<i></i>)
270 <p>
271 Private slot to open a feed message in a new private browser window.
272 </p><a NAME="FeedsManager.__reloadFeed" ID="FeedsManager.__reloadFeed"></a>
273 <h4>FeedsManager.__reloadFeed</h4>
274 <b>__reloadFeed</b>(<i>itm</i>)
275 <p>
276 Private method to reload the given feed.
277 </p><dl>
278 <dt><i>itm</i></dt>
279 <dd>
280 feed item to be reloaded (QTreeWidgetItem)
281 </dd>
282 </dl><a NAME="FeedsManager.__save" ID="FeedsManager.__save"></a>
283 <h4>FeedsManager.__save</h4>
284 <b>__save</b>(<i></i>)
285 <p>
286 Private method to store the feeds data.
287 </p><a NAME="FeedsManager.__showError" ID="FeedsManager.__showError"></a>
288 <h4>FeedsManager.__showError</h4>
289 <b>__showError</b>(<i></i>)
290 <p>
291 Private slot to show error info for a failed load operation.
292 </p><a NAME="FeedsManager.addFeed" ID="FeedsManager.addFeed"></a>
293 <h4>FeedsManager.addFeed</h4>
294 <b>addFeed</b>(<i>urlString, title, icon</i>)
295 <p>
296 Public method to add a feed.
297 </p><dl>
298 <dt><i>urlString</i></dt>
299 <dd>
300 URL of the feed (string)
301 </dd><dt><i>title</i></dt>
302 <dd>
303 title of the feed (string)
304 </dd><dt><i>icon</i></dt>
305 <dd>
306 icon for the feed (QIcon)
307 </dd>
308 </dl><dl>
309 <dt>Returns:</dt>
310 <dd>
311 flag indicating a successful addition of the feed (boolean)
312 </dd>
313 </dl><a NAME="FeedsManager.on_deleteButton_clicked" ID="FeedsManager.on_deleteButton_clicked"></a>
314 <h4>FeedsManager.on_deleteButton_clicked</h4>
315 <b>on_deleteButton_clicked</b>(<i></i>)
316 <p>
317 Private slot to delete the selected feed.
318 </p><a NAME="FeedsManager.on_editButton_clicked" ID="FeedsManager.on_editButton_clicked"></a>
319 <h4>FeedsManager.on_editButton_clicked</h4>
320 <b>on_editButton_clicked</b>(<i></i>)
321 <p>
322 Private slot to edit the selected feed.
323 </p><a NAME="FeedsManager.on_feedsTree_itemSelectionChanged" ID="FeedsManager.on_feedsTree_itemSelectionChanged"></a>
324 <h4>FeedsManager.on_feedsTree_itemSelectionChanged</h4>
325 <b>on_feedsTree_itemSelectionChanged</b>(<i></i>)
326 <p>
327 Private slot to enable the various buttons depending on the selection.
328 </p><a NAME="FeedsManager.on_reloadAllButton_clicked" ID="FeedsManager.on_reloadAllButton_clicked"></a>
329 <h4>FeedsManager.on_reloadAllButton_clicked</h4>
330 <b>on_reloadAllButton_clicked</b>(<i></i>)
331 <p>
332 Private slot to reload all feeds.
333 </p><a NAME="FeedsManager.on_reloadButton_clicked" ID="FeedsManager.on_reloadButton_clicked"></a>
334 <h4>FeedsManager.on_reloadButton_clicked</h4>
335 <b>on_reloadButton_clicked</b>(<i></i>)
336 <p>
337 Private slot to reload the selected feed.
338 </p><a NAME="FeedsManager.show" ID="FeedsManager.show"></a>
339 <h4>FeedsManager.show</h4>
340 <b>show</b>(<i></i>)
341 <p>
342 Public slot to show the feeds manager dialog.
343 </p>
344 <div align="right"><a href="#top">Up</a></div>
345 <hr />
346 </body></html>

Mercurial Repository: eric

eric ide

mercurial