Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.Feeds.FeedsManager.html

Documentation/Source/eric5.Helpviewer.Feeds.FeedsManager.html

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

Mercurial Repository: eric

eric ide

mercurial