Mercurial Repositories > eric / file diff

--- a/Documentation/Source/eric6.Helpviewer.HelpWindow.html	Sat Dec 15 16:29:47 2018 +0100
+++ b/Documentation/Source/eric6.Helpviewer.HelpWindow.html	Sat Dec 15 16:30:36 2018 +0100
@@ -61,7 +61,7 @@
 E5MainWindow
 <h3>Class Attributes</h3>
 <table>
-<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>
+<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>
 </table>
 <h3>Class Methods</h3>
 <table>
@@ -187,6 +187,9 @@
 <td><a href="#HelpWindow.__closeNetworkMonitor">__closeNetworkMonitor</a></td>
 <td>Private slot to close the network monitor dialog.</td>
 </tr><tr>
+<td><a href="#HelpWindow.__configShortcuts">__configShortcuts</a></td>
+<td>Private slot to configure the keyboard shortcuts.</td>
+</tr><tr>
 <td><a href="#HelpWindow.__copy">__copy</a></td>
 <td>Private slot called to handle the copy action.</td>
 </tr><tr>
@@ -205,6 +208,9 @@
 <td><a href="#HelpWindow.__docsInstalled">__docsInstalled</a></td>
 <td>Private slot handling the end of documentation installation.</td>
 </tr><tr>
+<td><a href="#HelpWindow.__exportShortcuts">__exportShortcuts</a></td>
+<td>Private slot to export the keyboard shortcuts.</td>
+</tr><tr>
 <td><a href="#HelpWindow.__feedsManagerClosed">__feedsManagerClosed</a></td>
 <td>Private slot to handle closing the feeds manager dialog.</td>
 </tr><tr>
@@ -229,6 +235,9 @@
 <td><a href="#HelpWindow.__home">__home</a></td>
 <td>Private slot called to handle the home action.</td>
 </tr><tr>
+<td><a href="#HelpWindow.__importShortcuts">__importShortcuts</a></td>
+<td>Private slot to import the keyboard shortcuts.</td>
+</tr><tr>
 <td><a href="#HelpWindow.__indexingFinished">__indexingFinished</a></td>
 <td>Private slot to handle the start of the indexing process.</td>
 </tr><tr>
@@ -292,6 +301,15 @@
 <td><a href="#HelpWindow.__removeOldDocumentation">__removeOldDocumentation</a></td>
 <td>Private slot to remove non-existing documentation from the help engine.</td>
 </tr><tr>
+<td><a href="#HelpWindow.__saLoadUrl">__saLoadUrl</a></td>
+<td>Private slot to load an URL received via the single application protocol.</td>
+</tr><tr>
+<td><a href="#HelpWindow.__saNewTab">__saNewTab</a></td>
+<td>Private slot to load an URL received via the single application protocol in a new tab.</td>
+</tr><tr>
+<td><a href="#HelpWindow.__saSearchWord">__saSearchWord</a></td>
+<td>Private slot to search for the given word.</td>
+</tr><tr>
 <td><a href="#HelpWindow.__savePageAs">__savePageAs</a></td>
 <td>Private slot to save the current page.</td>
 </tr><tr>
@@ -481,6 +499,9 @@
 <td><a href="#HelpWindow.getActions">getActions</a></td>
 <td>Public method to get a list of all actions.</td>
 </tr><tr>
+<td><a href="#HelpWindow.getActionsCategory">getActionsCategory</a></td>
+<td>Public method to get the category of the defined actions.</td>
+</tr><tr>
 <td><a href="#HelpWindow.getSourceFileList">getSourceFileList</a></td>
 <td>Public method to get a list of all opened source files.</td>
 </tr><tr>
@@ -832,33 +853,34 @@
 </dd>
 </dl><a NAME="HelpWindow.__init__" ID="HelpWindow.__init__"></a>
 <h4>HelpWindow (Constructor)</h4>
-<b>HelpWindow</b>(<i>home, path, parent, name, fromEric=False, initShortcutsOnly=False, searchWord=None</i>)
+<b>HelpWindow</b>(<i>home, path, parent, name, searchWord=None, qthelp=False, single=False, saname=""</i>)
 <p>
         Constructor
 </p><dl>
-<dt><i>home</i></dt>
+<dt><i>home</i> (str)</dt>
 <dd>
-the URL to be shown (string)
-</dd><dt><i>path</i></dt>
+the URL to be shown
+</dd><dt><i>path</i> (str)</dt>
 <dd>
-the path of the working dir (usually '.') (string)
-</dd><dt><i>parent</i></dt>
+the path of the working dir (usually '.')
+</dd><dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of this window (QWidget)
-</dd><dt><i>name</i></dt>
+parent widget of this window
+</dd><dt><i>name</i> (str)</dt>
 <dd>
-name of this window (string)
-</dd><dt><i>fromEric</i></dt>
+name of this window
+</dd><dt><i>searchWord</i> (str)</dt>
+<dd>
+word to search for
+</dd><dt><i>qthelp</i> (bool)</dt>
 <dd>
-flag indicating whether it was called from within
-            eric6 (boolean)
-</dd><dt><i>initShortcutsOnly=</i></dt>
+flag indicating to enable the QtHelp support
+</dd><dt><i>single</i> (bool)</dt>
 <dd>
-flag indicating to just initialize the
-            keyboard shortcuts (boolean)
-</dd><dt><i>searchWord=</i></dt>
+flag indicating to start in single application mode
+</dd><dt><i>saname</i> (str)</dt>
 <dd>
-word to search for (string)
+name to be used for the single application server
 </dd>
 </dl><a NAME="HelpWindow.__about" ID="HelpWindow.__about"></a>
 <h4>HelpWindow.__about</h4>
@@ -943,6 +965,11 @@
 <b>__closeNetworkMonitor</b>(<i></i>)
 <p>
         Private slot to close the network monitor dialog.
+</p><a NAME="HelpWindow.__configShortcuts" ID="HelpWindow.__configShortcuts"></a>
+<h4>HelpWindow.__configShortcuts</h4>
+<b>__configShortcuts</b>(<i></i>)
+<p>
+        Private slot to configure the keyboard shortcuts.
 </p><a NAME="HelpWindow.__copy" ID="HelpWindow.__copy"></a>
 <h4>HelpWindow.__copy</h4>
 <b>__copy</b>(<i></i>)
@@ -1010,7 +1037,12 @@
 flag indicating that documents were installed
             (boolean)
 </dd>
-</dl><a NAME="HelpWindow.__feedsManagerClosed" ID="HelpWindow.__feedsManagerClosed"></a>
+</dl><a NAME="HelpWindow.__exportShortcuts" ID="HelpWindow.__exportShortcuts"></a>
+<h4>HelpWindow.__exportShortcuts</h4>
+<b>__exportShortcuts</b>(<i></i>)
+<p>
+        Private slot to export the keyboard shortcuts.
+</p><a NAME="HelpWindow.__feedsManagerClosed" ID="HelpWindow.__feedsManagerClosed"></a>
 <h4>HelpWindow.__feedsManagerClosed</h4>
 <b>__feedsManagerClosed</b>(<i>feedsManager</i>)
 <p>
@@ -1063,6 +1095,11 @@
 <b>__home</b>(<i></i>)
 <p>
         Private slot called to handle the home action.
+</p><a NAME="HelpWindow.__importShortcuts" ID="HelpWindow.__importShortcuts"></a>
+<h4>HelpWindow.__importShortcuts</h4>
+<b>__importShortcuts</b>(<i></i>)
+<p>
+        Private slot to import the keyboard shortcuts.
 </p><a NAME="HelpWindow.__indexingFinished" ID="HelpWindow.__indexingFinished"></a>
 <h4>HelpWindow.__indexingFinished</h4>
 <b>__indexingFinished</b>(<i></i>)
@@ -1194,7 +1231,39 @@
 <b>__removeOldDocumentation</b>(<i></i>)
 <p>
         Private slot to remove non-existing documentation from the help engine.
-</p><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a>
+</p><a NAME="HelpWindow.__saLoadUrl" ID="HelpWindow.__saLoadUrl"></a>
+<h4>HelpWindow.__saLoadUrl</h4>
+<b>__saLoadUrl</b>(<i>urlStr</i>)
+<p>
+        Private slot to load an URL received via the single application
+        protocol.
+</p><dl>
+<dt><i>urlStr</i> (str)</dt>
+<dd>
+URL to be loaded
+</dd>
+</dl><a NAME="HelpWindow.__saNewTab" ID="HelpWindow.__saNewTab"></a>
+<h4>HelpWindow.__saNewTab</h4>
+<b>__saNewTab</b>(<i>urlStr</i>)
+<p>
+        Private slot to load an URL received via the single application
+        protocol in a new tab.
+</p><dl>
+<dt><i>urlStr</i> (str)</dt>
+<dd>
+URL to be loaded
+</dd>
+</dl><a NAME="HelpWindow.__saSearchWord" ID="HelpWindow.__saSearchWord"></a>
+<h4>HelpWindow.__saSearchWord</h4>
+<b>__saSearchWord</b>(<i>word</i>)
+<p>
+        Private slot to search for the given word.
+</p><dl>
+<dt><i>word</i> (str)</dt>
+<dd>
+word to be searched for
+</dd>
+</dl><a NAME="HelpWindow.__savePageAs" ID="HelpWindow.__savePageAs"></a>
 <h4>HelpWindow.__savePageAs</h4>
 <b>__savePageAs</b>(<i></i>)
 <p>
@@ -1630,6 +1699,21 @@
 <dd>
 list of all actions (list of E5Action)
 </dd>
+</dl><a NAME="HelpWindow.getActionsCategory" ID="HelpWindow.getActionsCategory"></a>
+<h4>HelpWindow.getActionsCategory</h4>
+<b>getActionsCategory</b>(<i></i>)
+<p>
+        Public method to get the category of the defined actions.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+category of the actions
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
 </dl><a NAME="HelpWindow.getSourceFileList" ID="HelpWindow.getSourceFileList"></a>
 <h4>HelpWindow.getSourceFileList</h4>
 <b>getSourceFileList</b>(<i></i>)