Documentation/Source/eric6.UI.UserInterface.html

branch
maintenance
changeset 6319
df201b9fbad4
parent 6296
db9b3a419845
child 6428
10aa2bf9c1d7
diff -r 44249d49d892 -r df201b9fbad4 Documentation/Source/eric6.UI.UserInterface.html
--- a/Documentation/Source/eric6.UI.UserInterface.html	Tue May 01 12:04:30 2018 +0200
+++ b/Documentation/Source/eric6.UI.UserInterface.html	Sat Jun 02 12:44:41 2018 +0200
@@ -325,7 +325,7 @@
 <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.</td>
+<td>Private slot to start an empty help viewer/web browser.</td>
 </tr><tr>
 <td><a href="#UserInterface.__importPreferences">__importPreferences</a></td>
 <td>Private slot to import preferences.</td>
@@ -348,8 +348,8 @@
 <td><a href="#UserInterface.__initMenus">__initMenus</a></td>
 <td>Private slot to create the menus.</td>
 </tr><tr>
-<td><a href="#UserInterface.__initPySideDocAction">__initPySideDocAction</a></td>
-<td>Private slot to initialize the action to show the PySide documentation.</td>
+<td><a href="#UserInterface.__initPySideDocActions">__initPySideDocActions</a></td>
+<td>Private slot to initialize the actions to show the PySide documentation.</td>
 </tr><tr>
 <td><a href="#UserInterface.__initPythonDocActions">__initPythonDocActions</a></td>
 <td>Private slot to initialize the actions to show the Python documentation.</td>
@@ -514,7 +514,7 @@
 <td>Private slot to show the PyQt5 documentation.</td>
 </tr><tr>
 <td><a href="#UserInterface.__showPySideDoc">__showPySideDoc</a></td>
-<td>Private slot to show the PySide documentation.</td>
+<td>Private slot to show the PySide/PySide2 documentation.</td>
 </tr><tr>
 <td><a href="#UserInterface.__showPython2Doc">__showPython2Doc</a></td>
 <td>Private slot to show the Python 2 documentation.</td>
@@ -756,11 +756,14 @@
 <td><a href="#UserInterface.getViewProfile">getViewProfile</a></td>
 <td>Public method to get the current view profile.</td>
 </tr><tr>
+<td><a href="#UserInterface.handleUrl">handleUrl</a></td>
+<td>Public slot to handle opening a URL.</td>
+</tr><tr>
 <td><a href="#UserInterface.isOnline">isOnline</a></td>
 <td>Public method to get the online state.</td>
 </tr><tr>
 <td><a href="#UserInterface.launchHelpViewer">launchHelpViewer</a></td>
-<td>Public slot to start the help viewer.</td>
+<td>Public slot to start the help viewer/web browser.</td>
 </tr><tr>
 <td><a href="#UserInterface.notificationsEnabled">notificationsEnabled</a></td>
 <td>Public method to check, if notifications are enabled.</td>
@@ -1223,7 +1226,7 @@
 <h4>UserInterface.__helpViewer</h4>
 <b>__helpViewer</b>(<i></i>)
 <p>
-        Private slot to start an empty help viewer.
+        Private slot to start an empty help viewer/web browser.
 </p><a NAME="UserInterface.__importPreferences" ID="UserInterface.__importPreferences"></a>
 <h4>UserInterface.__importPreferences</h4>
 <b>__importPreferences</b>(<i></i>)
@@ -1259,11 +1262,12 @@
 <b>__initMenus</b>(<i></i>)
 <p>
         Private slot to create the menus.
-</p><a NAME="UserInterface.__initPySideDocAction" ID="UserInterface.__initPySideDocAction"></a>
-<h4>UserInterface.__initPySideDocAction</h4>
-<b>__initPySideDocAction</b>(<i></i>)
+</p><a NAME="UserInterface.__initPySideDocActions" ID="UserInterface.__initPySideDocActions"></a>
+<h4>UserInterface.__initPySideDocActions</h4>
+<b>__initPySideDocActions</b>(<i></i>)
 <p>
-        Private slot to initialize the action to show the PySide documentation.
+        Private slot to initialize the actions to show the PySide
+        documentation.
 </p><a NAME="UserInterface.__initPythonDocActions" ID="UserInterface.__initPythonDocActions"></a>
 <h4>UserInterface.__initPythonDocActions</h4>
 <b>__initPythonDocActions</b>(<i></i>)
@@ -1669,10 +1673,15 @@
         Private slot to show the PyQt5 documentation.
 </p><a NAME="UserInterface.__showPySideDoc" ID="UserInterface.__showPySideDoc"></a>
 <h4>UserInterface.__showPySideDoc</h4>
-<b>__showPySideDoc</b>(<i></i>)
+<b>__showPySideDoc</b>(<i>variant</i>)
 <p>
-        Private slot to show the PySide documentation.
-</p><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a>
+        Private slot to show the PySide/PySide2 documentation.
+</p><dl>
+<dt><i>variant</i> (str)</dt>
+<dd>
+PySide variant (1 or 2)
+</dd>
+</dl><a NAME="UserInterface.__showPython2Doc" ID="UserInterface.__showPython2Doc"></a>
 <h4>UserInterface.__showPython2Doc</h4>
 <b>__showPython2Doc</b>(<i></i>)
 <p>
@@ -2379,6 +2388,16 @@
 <dd>
 the name of the current view profile (string)
 </dd>
+</dl><a NAME="UserInterface.handleUrl" ID="UserInterface.handleUrl"></a>
+<h4>UserInterface.handleUrl</h4>
+<b>handleUrl</b>(<i>url</i>)
+<p>
+        Public slot to handle opening a URL.
+</p><dl>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to be shown
+</dd>
 </dl><a NAME="UserInterface.isOnline" ID="UserInterface.isOnline"></a>
 <h4>UserInterface.isOnline</h4>
 <b>isOnline</b>(<i></i>)
@@ -2398,18 +2417,17 @@
 <h4>UserInterface.launchHelpViewer</h4>
 <b>launchHelpViewer</b>(<i>home, searchWord=None, useSingle=False</i>)
 <p>
-        Public slot to start the help viewer.
+        Public slot to start the help viewer/web browser.
 </p><dl>
-<dt><i>home</i></dt>
+<dt><i>home</i> (str or QUrl)</dt>
 <dd>
-filename of file to be shown (string)
-</dd><dt><i>searchWord=</i></dt>
+filename of file to be shown or URL to be opened
+</dd><dt><i>searchWord=</i> (str)</dt>
 <dd>
-word to search for (string)
-</dd><dt><i>useSingle=</i></dt>
+word to search for
+</dd><dt><i>useSingle=</i> (bool)</dt>
 <dd>
 flag indicating to use a single browser window
-            (boolean)
 </dd>
 </dl><a NAME="UserInterface.notificationsEnabled" ID="UserInterface.notificationsEnabled"></a>
 <h4>UserInterface.notificationsEnabled</h4>

eric ide

mercurial