Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html

src/eric7/Documentation/Source/eric7.HelpViewer.OpenPagesWidget.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.HelpViewer.OpenPagesWidget</h1> 9 <h1>eric7.HelpViewer.OpenPagesWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a widget showing the list of open pages. 11 Module implementing a widget showing the list of open pages.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#OpenPagesWidget">OpenPagesWidget</a></td> 22 <td><a href="#OpenPagesWidget">OpenPagesWidget</a></td>
25 <td>Class implementing a widget showing the list of open pages.</td> 23 <td>Class implementing a widget showing the list of open pages.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="OpenPagesWidget" ID="OpenPagesWidget"></a> 34 <a NAME="OpenPagesWidget" ID="OpenPagesWidget"></a>
36 <h2>OpenPagesWidget</h2> 35 <h2>OpenPagesWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a widget showing the list of open pages. 37 Class implementing a widget showing the list of open pages.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>currentPageChanged(index)</dt> 43 <dt>currentPageChanged(index)</dt>
45 <dd> 44 <dd>
48 </dd> 47 </dd>
49 </dl> 48 </dl>
50 <h3>Derived from</h3> 49 <h3>Derived from</h3>
51 QListWidget 50 QListWidget
52 <h3>Class Attributes</h3> 51 <h3>Class Attributes</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Class Methods</h3> 56 <h3>Class Methods</h3>
58 57 <table>
59 <table> 58 <tr><td>None</td></tr>
60 <tr><td>None</td></tr> 59 </table>
61 </table> 60
62 <h3>Methods</h3> 61 <h3>Methods</h3>
63 62 <table>
64 <table>
65
66 <tr> 63 <tr>
67 <td><a href="#OpenPagesWidget.__init__">OpenPagesWidget</a></td> 64 <td><a href="#OpenPagesWidget.__init__">OpenPagesWidget</a></td>
68 <td>Constructor</td> 65 <td>Constructor</td>
69 </tr> 66 </tr>
70 <tr> 67 <tr>
126 <tr> 123 <tr>
127 <td><a href="#OpenPagesWidget.insertPage">insertPage</a></td> 124 <td><a href="#OpenPagesWidget.insertPage">insertPage</a></td>
128 <td>Public method to insert a viewer page into our list.</td> 125 <td>Public method to insert a viewer page into our list.</td>
129 </tr> 126 </tr>
130 </table> 127 </table>
128
131 <h3>Static Methods</h3> 129 <h3>Static Methods</h3>
132 130 <table>
133 <table> 131 <tr><td>None</td></tr>
134 <tr><td>None</td></tr> 132 </table>
135 </table> 133
136 134
137 <a NAME="OpenPagesWidget.__init__" ID="OpenPagesWidget.__init__"></a> 135 <a NAME="OpenPagesWidget.__init__" ID="OpenPagesWidget.__init__"></a>
138 <h4>OpenPagesWidget (Constructor)</h4> 136 <h4>OpenPagesWidget (Constructor)</h4>
139 <b>OpenPagesWidget</b>(<i>stack, parent=None</i>) 137 <b>OpenPagesWidget</b>(<i>stack, parent=None</i>)
140
141 <p> 138 <p>
142 Constructor 139 Constructor
143 </p> 140 </p>
141
144 <dl> 142 <dl>
145 143
146 <dt><i>stack</i> (QStackedWidget)</dt> 144 <dt><i>stack</i> (QStackedWidget)</dt>
147 <dd> 145 <dd>
148 reference to the stack widget containing the open 146 reference to the stack widget containing the open
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="OpenPagesWidget.__contextMenuClose" ID="OpenPagesWidget.__contextMenuClose"></a> 154 <a NAME="OpenPagesWidget.__contextMenuClose" ID="OpenPagesWidget.__contextMenuClose"></a>
157 <h4>OpenPagesWidget.__contextMenuClose</h4> 155 <h4>OpenPagesWidget.__contextMenuClose</h4>
158 <b>__contextMenuClose</b>(<i></i>) 156 <b>__contextMenuClose</b>(<i></i>)
159
160 <p> 157 <p>
161 Private slot to close a page via the context menu. 158 Private slot to close a page via the context menu.
162 </p> 159 </p>
160
163 <a NAME="OpenPagesWidget.__contextMenuCloseAll" ID="OpenPagesWidget.__contextMenuCloseAll"></a> 161 <a NAME="OpenPagesWidget.__contextMenuCloseAll" ID="OpenPagesWidget.__contextMenuCloseAll"></a>
164 <h4>OpenPagesWidget.__contextMenuCloseAll</h4> 162 <h4>OpenPagesWidget.__contextMenuCloseAll</h4>
165 <b>__contextMenuCloseAll</b>(<i></i>) 163 <b>__contextMenuCloseAll</b>(<i></i>)
166
167 <p> 164 <p>
168 Private slot to close all pages via the context menu. 165 Private slot to close all pages via the context menu.
169 </p> 166 </p>
167
170 <a NAME="OpenPagesWidget.__contextMenuCloseOthers" ID="OpenPagesWidget.__contextMenuCloseOthers"></a> 168 <a NAME="OpenPagesWidget.__contextMenuCloseOthers" ID="OpenPagesWidget.__contextMenuCloseOthers"></a>
171 <h4>OpenPagesWidget.__contextMenuCloseOthers</h4> 169 <h4>OpenPagesWidget.__contextMenuCloseOthers</h4>
172 <b>__contextMenuCloseOthers</b>(<i></i>) 170 <b>__contextMenuCloseOthers</b>(<i></i>)
173
174 <p> 171 <p>
175 Private slot to close all other pages via the context menu. 172 Private slot to close all other pages via the context menu.
176 </p> 173 </p>
174
177 <a NAME="OpenPagesWidget.__contextMenuCopyUrlToClipboard" ID="OpenPagesWidget.__contextMenuCopyUrlToClipboard"></a> 175 <a NAME="OpenPagesWidget.__contextMenuCopyUrlToClipboard" ID="OpenPagesWidget.__contextMenuCopyUrlToClipboard"></a>
178 <h4>OpenPagesWidget.__contextMenuCopyUrlToClipboard</h4> 176 <h4>OpenPagesWidget.__contextMenuCopyUrlToClipboard</h4>
179 <b>__contextMenuCopyUrlToClipboard</b>(<i></i>) 177 <b>__contextMenuCopyUrlToClipboard</b>(<i></i>)
180
181 <p> 178 <p>
182 Private slot to copy the URL to the clipboard. 179 Private slot to copy the URL to the clipboard.
183 </p> 180 </p>
181
184 <a NAME="OpenPagesWidget.__currentPageChanged" ID="OpenPagesWidget.__currentPageChanged"></a> 182 <a NAME="OpenPagesWidget.__currentPageChanged" ID="OpenPagesWidget.__currentPageChanged"></a>
185 <h4>OpenPagesWidget.__currentPageChanged</h4> 183 <h4>OpenPagesWidget.__currentPageChanged</h4>
186 <b>__currentPageChanged</b>(<i>index</i>) 184 <b>__currentPageChanged</b>(<i>index</i>)
187
188 <p> 185 <p>
189 Private slot to handle a change of the shown page. 186 Private slot to handle a change of the shown page.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>index</i> (int)</dt> 191 <dt><i>index</i> (int)</dt>
194 <dd> 192 <dd>
195 index of the current page 193 index of the current page
196 </dd> 194 </dd>
197 </dl> 195 </dl>
198 <a NAME="OpenPagesWidget.__currentRowChanged" ID="OpenPagesWidget.__currentRowChanged"></a> 196 <a NAME="OpenPagesWidget.__currentRowChanged" ID="OpenPagesWidget.__currentRowChanged"></a>
199 <h4>OpenPagesWidget.__currentRowChanged</h4> 197 <h4>OpenPagesWidget.__currentRowChanged</h4>
200 <b>__currentRowChanged</b>(<i>row</i>) 198 <b>__currentRowChanged</b>(<i>row</i>)
201
202 <p> 199 <p>
203 Private slot handling a change of the current row. 200 Private slot handling a change of the current row.
204 </p> 201 </p>
202
205 <dl> 203 <dl>
206 204
207 <dt><i>row</i> (int)</dt> 205 <dt><i>row</i> (int)</dt>
208 <dd> 206 <dd>
209 current row 207 current row
210 </dd> 208 </dd>
211 </dl> 209 </dl>
212 <a NAME="OpenPagesWidget.__initContextMenu" ID="OpenPagesWidget.__initContextMenu"></a> 210 <a NAME="OpenPagesWidget.__initContextMenu" ID="OpenPagesWidget.__initContextMenu"></a>
213 <h4>OpenPagesWidget.__initContextMenu</h4> 211 <h4>OpenPagesWidget.__initContextMenu</h4>
214 <b>__initContextMenu</b>(<i></i>) 212 <b>__initContextMenu</b>(<i></i>)
215
216 <p> 213 <p>
217 Private method to initialize the context menu. 214 Private method to initialize the context menu.
218 </p> 215 </p>
216
219 <a NAME="OpenPagesWidget.__removeViewer" ID="OpenPagesWidget.__removeViewer"></a> 217 <a NAME="OpenPagesWidget.__removeViewer" ID="OpenPagesWidget.__removeViewer"></a>
220 <h4>OpenPagesWidget.__removeViewer</h4> 218 <h4>OpenPagesWidget.__removeViewer</h4>
221 <b>__removeViewer</b>(<i>row</i>) 219 <b>__removeViewer</b>(<i>row</i>)
222
223 <p> 220 <p>
224 Private method to remove a viewer page. 221 Private method to remove a viewer page.
225 </p> 222 </p>
223
226 <dl> 224 <dl>
227 225
228 <dt><i>row</i> (int)</dt> 226 <dt><i>row</i> (int)</dt>
229 <dd> 227 <dd>
230 row associated with the viewer 228 row associated with the viewer
231 </dd> 229 </dd>
232 </dl> 230 </dl>
233 <a NAME="OpenPagesWidget.__showContextMenu" ID="OpenPagesWidget.__showContextMenu"></a> 231 <a NAME="OpenPagesWidget.__showContextMenu" ID="OpenPagesWidget.__showContextMenu"></a>
234 <h4>OpenPagesWidget.__showContextMenu</h4> 232 <h4>OpenPagesWidget.__showContextMenu</h4>
235 <b>__showContextMenu</b>(<i>point</i>) 233 <b>__showContextMenu</b>(<i>point</i>)
236
237 <p> 234 <p>
238 Private slot to handle the customContextMenuRequested signal of 235 Private slot to handle the customContextMenuRequested signal of
239 the viewlist. 236 the viewlist.
240 </p> 237 </p>
238
241 <dl> 239 <dl>
242 240
243 <dt><i>point</i> (QPoint)</dt> 241 <dt><i>point</i> (QPoint)</dt>
244 <dd> 242 <dd>
245 position to open the menu at 243 position to open the menu at
246 </dd> 244 </dd>
247 </dl> 245 </dl>
248 <a NAME="OpenPagesWidget.__viewerTitleChanged" ID="OpenPagesWidget.__viewerTitleChanged"></a> 246 <a NAME="OpenPagesWidget.__viewerTitleChanged" ID="OpenPagesWidget.__viewerTitleChanged"></a>
249 <h4>OpenPagesWidget.__viewerTitleChanged</h4> 247 <h4>OpenPagesWidget.__viewerTitleChanged</h4>
250 <b>__viewerTitleChanged</b>(<i>viewer</i>) 248 <b>__viewerTitleChanged</b>(<i>viewer</i>)
251
252 <p> 249 <p>
253 Private method to handle the change of a viewer title. 250 Private method to handle the change of a viewer title.
254 </p> 251 </p>
252
255 <dl> 253 <dl>
256 254
257 <dt><i>viewer</i> (HelpViewerImpl)</dt> 255 <dt><i>viewer</i> (HelpViewerImpl)</dt>
258 <dd> 256 <dd>
259 reference to the viewer that change title 257 reference to the viewer that change title
260 </dd> 258 </dd>
261 </dl> 259 </dl>
262 <a NAME="OpenPagesWidget.addPage" ID="OpenPagesWidget.addPage"></a> 260 <a NAME="OpenPagesWidget.addPage" ID="OpenPagesWidget.addPage"></a>
263 <h4>OpenPagesWidget.addPage</h4> 261 <h4>OpenPagesWidget.addPage</h4>
264 <b>addPage</b>(<i>viewer, background=False</i>) 262 <b>addPage</b>(<i>viewer, background=False</i>)
265
266 <p> 263 <p>
267 Public method to add a viewer page to our list. 264 Public method to add a viewer page to our list.
268 </p> 265 </p>
266
269 <dl> 267 <dl>
270 268
271 <dt><i>viewer</i> (HelpViewerImpl)</dt> 269 <dt><i>viewer</i> (HelpViewerImpl)</dt>
272 <dd> 270 <dd>
273 reference to the viewer object 271 reference to the viewer object
279 </dd> 277 </dd>
280 </dl> 278 </dl>
281 <a NAME="OpenPagesWidget.closeAllPages" ID="OpenPagesWidget.closeAllPages"></a> 279 <a NAME="OpenPagesWidget.closeAllPages" ID="OpenPagesWidget.closeAllPages"></a>
282 <h4>OpenPagesWidget.closeAllPages</h4> 280 <h4>OpenPagesWidget.closeAllPages</h4>
283 <b>closeAllPages</b>(<i></i>) 281 <b>closeAllPages</b>(<i></i>)
284
285 <p> 282 <p>
286 Public slot to close all pages. 283 Public slot to close all pages.
287 </p> 284 </p>
285
288 <a NAME="OpenPagesWidget.closeCurrentPage" ID="OpenPagesWidget.closeCurrentPage"></a> 286 <a NAME="OpenPagesWidget.closeCurrentPage" ID="OpenPagesWidget.closeCurrentPage"></a>
289 <h4>OpenPagesWidget.closeCurrentPage</h4> 287 <h4>OpenPagesWidget.closeCurrentPage</h4>
290 <b>closeCurrentPage</b>(<i></i>) 288 <b>closeCurrentPage</b>(<i></i>)
291
292 <p> 289 <p>
293 Public slot to close the current page. 290 Public slot to close the current page.
294 </p> 291 </p>
292
295 <a NAME="OpenPagesWidget.closeOtherPages" ID="OpenPagesWidget.closeOtherPages"></a> 293 <a NAME="OpenPagesWidget.closeOtherPages" ID="OpenPagesWidget.closeOtherPages"></a>
296 <h4>OpenPagesWidget.closeOtherPages</h4> 294 <h4>OpenPagesWidget.closeOtherPages</h4>
297 <b>closeOtherPages</b>(<i></i>) 295 <b>closeOtherPages</b>(<i></i>)
298
299 <p> 296 <p>
300 Public slot to close all other pages. 297 Public slot to close all other pages.
301 </p> 298 </p>
299
302 <a NAME="OpenPagesWidget.insertPage" ID="OpenPagesWidget.insertPage"></a> 300 <a NAME="OpenPagesWidget.insertPage" ID="OpenPagesWidget.insertPage"></a>
303 <h4>OpenPagesWidget.insertPage</h4> 301 <h4>OpenPagesWidget.insertPage</h4>
304 <b>insertPage</b>(<i>index, viewer, background=False</i>) 302 <b>insertPage</b>(<i>index, viewer, background=False</i>)
305
306 <p> 303 <p>
307 Public method to insert a viewer page into our list. 304 Public method to insert a viewer page into our list.
308 </p> 305 </p>
306
309 <dl> 307 <dl>
310 308
311 <dt><i>index</i> (int)</dt> 309 <dt><i>index</i> (int)</dt>
312 <dd> 310 <dd>
313 index to insert at 311 index to insert at

Mercurial Repository: eric

eric ide

mercurial