eric6/Documentation/Source/eric6.Helpviewer.Feeds.FeedsManager.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.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.Helpviewer.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>newUrl(QUrl, str)</dt>
49 <dd>
50 emitted to open a URL in a new tab
51 </dd><dt>openUrl(QUrl, str)</dt>
52 <dd>
53 emitted to open a URL in the current tab
54 </dd>
55 </dl>
56 <h3>Derived from</h3>
57 QDialog, Ui_FeedsManager
58 <h3>Class Attributes</h3>
59 <table>
60 <tr><td>ErrorDataRole</td></tr><tr><td>UrlStringRole</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#FeedsManager.__init__">FeedsManager</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#FeedsManager.__addFeedItem">__addFeedItem</a></td>
73 <td>Private slot to add a top level feed item.</td>
74 </tr><tr>
75 <td><a href="#FeedsManager.__copyUrlToClipboard">__copyUrlToClipboard</a></td>
76 <td>Private slot to copy the URL of the selected item to the clipboard.</td>
77 </tr><tr>
78 <td><a href="#FeedsManager.__customContextMenuRequested">__customContextMenuRequested</a></td>
79 <td>Private slot to handle the context menu request for the bookmarks tree.</td>
80 </tr><tr>
81 <td><a href="#FeedsManager.__enableButtons">__enableButtons</a></td>
82 <td>Private slot to disable/enable various buttons.</td>
83 </tr><tr>
84 <td><a href="#FeedsManager.__feedLoaded">__feedLoaded</a></td>
85 <td>Private slot to extract the loaded feed data.</td>
86 </tr><tr>
87 <td><a href="#FeedsManager.__itemActivated">__itemActivated</a></td>
88 <td>Private slot to handle the activation of an item.</td>
89 </tr><tr>
90 <td><a href="#FeedsManager.__load">__load</a></td>
91 <td>Private method to load the feeds data.</td>
92 </tr><tr>
93 <td><a href="#FeedsManager.__openMessage">__openMessage</a></td>
94 <td>Private method to open a feed message.</td>
95 </tr><tr>
96 <td><a href="#FeedsManager.__openMessageInCurrentTab">__openMessageInCurrentTab</a></td>
97 <td>Private slot to open a feed message in the current browser tab.</td>
98 </tr><tr>
99 <td><a href="#FeedsManager.__openMessageInNewTab">__openMessageInNewTab</a></td>
100 <td>Private slot to open a feed message in a new browser tab.</td>
101 </tr><tr>
102 <td><a href="#FeedsManager.__reloadFeed">__reloadFeed</a></td>
103 <td>Private method to reload the given feed.</td>
104 </tr><tr>
105 <td><a href="#FeedsManager.__save">__save</a></td>
106 <td>Private method to store the feeds data.</td>
107 </tr><tr>
108 <td><a href="#FeedsManager.__showError">__showError</a></td>
109 <td>Private slot to show error info for a failed load operation.</td>
110 </tr><tr>
111 <td><a href="#FeedsManager.addFeed">addFeed</a></td>
112 <td>Public method to add a feed.</td>
113 </tr><tr>
114 <td><a href="#FeedsManager.on_deleteButton_clicked">on_deleteButton_clicked</a></td>
115 <td>Private slot to delete the selected feed.</td>
116 </tr><tr>
117 <td><a href="#FeedsManager.on_editButton_clicked">on_editButton_clicked</a></td>
118 <td>Private slot to edit the selected feed.</td>
119 </tr><tr>
120 <td><a href="#FeedsManager.on_feedsTree_itemSelectionChanged">on_feedsTree_itemSelectionChanged</a></td>
121 <td>Private slot to enable the various buttons depending on the selection.</td>
122 </tr><tr>
123 <td><a href="#FeedsManager.on_reloadAllButton_clicked">on_reloadAllButton_clicked</a></td>
124 <td>Private slot to reload all feeds.</td>
125 </tr><tr>
126 <td><a href="#FeedsManager.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
127 <td>Private slot to reload the selected feed.</td>
128 </tr><tr>
129 <td><a href="#FeedsManager.show">show</a></td>
130 <td>Public slot to show the feeds manager dialog.</td>
131 </tr>
132 </table>
133 <h3>Static Methods</h3>
134 <table>
135 <tr><td>None</td></tr>
136 </table>
137 <a NAME="FeedsManager.__init__" ID="FeedsManager.__init__"></a>
138 <h4>FeedsManager (Constructor)</h4>
139 <b>FeedsManager</b>(<i>parent=None</i>)
140 <p>
141 Constructor
142 </p><dl>
143 <dt><i>parent</i></dt>
144 <dd>
145 reference to the parent widget (QWidget)
146 </dd>
147 </dl><a NAME="FeedsManager.__addFeedItem" ID="FeedsManager.__addFeedItem"></a>
148 <h4>FeedsManager.__addFeedItem</h4>
149 <b>__addFeedItem</b>(<i>feed</i>)
150 <p>
151 Private slot to add a top level feed item.
152 </p><dl>
153 <dt><i>feed</i></dt>
154 <dd>
155 tuple containing feed info (URL, title, icon)
156 (string, string, QIcon)
157 </dd>
158 </dl><a NAME="FeedsManager.__copyUrlToClipboard" ID="FeedsManager.__copyUrlToClipboard"></a>
159 <h4>FeedsManager.__copyUrlToClipboard</h4>
160 <b>__copyUrlToClipboard</b>(<i></i>)
161 <p>
162 Private slot to copy the URL of the selected item to the clipboard.
163 </p><a NAME="FeedsManager.__customContextMenuRequested" ID="FeedsManager.__customContextMenuRequested"></a>
164 <h4>FeedsManager.__customContextMenuRequested</h4>
165 <b>__customContextMenuRequested</b>(<i>pos</i>)
166 <p>
167 Private slot to handle the context menu request for the bookmarks tree.
168 </p><dl>
169 <dt><i>pos</i></dt>
170 <dd>
171 position the context menu was requested (QPoint)
172 </dd>
173 </dl><a NAME="FeedsManager.__enableButtons" ID="FeedsManager.__enableButtons"></a>
174 <h4>FeedsManager.__enableButtons</h4>
175 <b>__enableButtons</b>(<i></i>)
176 <p>
177 Private slot to disable/enable various buttons.
178 </p><a NAME="FeedsManager.__feedLoaded" ID="FeedsManager.__feedLoaded"></a>
179 <h4>FeedsManager.__feedLoaded</h4>
180 <b>__feedLoaded</b>(<i>reply</i>)
181 <p>
182 Private slot to extract the loaded feed data.
183 </p><dl>
184 <dt><i>reply</i> (QNetworkReply)</dt>
185 <dd>
186 reference to the network reply
187 </dd>
188 </dl><a NAME="FeedsManager.__itemActivated" ID="FeedsManager.__itemActivated"></a>
189 <h4>FeedsManager.__itemActivated</h4>
190 <b>__itemActivated</b>(<i>itm, column</i>)
191 <p>
192 Private slot to handle the activation of an item.
193 </p><dl>
194 <dt><i>itm</i></dt>
195 <dd>
196 reference to the activated item (QTreeWidgetItem)
197 </dd><dt><i>column</i></dt>
198 <dd>
199 column of the activation (integer)
200 </dd>
201 </dl><a NAME="FeedsManager.__load" ID="FeedsManager.__load"></a>
202 <h4>FeedsManager.__load</h4>
203 <b>__load</b>(<i></i>)
204 <p>
205 Private method to load the feeds data.
206 </p><a NAME="FeedsManager.__openMessage" ID="FeedsManager.__openMessage"></a>
207 <h4>FeedsManager.__openMessage</h4>
208 <b>__openMessage</b>(<i>newTab</i>)
209 <p>
210 Private method to open a feed message.
211 </p><dl>
212 <dt><i>newTab</i></dt>
213 <dd>
214 flag indicating to open the feed message in a new tab
215 (boolean)
216 </dd>
217 </dl><a NAME="FeedsManager.__openMessageInCurrentTab" ID="FeedsManager.__openMessageInCurrentTab"></a>
218 <h4>FeedsManager.__openMessageInCurrentTab</h4>
219 <b>__openMessageInCurrentTab</b>(<i></i>)
220 <p>
221 Private slot to open a feed message in the current browser tab.
222 </p><a NAME="FeedsManager.__openMessageInNewTab" ID="FeedsManager.__openMessageInNewTab"></a>
223 <h4>FeedsManager.__openMessageInNewTab</h4>
224 <b>__openMessageInNewTab</b>(<i></i>)
225 <p>
226 Private slot to open a feed message in a new browser tab.
227 </p><a NAME="FeedsManager.__reloadFeed" ID="FeedsManager.__reloadFeed"></a>
228 <h4>FeedsManager.__reloadFeed</h4>
229 <b>__reloadFeed</b>(<i>itm</i>)
230 <p>
231 Private method to reload the given feed.
232 </p><dl>
233 <dt><i>itm</i></dt>
234 <dd>
235 feed item to be reloaded (QTreeWidgetItem)
236 </dd>
237 </dl><a NAME="FeedsManager.__save" ID="FeedsManager.__save"></a>
238 <h4>FeedsManager.__save</h4>
239 <b>__save</b>(<i></i>)
240 <p>
241 Private method to store the feeds data.
242 </p><a NAME="FeedsManager.__showError" ID="FeedsManager.__showError"></a>
243 <h4>FeedsManager.__showError</h4>
244 <b>__showError</b>(<i></i>)
245 <p>
246 Private slot to show error info for a failed load operation.
247 </p><a NAME="FeedsManager.addFeed" ID="FeedsManager.addFeed"></a>
248 <h4>FeedsManager.addFeed</h4>
249 <b>addFeed</b>(<i>urlString, title, icon</i>)
250 <p>
251 Public method to add a feed.
252 </p><dl>
253 <dt><i>urlString</i></dt>
254 <dd>
255 URL of the feed (string)
256 </dd><dt><i>title</i></dt>
257 <dd>
258 title of the feed (string)
259 </dd><dt><i>icon</i></dt>
260 <dd>
261 icon for the feed (QIcon)
262 </dd>
263 </dl><dl>
264 <dt>Returns:</dt>
265 <dd>
266 flag indicating a successful addition of the feed (boolean)
267 </dd>
268 </dl><a NAME="FeedsManager.on_deleteButton_clicked" ID="FeedsManager.on_deleteButton_clicked"></a>
269 <h4>FeedsManager.on_deleteButton_clicked</h4>
270 <b>on_deleteButton_clicked</b>(<i></i>)
271 <p>
272 Private slot to delete the selected feed.
273 </p><a NAME="FeedsManager.on_editButton_clicked" ID="FeedsManager.on_editButton_clicked"></a>
274 <h4>FeedsManager.on_editButton_clicked</h4>
275 <b>on_editButton_clicked</b>(<i></i>)
276 <p>
277 Private slot to edit the selected feed.
278 </p><a NAME="FeedsManager.on_feedsTree_itemSelectionChanged" ID="FeedsManager.on_feedsTree_itemSelectionChanged"></a>
279 <h4>FeedsManager.on_feedsTree_itemSelectionChanged</h4>
280 <b>on_feedsTree_itemSelectionChanged</b>(<i></i>)
281 <p>
282 Private slot to enable the various buttons depending on the selection.
283 </p><a NAME="FeedsManager.on_reloadAllButton_clicked" ID="FeedsManager.on_reloadAllButton_clicked"></a>
284 <h4>FeedsManager.on_reloadAllButton_clicked</h4>
285 <b>on_reloadAllButton_clicked</b>(<i></i>)
286 <p>
287 Private slot to reload all feeds.
288 </p><a NAME="FeedsManager.on_reloadButton_clicked" ID="FeedsManager.on_reloadButton_clicked"></a>
289 <h4>FeedsManager.on_reloadButton_clicked</h4>
290 <b>on_reloadButton_clicked</b>(<i></i>)
291 <p>
292 Private slot to reload the selected feed.
293 </p><a NAME="FeedsManager.show" ID="FeedsManager.show"></a>
294 <h4>FeedsManager.show</h4>
295 <b>show</b>(<i></i>)
296 <p>
297 Public slot to show the feeds manager dialog.
298 </p>
299 <div align="right"><a href="#top">Up</a></div>
300 <hr />
301 </body></html>

eric ide

mercurial