Documentation/Source/eric6.UI.UserInterface.html

changeset 6632
084880ed940c
parent 6589
613426e62983
child 6934
eae7d1d9cc7b
--- a/Documentation/Source/eric6.UI.UserInterface.html	Sat Dec 15 16:29:47 2018 +0100
+++ b/Documentation/Source/eric6.UI.UserInterface.html	Sat Dec 15 16:30:36 2018 +0100
@@ -267,6 +267,9 @@
 <td><a href="#UserInterface.__configureDockareaCornerUsage">__configureDockareaCornerUsage</a></td>
 <td>Private method to configure the usage of the dockarea corners.</td>
 </tr><tr>
+<td><a href="#UserInterface.__connectToWebBrowser">__connectToWebBrowser</a></td>
+<td>Private method to connect to a started web browser.</td>
+</tr><tr>
 <td><a href="#UserInterface.__createDockWindow">__createDockWindow</a></td>
 <td>Private method to create a dock window with common properties.</td>
 </tr><tr>
@@ -321,9 +324,6 @@
 <td><a href="#UserInterface.__hasErrorLog">__hasErrorLog</a></td>
 <td>Private method to check, if an error log file exists.</td>
 </tr><tr>
-<td><a href="#UserInterface.__helpClosed">__helpClosed</a></td>
-<td>Private slot to handle the helpClosed signal of the help window.</td>
-</tr><tr>
 <td><a href="#UserInterface.__helpViewer">__helpViewer</a></td>
 <td>Private slot to start an empty help viewer/web browser.</td>
 </tr><tr>
@@ -375,6 +375,9 @@
 <td><a href="#UserInterface.__lastEditorClosed">__lastEditorClosed</a></td>
 <td>Private slot to handle the lastEditorClosed signal.</td>
 </tr><tr>
+<td><a href="#UserInterface.__launchExternalWebBrowser">__launchExternalWebBrowser</a></td>
+<td>Private method to start an external web browser and communicate with it.</td>
+</tr><tr>
 <td><a href="#UserInterface.__linguist">__linguist</a></td>
 <td>Private slot to start the Qt-Linguist executable.</td>
 </tr><tr>
@@ -660,6 +663,12 @@
 <td><a href="#UserInterface.__webBrowser">__webBrowser</a></td>
 <td>Private slot to start the eric6 web browser.</td>
 </tr><tr>
+<td><a href="#UserInterface.__webBrowserFinished">__webBrowserFinished</a></td>
+<td>Private slot handling the end of the external web browser process.</td>
+</tr><tr>
+<td><a href="#UserInterface.__webBrowserShutdown">__webBrowserShutdown</a></td>
+<td>Private method to shut down the web browser.</td>
+</tr><tr>
 <td><a href="#UserInterface.__whatsThis">__whatsThis</a></td>
 <td>Private slot called in to enter Whats This mode.</td>
 </tr><tr>
@@ -732,9 +741,6 @@
 <td><a href="#UserInterface.getActions">getActions</a></td>
 <td>Public method to get a list of all actions.</td>
 </tr><tr>
-<td><a href="#UserInterface.getHelpViewer">getHelpViewer</a></td>
-<td>Public method to get a reference to the help window instance.</td>
-</tr><tr>
 <td><a href="#UserInterface.getLayoutType">getLayoutType</a></td>
 <td>Public method to get the current layout type.</td>
 </tr><tr>
@@ -1068,7 +1074,28 @@
 <b>__configureDockareaCornerUsage</b>(<i></i>)
 <p>
         Private method to configure the usage of the dockarea corners.
-</p><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
+</p><a NAME="UserInterface.__connectToWebBrowser" ID="UserInterface.__connectToWebBrowser"></a>
+<h4>UserInterface.__connectToWebBrowser</h4>
+<b>__connectToWebBrowser</b>(<i>process</i>)
+<p>
+        Private method to connect to a started web browser.
+</p><dl>
+<dt><i>process</i> (QProcess)</dt>
+<dd>
+reference to the started web browser process
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+error indication (1 = connection not possible, 0 = ok,
+            -1 = server exited with an error code)
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl><a NAME="UserInterface.__createDockWindow" ID="UserInterface.__createDockWindow"></a>
 <h4>UserInterface.__createDockWindow</h4>
 <b>__createDockWindow</b>(<i>name</i>)
 <p>
@@ -1226,12 +1253,7 @@
 <dd>
 flag indicating the existence of an error log file (boolean)
 </dd>
-</dl><a NAME="UserInterface.__helpClosed" ID="UserInterface.__helpClosed"></a>
-<h4>UserInterface.__helpClosed</h4>
-<b>__helpClosed</b>(<i></i>)
-<p>
-        Private slot to handle the helpClosed signal of the help window.
-</p><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
+</dl><a NAME="UserInterface.__helpViewer" ID="UserInterface.__helpViewer"></a>
 <h4>UserInterface.__helpViewer</h4>
 <b>__helpViewer</b>(<i></i>)
 <p>
@@ -1329,7 +1351,31 @@
 <b>__lastEditorClosed</b>(<i></i>)
 <p>
         Private slot to handle the lastEditorClosed signal.
-</p><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
+</p><a NAME="UserInterface.__launchExternalWebBrowser" ID="UserInterface.__launchExternalWebBrowser"></a>
+<h4>UserInterface.__launchExternalWebBrowser</h4>
+<b>__launchExternalWebBrowser</b>(<i>home, searchWord=None</i>)
+<p>
+        Private method to start an external web browser and communicate with
+        it.
+</p><dl>
+<dt><i>home</i> (str)</dt>
+<dd>
+filename of file to be shown or URL to be opened
+</dd><dt><i>searchWord=</i> (str)</dt>
+<dd>
+word to search for
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a successful launch
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="UserInterface.__linguist" ID="UserInterface.__linguist"></a>
 <h4>UserInterface.__linguist</h4>
 <b>__linguist</b>(<i>fn=None, version=0</i>)
 <p>
@@ -2059,7 +2105,17 @@
 <dd>
 full pathname of a file to display (string)
 </dd>
-</dl><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
+</dl><a NAME="UserInterface.__webBrowserFinished" ID="UserInterface.__webBrowserFinished"></a>
+<h4>UserInterface.__webBrowserFinished</h4>
+<b>__webBrowserFinished</b>(<i></i>)
+<p>
+        Private slot handling the end of the external web browser process.
+</p><a NAME="UserInterface.__webBrowserShutdown" ID="UserInterface.__webBrowserShutdown"></a>
+<h4>UserInterface.__webBrowserShutdown</h4>
+<b>__webBrowserShutdown</b>(<i></i>)
+<p>
+        Private method to shut down the web browser.
+</p><a NAME="UserInterface.__whatsThis" ID="UserInterface.__whatsThis"></a>
 <h4>UserInterface.__whatsThis</h4>
 <b>__whatsThis</b>(<i></i>)
 <p>
@@ -2292,22 +2348,6 @@
 <dd>
 list of all actions (list of E5Action)
 </dd>
-</dl><a NAME="UserInterface.getHelpViewer" ID="UserInterface.getHelpViewer"></a>
-<h4>UserInterface.getHelpViewer</h4>
-<b>getHelpViewer</b>(<i>preview=False</i>)
-<p>
-        Public method to get a reference to the help window instance.
-</p><dl>
-<dt><i>preview=</i></dt>
-<dd>
-flag indicating to get a help window for preview
-            (boolean)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-reference to the help window instance (HelpWindow)
-</dd>
 </dl><a NAME="UserInterface.getLayoutType" ID="UserInterface.getLayoutType"></a>
 <h4>UserInterface.getLayoutType</h4>
 <b>getLayoutType</b>(<i></i>)

eric ide

mercurial