Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Helpviewer.HelpWindow.html

changeset 6632
084880ed940c
parent 6296
db9b3a419845
equal deleted inserted replaced
6631:0a2f0feac79d 6632:084880ed940c
59 </dl> 59 </dl>
60 <h3>Derived from</h3> 60 <h3>Derived from</h3>
61 E5MainWindow 61 E5MainWindow
62 <h3>Class Attributes</h3> 62 <h3>Class Attributes</h3>
63 <table> 63 <table>
64 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_downloadManager</td></tr><tr><td>_featurePermissionManager</td></tr><tr><td>_feedsManager</td></tr><tr><td>_flashCookieManager</td></tr><tr><td>_fromEric</td></tr><tr><td>_greaseMonkeyManager</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_notification</td></tr><tr><td>_passwordManager</td></tr><tr><td>_personalInformationManager</td></tr><tr><td>_speedDial</td></tr><tr><td>_syncManager</td></tr><tr><td>_useQtHelp</td></tr><tr><td>_userAgentsManager</td></tr><tr><td>_zoomManager</td></tr><tr><td>helpwindows</td></tr> 64 <tr><td>_adblockManager</td></tr><tr><td>_bookmarksManager</td></tr><tr><td>_cookieJar</td></tr><tr><td>_downloadManager</td></tr><tr><td>_featurePermissionManager</td></tr><tr><td>_feedsManager</td></tr><tr><td>_flashCookieManager</td></tr><tr><td>_greaseMonkeyManager</td></tr><tr><td>_helpEngine</td></tr><tr><td>_historyManager</td></tr><tr><td>_networkAccessManager</td></tr><tr><td>_notification</td></tr><tr><td>_passwordManager</td></tr><tr><td>_personalInformationManager</td></tr><tr><td>_speedDial</td></tr><tr><td>_syncManager</td></tr><tr><td>_useQtHelp</td></tr><tr><td>_userAgentsManager</td></tr><tr><td>_zoomManager</td></tr><tr><td>helpwindows</td></tr>
65 </table> 65 </table>
66 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
67 <table> 67 <table>
68 <tr> 68 <tr>
69 <td><a href="#HelpWindow.adBlockManager">adBlockManager</a></td> 69 <td><a href="#HelpWindow.adBlockManager">adBlockManager</a></td>
185 <td>Private slot to close all windows.</td> 185 <td>Private slot to close all windows.</td>
186 </tr><tr> 186 </tr><tr>
187 <td><a href="#HelpWindow.__closeNetworkMonitor">__closeNetworkMonitor</a></td> 187 <td><a href="#HelpWindow.__closeNetworkMonitor">__closeNetworkMonitor</a></td>
188 <td>Private slot to close the network monitor dialog.</td> 188 <td>Private slot to close the network monitor dialog.</td>
189 </tr><tr> 189 </tr><tr>
190 <td><a href="#HelpWindow.__configShortcuts">__configShortcuts</a></td>
191 <td>Private slot to configure the keyboard shortcuts.</td>
192 </tr><tr>
190 <td><a href="#HelpWindow.__copy">__copy</a></td> 193 <td><a href="#HelpWindow.__copy">__copy</a></td>
191 <td>Private slot called to handle the copy action.</td> 194 <td>Private slot called to handle the copy action.</td>
192 </tr><tr> 195 </tr><tr>
193 <td><a href="#HelpWindow.__createTextEncodingAction">__createTextEncodingAction</a></td> 196 <td><a href="#HelpWindow.__createTextEncodingAction">__createTextEncodingAction</a></td>
194 <td>Private method to create an action for the text encoding menu.</td> 197 <td>Private method to create an action for the text encoding menu.</td>
203 <td>Special method called during object destruction.</td> 206 <td>Special method called during object destruction.</td>
204 </tr><tr> 207 </tr><tr>
205 <td><a href="#HelpWindow.__docsInstalled">__docsInstalled</a></td> 208 <td><a href="#HelpWindow.__docsInstalled">__docsInstalled</a></td>
206 <td>Private slot handling the end of documentation installation.</td> 209 <td>Private slot handling the end of documentation installation.</td>
207 </tr><tr> 210 </tr><tr>
211 <td><a href="#HelpWindow.__exportShortcuts">__exportShortcuts</a></td>
212 <td>Private slot to export the keyboard shortcuts.</td>
213 </tr><tr>
208 <td><a href="#HelpWindow.__feedsManagerClosed">__feedsManagerClosed</a></td> 214 <td><a href="#HelpWindow.__feedsManagerClosed">__feedsManagerClosed</a></td>
209 <td>Private slot to handle closing the feeds manager dialog.</td> 215 <td>Private slot to handle closing the feeds manager dialog.</td>
210 </tr><tr> 216 </tr><tr>
211 <td><a href="#HelpWindow.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td> 217 <td><a href="#HelpWindow.__filterQtHelpDocumentation">__filterQtHelpDocumentation</a></td>
212 <td>Private slot to filter the QtHelp documentation.</td> 218 <td>Private slot to filter the QtHelp documentation.</td>
227 <td>Private method to hide the table of contents window.</td> 233 <td>Private method to hide the table of contents window.</td>
228 </tr><tr> 234 </tr><tr>
229 <td><a href="#HelpWindow.__home">__home</a></td> 235 <td><a href="#HelpWindow.__home">__home</a></td>
230 <td>Private slot called to handle the home action.</td> 236 <td>Private slot called to handle the home action.</td>
231 </tr><tr> 237 </tr><tr>
238 <td><a href="#HelpWindow.__importShortcuts">__importShortcuts</a></td>
239 <td>Private slot to import the keyboard shortcuts.</td>
240 </tr><tr>
232 <td><a href="#HelpWindow.__indexingFinished">__indexingFinished</a></td> 241 <td><a href="#HelpWindow.__indexingFinished">__indexingFinished</a></td>
233 <td>Private slot to handle the start of the indexing process.</td> 242 <td>Private slot to handle the start of the indexing process.</td>
234 </tr><tr> 243 </tr><tr>
235 <td><a href="#HelpWindow.__indexingStarted">__indexingStarted</a></td> 244 <td><a href="#HelpWindow.__indexingStarted">__indexingStarted</a></td>
236 <td>Private slot to handle the start of the indexing process.</td> 245 <td>Private slot to handle the start of the indexing process.</td>
290 <td>Private slot called to handle the reload action.</td> 299 <td>Private slot called to handle the reload action.</td>
291 </tr><tr> 300 </tr><tr>
292 <td><a href="#HelpWindow.__removeOldDocumentation">__removeOldDocumentation</a></td> 301 <td><a href="#HelpWindow.__removeOldDocumentation">__removeOldDocumentation</a></td>
293 <td>Private slot to remove non-existing documentation from the help engine.</td> 302 <td>Private slot to remove non-existing documentation from the help engine.</td>
294 </tr><tr> 303 </tr><tr>
304 <td><a href="#HelpWindow.__saLoadUrl">__saLoadUrl</a></td>
305 <td>Private slot to load an URL received via the single application protocol.</td>
306 </tr><tr>
307 <td><a href="#HelpWindow.__saNewTab">__saNewTab</a></td>
308 <td>Private slot to load an URL received via the single application protocol in a new tab.</td>
309 </tr><tr>
310 <td><a href="#HelpWindow.__saSearchWord">__saSearchWord</a></td>
311 <td>Private slot to search for the given word.</td>
312 </tr><tr>
295 <td><a href="#HelpWindow.__savePageAs">__savePageAs</a></td> 313 <td><a href="#HelpWindow.__savePageAs">__savePageAs</a></td>
296 <td>Private slot to save the current page.</td> 314 <td>Private slot to save the current page.</td>
297 </tr><tr> 315 </tr><tr>
298 <td><a href="#HelpWindow.__savePageScreen">__savePageScreen</a></td> 316 <td><a href="#HelpWindow.__savePageScreen">__savePageScreen</a></td>
299 <td>Private slot to save the current page as a screen shot.</td> 317 <td>Private slot to save the current page as a screen shot.</td>
478 <td><a href="#HelpWindow.eventMouseButtons">eventMouseButtons</a></td> 496 <td><a href="#HelpWindow.eventMouseButtons">eventMouseButtons</a></td>
479 <td>Public method to get the last recorded mouse buttons.</td> 497 <td>Public method to get the last recorded mouse buttons.</td>
480 </tr><tr> 498 </tr><tr>
481 <td><a href="#HelpWindow.getActions">getActions</a></td> 499 <td><a href="#HelpWindow.getActions">getActions</a></td>
482 <td>Public method to get a list of all actions.</td> 500 <td>Public method to get a list of all actions.</td>
501 </tr><tr>
502 <td><a href="#HelpWindow.getActionsCategory">getActionsCategory</a></td>
503 <td>Public method to get the category of the defined actions.</td>
483 </tr><tr> 504 </tr><tr>
484 <td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td> 505 <td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td>
485 <td>Public method to get a list of all opened source files.</td> 506 <td>Public method to get a list of all opened source files.</td>
486 </tr><tr> 507 </tr><tr>
487 <td><a href="#HelpWindow.getWindow">getWindow</a></td> 508 <td><a href="#HelpWindow.getWindow">getWindow</a></td>
830 <dd> 851 <dd>
831 ZoomManager 852 ZoomManager
832 </dd> 853 </dd>
833 </dl><a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a> 854 </dl><a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
834 <h4>HelpWindow (Constructor)</h4> 855 <h4>HelpWindow (Constructor)</h4>
835 <b>HelpWindow</b>(<i>home, path, parent, name, fromEric=False, initShortcutsOnly=False, searchWord=None</i>) 856 <b>HelpWindow</b>(<i>home, path, parent, name, searchWord=None, qthelp=False, single=False, saname=""</i>)
836 <p> 857 <p>
837 Constructor 858 Constructor
838 </p><dl> 859 </p><dl>
839 <dt><i>home</i></dt> 860 <dt><i>home</i> (str)</dt>
840 <dd> 861 <dd>
841 the URL to be shown (string) 862 the URL to be shown
842 </dd><dt><i>path</i></dt> 863 </dd><dt><i>path</i> (str)</dt>
843 <dd> 864 <dd>
844 the path of the working dir (usually '.') (string) 865 the path of the working dir (usually '.')
845 </dd><dt><i>parent</i></dt> 866 </dd><dt><i>parent</i> (QWidget)</dt>
846 <dd> 867 <dd>
847 parent widget of this window (QWidget) 868 parent widget of this window
848 </dd><dt><i>name</i></dt> 869 </dd><dt><i>name</i> (str)</dt>
849 <dd> 870 <dd>
850 name of this window (string) 871 name of this window
851 </dd><dt><i>fromEric</i></dt> 872 </dd><dt><i>searchWord</i> (str)</dt>
852 <dd> 873 <dd>
853 flag indicating whether it was called from within 874 word to search for
854 eric6 (boolean) 875 </dd><dt><i>qthelp</i> (bool)</dt>
855 </dd><dt><i>initShortcutsOnly=</i></dt> 876 <dd>
856 <dd> 877 flag indicating to enable the QtHelp support
857 flag indicating to just initialize the 878 </dd><dt><i>single</i> (bool)</dt>
858 keyboard shortcuts (boolean) 879 <dd>
859 </dd><dt><i>searchWord=</i></dt> 880 flag indicating to start in single application mode
860 <dd> 881 </dd><dt><i>saname</i> (str)</dt>
861 word to search for (string) 882 <dd>
883 name to be used for the single application server
862 </dd> 884 </dd>
863 </dl><a NAME="HelpWindow.__about" ID="HelpWindow.__about"></a> 885 </dl><a NAME="HelpWindow.__about" ID="HelpWindow.__about"></a>
864 <h4>HelpWindow.__about</h4> 886 <h4>HelpWindow.__about</h4>
865 <b>__about</b>(<i></i>) 887 <b>__about</b>(<i></i>)
866 <p> 888 <p>
941 </p><a NAME="HelpWindow.__closeNetworkMonitor" ID="HelpWindow.__closeNetworkMonitor"></a> 963 </p><a NAME="HelpWindow.__closeNetworkMonitor" ID="HelpWindow.__closeNetworkMonitor"></a>
942 <h4>HelpWindow.__closeNetworkMonitor</h4> 964 <h4>HelpWindow.__closeNetworkMonitor</h4>
943 <b>__closeNetworkMonitor</b>(<i></i>) 965 <b>__closeNetworkMonitor</b>(<i></i>)
944 <p> 966 <p>
945 Private slot to close the network monitor dialog. 967 Private slot to close the network monitor dialog.
968 </p><a NAME="HelpWindow.__configShortcuts" ID="HelpWindow.__configShortcuts"></a>
969 <h4>HelpWindow.__configShortcuts</h4>
970 <b>__configShortcuts</b>(<i></i>)
971 <p>
972 Private slot to configure the keyboard shortcuts.
946 </p><a NAME="HelpWindow.__copy" ID="HelpWindow.__copy"></a> 973 </p><a NAME="HelpWindow.__copy" ID="HelpWindow.__copy"></a>
947 <h4>HelpWindow.__copy</h4> 974 <h4>HelpWindow.__copy</h4>
948 <b>__copy</b>(<i></i>) 975 <b>__copy</b>(<i></i>)
949 <p> 976 <p>
950 Private slot called to handle the copy action. 977 Private slot called to handle the copy action.
1008 <dt><i>installed</i></dt> 1035 <dt><i>installed</i></dt>
1009 <dd> 1036 <dd>
1010 flag indicating that documents were installed 1037 flag indicating that documents were installed
1011 (boolean) 1038 (boolean)
1012 </dd> 1039 </dd>
1013 </dl><a NAME="HelpWindow.__feedsManagerClosed" ID="HelpWindow.__feedsManagerClosed"></a> 1040 </dl><a NAME="HelpWindow.__exportShortcuts" ID="HelpWindow.__exportShortcuts"></a>
1041 <h4>HelpWindow.__exportShortcuts</h4>
1042 <b>__exportShortcuts</b>(<i></i>)
1043 <p>
1044 Private slot to export the keyboard shortcuts.
1045 </p><a NAME="HelpWindow.__feedsManagerClosed" ID="HelpWindow.__feedsManagerClosed"></a>
1014 <h4>HelpWindow.__feedsManagerClosed</h4> 1046 <h4>HelpWindow.__feedsManagerClosed</h4>
1015 <b>__feedsManagerClosed</b>(<i>feedsManager</i>) 1047 <b>__feedsManagerClosed</b>(<i>feedsManager</i>)
1016 <p> 1048 <p>
1017 Private slot to handle closing the feeds manager dialog. 1049 Private slot to handle closing the feeds manager dialog.
1018 </p><dl> 1050 </p><dl>
1061 </p><a NAME="HelpWindow.__home" ID="HelpWindow.__home"></a> 1093 </p><a NAME="HelpWindow.__home" ID="HelpWindow.__home"></a>
1062 <h4>HelpWindow.__home</h4> 1094 <h4>HelpWindow.__home</h4>
1063 <b>__home</b>(<i></i>) 1095 <b>__home</b>(<i></i>)
1064 <p> 1096 <p>
1065 Private slot called to handle the home action. 1097 Private slot called to handle the home action.
1098 </p><a NAME="HelpWindow.__importShortcuts" ID="HelpWindow.__importShortcuts"></a>
1099 <h4>HelpWindow.__importShortcuts</h4>
1100 <b>__importShortcuts</b>(<i></i>)
1101 <p>
1102 Private slot to import the keyboard shortcuts.
1066 </p><a NAME="HelpWindow.__indexingFinished" ID="HelpWindow.__indexingFinished"></a> 1103 </p><a NAME="HelpWindow.__indexingFinished" ID="HelpWindow.__indexingFinished"></a>
1067 <h4>HelpWindow.__indexingFinished</h4> 1104 <h4>HelpWindow.__indexingFinished</h4>
1068 <b>__indexingFinished</b>(<i></i>) 1105 <b>__indexingFinished</b>(<i></i>)
1069 <p> 1106 <p>
1070 Private slot to handle the start of the indexing process. 1107 Private slot to handle the start of the indexing process.
1192 </p><a NAME="HelpWindow.__removeOldDocumentation" ID="HelpWindow.__removeOldDocumentation"></a> 1229 </p><a NAME="HelpWindow.__removeOldDocumentation" ID="HelpWindow.__removeOldDocumentation"></a>
1193 <h4>HelpWindow.__removeOldDocumentation</h4> 1230 <h4>HelpWindow.__removeOldDocumentation</h4>
1194 <b>__removeOldDocumentation</b>(<i></i>) 1231 <b>__removeOldDocumentation</b>(<i></i>)
1195 <p> 1232 <p>
1196 Private slot to remove non-existing documentation from the help engine. 1233 Private slot to remove non-existing documentation from the help engine.
1197 </p><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a> 1234 </p><a NAME="HelpWindow.__saLoadUrl" ID="HelpWindow.__saLoadUrl"></a>
1235 <h4>HelpWindow.__saLoadUrl</h4>
1236 <b>__saLoadUrl</b>(<i>urlStr</i>)
1237 <p>
1238 Private slot to load an URL received via the single application
1239 protocol.
1240 </p><dl>
1241 <dt><i>urlStr</i> (str)</dt>
1242 <dd>
1243 URL to be loaded
1244 </dd>
1245 </dl><a NAME="HelpWindow.__saNewTab" ID="HelpWindow.__saNewTab"></a>
1246 <h4>HelpWindow.__saNewTab</h4>
1247 <b>__saNewTab</b>(<i>urlStr</i>)
1248 <p>
1249 Private slot to load an URL received via the single application
1250 protocol in a new tab.
1251 </p><dl>
1252 <dt><i>urlStr</i> (str)</dt>
1253 <dd>
1254 URL to be loaded
1255 </dd>
1256 </dl><a NAME="HelpWindow.__saSearchWord" ID="HelpWindow.__saSearchWord"></a>
1257 <h4>HelpWindow.__saSearchWord</h4>
1258 <b>__saSearchWord</b>(<i>word</i>)
1259 <p>
1260 Private slot to search for the given word.
1261 </p><dl>
1262 <dt><i>word</i> (str)</dt>
1263 <dd>
1264 word to be searched for
1265 </dd>
1266 </dl><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a>
1198 <h4>HelpWindow.__savePageAs</h4> 1267 <h4>HelpWindow.__savePageAs</h4>
1199 <b>__savePageAs</b>(<i></i>) 1268 <b>__savePageAs</b>(<i></i>)
1200 <p> 1269 <p>
1201 Private slot to save the current page. 1270 Private slot to save the current page.
1202 </p><a NAME="HelpWindow.__savePageScreen" ID="HelpWindow.__savePageScreen"></a> 1271 </p><a NAME="HelpWindow.__savePageScreen" ID="HelpWindow.__savePageScreen"></a>
1628 </p><dl> 1697 </p><dl>
1629 <dt>Returns:</dt> 1698 <dt>Returns:</dt>
1630 <dd> 1699 <dd>
1631 list of all actions (list of E5Action) 1700 list of all actions (list of E5Action)
1632 </dd> 1701 </dd>
1702 </dl><a NAME="HelpWindow.getActionsCategory" ID="HelpWindow.getActionsCategory"></a>
1703 <h4>HelpWindow.getActionsCategory</h4>
1704 <b>getActionsCategory</b>(<i></i>)
1705 <p>
1706 Public method to get the category of the defined actions.
1707 </p><dl>
1708 <dt>Returns:</dt>
1709 <dd>
1710 category of the actions
1711 </dd>
1712 </dl><dl>
1713 <dt>Return Type:</dt>
1714 <dd>
1715 str
1716 </dd>
1633 </dl><a NAME="HelpWindow.getSourceFileList" ID="HelpWindow.getSourceFileList"></a> 1717 </dl><a NAME="HelpWindow.getSourceFileList" ID="HelpWindow.getSourceFileList"></a>
1634 <h4>HelpWindow.getSourceFileList</h4> 1718 <h4>HelpWindow.getSourceFileList</h4>
1635 <b>getSourceFileList</b>(<i></i>) 1719 <b>getSourceFileList</b>(<i></i>)
1636 <p> 1720 <p>
1637 Public method to get a list of all opened source files. 1721 Public method to get a list of all opened source files.

Mercurial Repository: eric

eric ide

mercurial