Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Helpviewer.HelpWindow.html

Documentation/Source/eric5.Helpviewer.HelpWindow.html

changeset 653
0540f3c52b46
parent 638
265c31231d9d
child 668
b0061a6f7484
equal deleted inserted replaced
651:e8020b9ac2b9 653:0540f3c52b46
57 </dl> 57 </dl>
58 <h3>Derived from</h3> 58 <h3>Derived from</h3>
59 QMainWindow 59 QMainWindow
60 <h3>Class Attributes</h3> 60 <h3>Class Attributes</h3>
61 <table> 61 <table>
62 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_passwordManager</td></tr><tr><td>helpClosed</td></tr><tr><td>helpwindows</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>zoomTextOnlyChanged</td></tr> 62 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_passwordManager</td></tr><tr><td>helpClosed</td></tr><tr><td>helpwindows</td></tr><tr><td>maxMenuFilePathLen</td></tr><tr><td>privacyChanged</td></tr><tr><td>zoomTextOnlyChanged</td></tr>
63 </table> 63 </table>
64 <h3>Methods</h3> 64 <h3>Methods</h3>
65 <table> 65 <table>
66 <tr> 66 <tr>
67 <td><a href="#HelpWindow.__init__">HelpWindow</a></td> 67 <td><a href="#HelpWindow.__init__">HelpWindow</a></td>
119 <td>Private slot called to handle the forward action.</td> 119 <td>Private slot called to handle the forward action.</td>
120 </tr><tr> 120 </tr><tr>
121 <td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td> 121 <td><a href="#HelpWindow.__getWebIcon">__getWebIcon</a></td>
122 <td>Private static method to fetch the icon for a URL.</td> 122 <td>Private static method to fetch the icon for a URL.</td>
123 </tr><tr> 123 </tr><tr>
124 <td><a href="#HelpWindow.__guessUrlFromPath">__guessUrlFromPath</a></td>
125 <td>Private method to guess an URL given a path string.</td>
126 </tr><tr>
127 <td><a href="#HelpWindow.__hideIndexWindow">__hideIndexWindow</a></td> 124 <td><a href="#HelpWindow.__hideIndexWindow">__hideIndexWindow</a></td>
128 <td>Private method to hide the index window.</td> 125 <td>Private method to hide the index window.</td>
129 </tr><tr> 126 </tr><tr>
130 <td><a href="#HelpWindow.__hideSearchWindow">__hideSearchWindow</a></td> 127 <td><a href="#HelpWindow.__hideSearchWindow">__hideSearchWindow</a></td>
131 <td>Private method to hide the search window.</td> 128 <td>Private method to hide the search window.</td>
191 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in the current tab.</td> 188 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in the current tab.</td>
192 </tr><tr> 189 </tr><tr>
193 <td><a href="#HelpWindow.__openUrlNewTab">__openUrlNewTab</a></td> 190 <td><a href="#HelpWindow.__openUrlNewTab">__openUrlNewTab</a></td>
194 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in a new tab.</td> 191 <td>Private slot to load a URL from the bookmarks menu or bookmarks toolbar in a new tab.</td>
195 </tr><tr> 192 </tr><tr>
196 <td><a href="#HelpWindow.__pathSelected">__pathSelected</a></td>
197 <td>Private slot called when a file is selected in the combobox.</td>
198 </tr><tr>
199 <td><a href="#HelpWindow.__prevTab">__prevTab</a></td> 193 <td><a href="#HelpWindow.__prevTab">__prevTab</a></td>
200 <td>Private slot used to show the previous tab.</td> 194 <td>Private slot used to show the previous tab.</td>
201 </tr><tr> 195 </tr><tr>
202 <td><a href="#HelpWindow.__privateBrowsing">__privateBrowsing</a></td> 196 <td><a href="#HelpWindow.__privateBrowsing">__privateBrowsing</a></td>
203 <td>Private slot to switch private browsing.</td> 197 <td>Private slot to switch private browsing.</td>
212 <td>Private slot to search for a word.</td> 206 <td>Private slot to search for a word.</td>
213 </tr><tr> 207 </tr><tr>
214 <td><a href="#HelpWindow.__setIconDatabasePath">__setIconDatabasePath</a></td> 208 <td><a href="#HelpWindow.__setIconDatabasePath">__setIconDatabasePath</a></td>
215 <td>Private method to set the favicons path.</td> 209 <td>Private method to set the favicons path.</td>
216 </tr><tr> 210 </tr><tr>
217 <td><a href="#HelpWindow.__setPathComboBackground">__setPathComboBackground</a></td>
218 <td>Private slot to change the path combo background to indicate save URLs.</td>
219 </tr><tr>
220 <td><a href="#HelpWindow.__setTextEncoding">__setTextEncoding</a></td> 211 <td><a href="#HelpWindow.__setTextEncoding">__setTextEncoding</a></td>
221 <td>Private slot to set the selected text encoding as the default for this session.</td> 212 <td>Private slot to set the selected text encoding as the default for this session.</td>
222 </tr><tr> 213 </tr><tr>
223 <td><a href="#HelpWindow.__setupFilterCombo">__setupFilterCombo</a></td> 214 <td><a href="#HelpWindow.__setupFilterCombo">__setupFilterCombo</a></td>
224 <td>Private slot to setup the filter combo box.</td> 215 <td>Private slot to setup the filter combo box.</td>
272 <td>Private method to show the search window.</td> 263 <td>Private method to show the search window.</td>
273 </tr><tr> 264 </tr><tr>
274 <td><a href="#HelpWindow.__showTocWindow">__showTocWindow</a></td> 265 <td><a href="#HelpWindow.__showTocWindow">__showTocWindow</a></td>
275 <td>Private method to show the table of contents window.</td> 266 <td>Private method to show the table of contents window.</td>
276 </tr><tr> 267 </tr><tr>
277 <td><a href="#HelpWindow.__sourceChanged">__sourceChanged</a></td>
278 <td>Private slot called when the displayed text of the combobox is changed.</td>
279 </tr><tr>
280 <td><a href="#HelpWindow.__stopLoading">__stopLoading</a></td> 268 <td><a href="#HelpWindow.__stopLoading">__stopLoading</a></td>
281 <td>Private slot called to handle loading of the current page.</td> 269 <td>Private slot called to handle loading of the current page.</td>
282 </tr><tr> 270 </tr><tr>
283 <td><a href="#HelpWindow.__switchTab">__switchTab</a></td> 271 <td><a href="#HelpWindow.__switchTab">__switchTab</a></td>
284 <td>Private slot used to switch between the current and the previous current tab.</td> 272 <td>Private slot used to switch between the current and the previous current tab.</td>
347 <td>Class method to get a reference to the history manager.</td> 335 <td>Class method to get a reference to the history manager.</td>
348 </tr><tr> 336 </tr><tr>
349 <td><a href="#HelpWindow.icon">icon</a></td> 337 <td><a href="#HelpWindow.icon">icon</a></td>
350 <td>Class method to get the icon for an URL.</td> 338 <td>Class method to get the icon for an URL.</td>
351 </tr><tr> 339 </tr><tr>
352 <td><a href="#HelpWindow.iconChanged">iconChanged</a></td>
353 <td>Public slot to change the icon shown to the left of the URL entry.</td>
354 </tr><tr>
355 <td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td> 340 <td><a href="#HelpWindow.networkAccessManager">networkAccessManager</a></td>
356 <td>Class method to get a reference to the network access manager.</td> 341 <td>Class method to get a reference to the network access manager.</td>
357 </tr><tr> 342 </tr><tr>
358 <td><a href="#HelpWindow.newTab">newTab</a></td> 343 <td><a href="#HelpWindow.newTab">newTab</a></td>
359 <td>Public slot called to open a new help window tab.</td> 344 <td>Public slot called to open a new help window tab.</td>
368 <td>Class method to get a reference to the password manager.</td> 353 <td>Class method to get a reference to the password manager.</td>
369 </tr><tr> 354 </tr><tr>
370 <td><a href="#HelpWindow.preferencesChanged">preferencesChanged</a></td> 355 <td><a href="#HelpWindow.preferencesChanged">preferencesChanged</a></td>
371 <td>Public slot to handle a change of preferences.</td> 356 <td>Public slot to handle a change of preferences.</td>
372 </tr><tr> 357 </tr><tr>
373 <td><a href="#HelpWindow.progressBar">progressBar</a></td>
374 <td>Public method to get a reference to the load progress bar.</td>
375 </tr><tr>
376 <td><a href="#HelpWindow.search">search</a></td> 358 <td><a href="#HelpWindow.search">search</a></td>
377 <td>Public method to search for a word.</td> 359 <td>Public method to search for a word.</td>
378 </tr><tr> 360 </tr><tr>
379 <td><a href="#HelpWindow.searchEnginesAction">searchEnginesAction</a></td> 361 <td><a href="#HelpWindow.searchEnginesAction">searchEnginesAction</a></td>
380 <td>Public method to get a reference to the search engines configuration action.</td> 362 <td>Public method to get a reference to the search engines configuration action.</td>
385 <td><a href="#HelpWindow.setForwardAvailable">setForwardAvailable</a></td> 367 <td><a href="#HelpWindow.setForwardAvailable">setForwardAvailable</a></td>
386 <td>Public slot called when forward references are available.</td> 368 <td>Public slot called when forward references are available.</td>
387 </tr><tr> 369 </tr><tr>
388 <td><a href="#HelpWindow.setLoadingActions">setLoadingActions</a></td> 370 <td><a href="#HelpWindow.setLoadingActions">setLoadingActions</a></td>
389 <td>Public slot to set the loading dependent actions.</td> 371 <td>Public slot to set the loading dependent actions.</td>
372 </tr><tr>
373 <td><a href="#HelpWindow.setPrivateMode">setPrivateMode</a></td>
374 <td>Public method to set the privacy mode.</td>
390 </tr> 375 </tr>
391 </table> 376 </table>
392 <a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a> 377 <a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
393 <h4>HelpWindow (Constructor)</h4> 378 <h4>HelpWindow (Constructor)</h4>
394 <b>HelpWindow</b>(<i>home, path, parent, name, fromEric = False, initShortcutsOnly = False, searchWord = None</i>) 379 <b>HelpWindow</b>(<i>home, path, parent, name, fromEric = False, initShortcutsOnly = False, searchWord = None</i>)
539 </dl><dl> 524 </dl><dl>
540 <dt>Returns:</dt> 525 <dt>Returns:</dt>
541 <dd> 526 <dd>
542 icon for the URL (QIcon) 527 icon for the URL (QIcon)
543 </dd> 528 </dd>
544 </dl><a NAME="HelpWindow.__guessUrlFromPath" ID="HelpWindow.__guessUrlFromPath"></a>
545 <h4>HelpWindow.__guessUrlFromPath</h4>
546 <b>__guessUrlFromPath</b>(<i>path</i>)
547 <p>
548 Private method to guess an URL given a path string.
549 </p><dl>
550 <dt><i>path</i></dt>
551 <dd>
552 path string to guess an URL for (string)
553 </dd>
554 </dl><dl>
555 <dt>Returns:</dt>
556 <dd>
557 guessed URL (QUrl)
558 </dd>
559 </dl><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a> 529 </dl><a NAME="HelpWindow.__hideIndexWindow" ID="HelpWindow.__hideIndexWindow"></a>
560 <h4>HelpWindow.__hideIndexWindow</h4> 530 <h4>HelpWindow.__hideIndexWindow</h4>
561 <b>__hideIndexWindow</b>(<i></i>) 531 <b>__hideIndexWindow</b>(<i></i>)
562 <p> 532 <p>
563 Private method to hide the index window. 533 Private method to hide the index window.
712 url to be opened (QUrl) 682 url to be opened (QUrl)
713 </dd><dt><i>title</i></dt> 683 </dd><dt><i>title</i></dt>
714 <dd> 684 <dd>
715 title of the bookmark (string) 685 title of the bookmark (string)
716 </dd> 686 </dd>
717 </dl><a NAME="HelpWindow.__pathSelected" ID="HelpWindow.__pathSelected"></a>
718 <h4>HelpWindow.__pathSelected</h4>
719 <b>__pathSelected</b>(<i>path</i>)
720 <p>
721 Private slot called when a file is selected in the combobox.
722 </p><dl>
723 <dt><i>path</i></dt>
724 <dd>
725 path to be shown (string)
726 </dd>
727 </dl><a NAME="HelpWindow.__prevTab" ID="HelpWindow.__prevTab"></a> 687 </dl><a NAME="HelpWindow.__prevTab" ID="HelpWindow.__prevTab"></a>
728 <h4>HelpWindow.__prevTab</h4> 688 <h4>HelpWindow.__prevTab</h4>
729 <b>__prevTab</b>(<i></i>) 689 <b>__prevTab</b>(<i></i>)
730 <p> 690 <p>
731 Private slot used to show the previous tab. 691 Private slot used to show the previous tab.
757 </p><dl> 717 </p><dl>
758 <dt><i>enable</i></dt> 718 <dt><i>enable</i></dt>
759 <dd> 719 <dd>
760 flag indicating to enabled icon storage (boolean) 720 flag indicating to enabled icon storage (boolean)
761 </dd> 721 </dd>
762 </dl><a NAME="HelpWindow.__setPathComboBackground" ID="HelpWindow.__setPathComboBackground"></a> 722 </dl><a NAME="HelpWindow.__setTextEncoding" ID="HelpWindow.__setTextEncoding"></a>
763 <h4>HelpWindow.__setPathComboBackground</h4>
764 <b>__setPathComboBackground</b>(<i></i>)
765 <p>
766 Private slot to change the path combo background to indicate save URLs.
767 </p><a NAME="HelpWindow.__setTextEncoding" ID="HelpWindow.__setTextEncoding"></a>
768 <h4>HelpWindow.__setTextEncoding</h4> 723 <h4>HelpWindow.__setTextEncoding</h4>
769 <b>__setTextEncoding</b>(<i>act</i>) 724 <b>__setTextEncoding</b>(<i>act</i>)
770 <p> 725 <p>
771 Private slot to set the selected text encoding as the default for 726 Private slot to set the selected text encoding as the default for
772 this session. 727 this session.
868 </p><a NAME="HelpWindow.__showTocWindow" ID="HelpWindow.__showTocWindow"></a> 823 </p><a NAME="HelpWindow.__showTocWindow" ID="HelpWindow.__showTocWindow"></a>
869 <h4>HelpWindow.__showTocWindow</h4> 824 <h4>HelpWindow.__showTocWindow</h4>
870 <b>__showTocWindow</b>(<i></i>) 825 <b>__showTocWindow</b>(<i></i>)
871 <p> 826 <p>
872 Private method to show the table of contents window. 827 Private method to show the table of contents window.
873 </p><a NAME="HelpWindow.__sourceChanged" ID="HelpWindow.__sourceChanged"></a> 828 </p><a NAME="HelpWindow.__stopLoading" ID="HelpWindow.__stopLoading"></a>
874 <h4>HelpWindow.__sourceChanged</h4>
875 <b>__sourceChanged</b>(<i>url</i>)
876 <p>
877 Private slot called when the displayed text of the combobox is changed.
878 </p><dl>
879 <dt><i>url</i></dt>
880 <dd>
881 URL of the new site (QUrl)
882 </dd>
883 </dl><a NAME="HelpWindow.__stopLoading" ID="HelpWindow.__stopLoading"></a>
884 <h4>HelpWindow.__stopLoading</h4> 829 <h4>HelpWindow.__stopLoading</h4>
885 <b>__stopLoading</b>(<i></i>) 830 <b>__stopLoading</b>(<i></i>)
886 <p> 831 <p>
887 Private slot called to handle loading of the current page. 832 Private slot called to handle loading of the current page.
888 </p><a NAME="HelpWindow.__switchTab" ID="HelpWindow.__switchTab"></a> 833 </p><a NAME="HelpWindow.__switchTab" ID="HelpWindow.__switchTab"></a>
1085 </dl><dl> 1030 </dl><dl>
1086 <dt>Returns:</dt> 1031 <dt>Returns:</dt>
1087 <dd> 1032 <dd>
1088 icon for the URL (QIcon) 1033 icon for the URL (QIcon)
1089 </dd> 1034 </dd>
1090 </dl><a NAME="HelpWindow.iconChanged" ID="HelpWindow.iconChanged"></a>
1091 <h4>HelpWindow.iconChanged</h4>
1092 <b>iconChanged</b>(<i>icon</i>)
1093 <p>
1094 Public slot to change the icon shown to the left of the URL entry.
1095 </p><dl>
1096 <dt><i>icon</i></dt>
1097 <dd>
1098 icon to be shown (QIcon)
1099 </dd>
1100 </dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a> 1035 </dl><a NAME="HelpWindow.networkAccessManager" ID="HelpWindow.networkAccessManager"></a>
1101 <h4>HelpWindow.networkAccessManager</h4> 1036 <h4>HelpWindow.networkAccessManager</h4>
1102 <b>networkAccessManager</b>(<i></i>) 1037 <b>networkAccessManager</b>(<i></i>)
1103 <p> 1038 <p>
1104 Class method to get a reference to the network access manager. 1039 Class method to get a reference to the network access manager.
1150 </dl><a NAME="HelpWindow.preferencesChanged" ID="HelpWindow.preferencesChanged"></a> 1085 </dl><a NAME="HelpWindow.preferencesChanged" ID="HelpWindow.preferencesChanged"></a>
1151 <h4>HelpWindow.preferencesChanged</h4> 1086 <h4>HelpWindow.preferencesChanged</h4>
1152 <b>preferencesChanged</b>(<i></i>) 1087 <b>preferencesChanged</b>(<i></i>)
1153 <p> 1088 <p>
1154 Public slot to handle a change of preferences. 1089 Public slot to handle a change of preferences.
1155 </p><a NAME="HelpWindow.progressBar" ID="HelpWindow.progressBar"></a> 1090 </p><a NAME="HelpWindow.search" ID="HelpWindow.search"></a>
1156 <h4>HelpWindow.progressBar</h4>
1157 <b>progressBar</b>(<i></i>)
1158 <p>
1159 Public method to get a reference to the load progress bar.
1160 </p><dl>
1161 <dt>Returns:</dt>
1162 <dd>
1163 reference to the load progress bar (QProgressBar)
1164 </dd>
1165 </dl><a NAME="HelpWindow.search" ID="HelpWindow.search"></a>
1166 <h4>HelpWindow.search</h4> 1091 <h4>HelpWindow.search</h4>
1167 <b>search</b>(<i>word</i>) 1092 <b>search</b>(<i>word</i>)
1168 <p> 1093 <p>
1169 Public method to search for a word. 1094 Public method to search for a word.
1170 </p><dl> 1095 </p><dl>
1209 Public slot to set the loading dependent actions. 1134 Public slot to set the loading dependent actions.
1210 </p><dl> 1135 </p><dl>
1211 <dt><i>b</i></dt> 1136 <dt><i>b</i></dt>
1212 <dd> 1137 <dd>
1213 flag indicating the loading state to consider (boolean) 1138 flag indicating the loading state to consider (boolean)
1139 </dd>
1140 </dl><a NAME="HelpWindow.setPrivateMode" ID="HelpWindow.setPrivateMode"></a>
1141 <h4>HelpWindow.setPrivateMode</h4>
1142 <b>setPrivateMode</b>(<i>on</i>)
1143 <p>
1144 Public method to set the privacy mode.
1145 </p><dl>
1146 <dt><i>on</i></dt>
1147 <dd>
1148 flag indicating the privacy state (boolean)
1214 </dd> 1149 </dd>
1215 </dl> 1150 </dl>
1216 <div align="right"><a href="#top">Up</a></div> 1151 <div align="right"><a href="#top">Up</a></div>
1217 <hr /> 1152 <hr />
1218 </body></html> 1153 </body></html>

Mercurial Repository: eric

eric ide

mercurial