Updated source docu

Thu, 10 May 2018 18:44:19 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 10 May 2018 18:44:19 +0200
changeset 6282
ed511d6b2547
parent 6281
9f7bbfd6545d
child 6283
7934c1862119

Updated source docu

APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
Documentation/Help/source.qch file | annotate | diff | comparison | revisions
Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
Documentation/Source/eric6.E5Gui.E5MapWidget.html file | annotate | diff | comparison | revisions
Documentation/Source/eric6.WebBrowser.Network.NetworkUrlInterceptor.html file | annotate | diff | comparison | revisions
changelog file | annotate | diff | comparison | revisions
--- a/APIs/Python3/eric6.api	Thu May 10 18:42:17 2018 +0200
+++ b/APIs/Python3/eric6.api	Thu May 10 18:44:19 2018 +0200
@@ -976,6 +976,7 @@
 eric6.E5Gui.E5MapWidget.E5MapWidget.calculateGeometry?4()
 eric6.E5Gui.E5MapWidget.E5MapWidget.generateIndicatorRect?4(position)
 eric6.E5Gui.E5MapWidget.E5MapWidget.isEnabled?4()
+eric6.E5Gui.E5MapWidget.E5MapWidget.isOnRightSide?4()
 eric6.E5Gui.E5MapWidget.E5MapWidget.lineDimensions?4()
 eric6.E5Gui.E5MapWidget.E5MapWidget.mouseMoveEvent?4(event)
 eric6.E5Gui.E5MapWidget.E5MapWidget.mousePressEvent?4(event)
@@ -985,6 +986,7 @@
 eric6.E5Gui.E5MapWidget.E5MapWidget.setBackgroundColor?4(color)
 eric6.E5Gui.E5MapWidget.E5MapWidget.setEnabled?4(enable)
 eric6.E5Gui.E5MapWidget.E5MapWidget.setLineDimensions?4(border, height)
+eric6.E5Gui.E5MapWidget.E5MapWidget.setMapPosition?4(onRight)
 eric6.E5Gui.E5MapWidget.E5MapWidget.setMaster?4(master)
 eric6.E5Gui.E5MapWidget.E5MapWidget.setWidth?4(width)
 eric6.E5Gui.E5MapWidget.E5MapWidget.sizeHint?4()
Binary file Documentation/Help/source.qch has changed
--- a/Documentation/Help/source.qhp	Thu May 10 18:42:17 2018 +0200
+++ b/Documentation/Help/source.qhp	Thu May 10 18:44:19 2018 +0200
@@ -4539,6 +4539,7 @@
       <keyword name="E5MapWidget.calculateGeometry" id="E5MapWidget.calculateGeometry" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.calculateGeometry" />
       <keyword name="E5MapWidget.generateIndicatorRect" id="E5MapWidget.generateIndicatorRect" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.generateIndicatorRect" />
       <keyword name="E5MapWidget.isEnabled" id="E5MapWidget.isEnabled" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.isEnabled" />
+      <keyword name="E5MapWidget.isOnRightSide" id="E5MapWidget.isOnRightSide" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.isOnRightSide" />
       <keyword name="E5MapWidget.lineDimensions" id="E5MapWidget.lineDimensions" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.lineDimensions" />
       <keyword name="E5MapWidget.mouseMoveEvent" id="E5MapWidget.mouseMoveEvent" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.mouseMoveEvent" />
       <keyword name="E5MapWidget.mousePressEvent" id="E5MapWidget.mousePressEvent" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.mousePressEvent" />
@@ -4548,6 +4549,7 @@
       <keyword name="E5MapWidget.setBackgroundColor" id="E5MapWidget.setBackgroundColor" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setBackgroundColor" />
       <keyword name="E5MapWidget.setEnabled" id="E5MapWidget.setEnabled" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setEnabled" />
       <keyword name="E5MapWidget.setLineDimensions" id="E5MapWidget.setLineDimensions" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setLineDimensions" />
+      <keyword name="E5MapWidget.setMapPosition" id="E5MapWidget.setMapPosition" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setMapPosition" />
       <keyword name="E5MapWidget.setMaster" id="E5MapWidget.setMaster" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setMaster" />
       <keyword name="E5MapWidget.setWidth" id="E5MapWidget.setWidth" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.setWidth" />
       <keyword name="E5MapWidget.sizeHint" id="E5MapWidget.sizeHint" ref="eric6.E5Gui.E5MapWidget.html#E5MapWidget.sizeHint" />
@@ -11329,6 +11331,11 @@
       <keyword name="NetworkUrlInterceptor (Constructor)" id="NetworkUrlInterceptor (Constructor)" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__init__" />
       <keyword name="NetworkUrlInterceptor (Module)" id="NetworkUrlInterceptor (Module)" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html" />
       <keyword name="NetworkUrlInterceptor.__loadSettings" id="NetworkUrlInterceptor.__loadSettings" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__loadSettings" />
+      <keyword name="NetworkUrlInterceptor.__potentiallyTrustworthy" id="NetworkUrlInterceptor.__potentiallyTrustworthy" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__potentiallyTrustworthy" />
+      <keyword name="NetworkUrlInterceptor.__refererOrigin" id="NetworkUrlInterceptor.__refererOrigin" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__refererOrigin" />
+      <keyword name="NetworkUrlInterceptor.__sameOrigin" id="NetworkUrlInterceptor.__sameOrigin" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__sameOrigin" />
+      <keyword name="NetworkUrlInterceptor.__setRefererHeader" id="NetworkUrlInterceptor.__setRefererHeader" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__setRefererHeader" />
+      <keyword name="NetworkUrlInterceptor.__trimmedReferer" id="NetworkUrlInterceptor.__trimmedReferer" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.__trimmedReferer" />
       <keyword name="NetworkUrlInterceptor.installUrlInterceptor" id="NetworkUrlInterceptor.installUrlInterceptor" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.installUrlInterceptor" />
       <keyword name="NetworkUrlInterceptor.interceptRequest" id="NetworkUrlInterceptor.interceptRequest" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.interceptRequest" />
       <keyword name="NetworkUrlInterceptor.preferencesChanged" id="NetworkUrlInterceptor.preferencesChanged" ref="eric6.WebBrowser.Network.NetworkUrlInterceptor.html#NetworkUrlInterceptor.preferencesChanged" />
--- a/Documentation/Source/eric6.E5Gui.E5MapWidget.html	Thu May 10 18:42:17 2018 +0200
+++ b/Documentation/Source/eric6.E5Gui.E5MapWidget.html	Thu May 10 18:44:19 2018 +0200
@@ -84,6 +84,9 @@
 <td><a href="#E5MapWidget.isEnabled">isEnabled</a></td>
 <td>Public method to check the enabled state.</td>
 </tr><tr>
+<td><a href="#E5MapWidget.isOnRightSide">isOnRightSide</a></td>
+<td>Public method to test, if the map is shown on the right side of the master widget.</td>
+</tr><tr>
 <td><a href="#E5MapWidget.lineDimensions">lineDimensions</a></td>
 <td>Public method to get the line (indicator) dimensions.</td>
 </tr><tr>
@@ -111,6 +114,9 @@
 <td><a href="#E5MapWidget.setLineDimensions">setLineDimensions</a></td>
 <td>Public method to set the line (indicator) dimensions.</td>
 </tr><tr>
+<td><a href="#E5MapWidget.setMapPosition">setMapPosition</a></td>
+<td>Public method to set, whether the map should be shown to the right or left of the master widget.</td>
+</tr><tr>
 <td><a href="#E5MapWidget.setMaster">setMaster</a></td>
 <td>Public method to set the map master widget.</td>
 </tr><tr>
@@ -222,6 +228,23 @@
 <dd>
 flag indicating the enabled state (boolean)
 </dd>
+</dl><a NAME="E5MapWidget.isOnRightSide" ID="E5MapWidget.isOnRightSide"></a>
+<h4>E5MapWidget.isOnRightSide</h4>
+<b>isOnRightSide</b>(<i></i>)
+<p>
+        Public method to test, if the map is shown on the right side of the
+        master widget.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating that the map is to the right of the master
+            widget
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="E5MapWidget.lineDimensions" ID="E5MapWidget.lineDimensions"></a>
 <h4>E5MapWidget.lineDimensions</h4>
 <b>lineDimensions</b>(<i></i>)
@@ -330,6 +353,18 @@
 <dd>
 height of the line in pixels (integer)
 </dd>
+</dl><a NAME="E5MapWidget.setMapPosition" ID="E5MapWidget.setMapPosition"></a>
+<h4>E5MapWidget.setMapPosition</h4>
+<b>setMapPosition</b>(<i>onRight</i>)
+<p>
+        Public method to set, whether the map should be shown to the right or
+        left of the master widget.
+</p><dl>
+<dt><i>onRight</i> (bool)</dt>
+<dd>
+flag indicating to show the map on the right side of
+            the master widget
+</dd>
 </dl><a NAME="E5MapWidget.setMaster" ID="E5MapWidget.setMaster"></a>
 <h4>E5MapWidget.setMaster</h4>
 <b>setMaster</b>(<i>master</i>)
--- a/Documentation/Source/eric6.WebBrowser.Network.NetworkUrlInterceptor.html	Thu May 10 18:42:17 2018 +0200
+++ b/Documentation/Source/eric6.WebBrowser.Network.NetworkUrlInterceptor.html	Thu May 10 18:44:19 2018 +0200
@@ -64,6 +64,21 @@
 <td><a href="#NetworkUrlInterceptor.__loadSettings">__loadSettings</a></td>
 <td>Private method to load the Network Manager settings.</td>
 </tr><tr>
+<td><a href="#NetworkUrlInterceptor.__potentiallyTrustworthy">__potentiallyTrustworthy</a></td>
+<td>Private method to check, if the given URL is potentially trustworthy.</td>
+</tr><tr>
+<td><a href="#NetworkUrlInterceptor.__refererOrigin">__refererOrigin</a></td>
+<td>Private method to generate an origin referer header URL.</td>
+</tr><tr>
+<td><a href="#NetworkUrlInterceptor.__sameOrigin">__sameOrigin</a></td>
+<td>Private method to test the "same origin" policy.</td>
+</tr><tr>
+<td><a href="#NetworkUrlInterceptor.__setRefererHeader">__setRefererHeader</a></td>
+<td>Private method to set the 'Referer' header depending on the configured rule set.</td>
+</tr><tr>
+<td><a href="#NetworkUrlInterceptor.__trimmedReferer">__trimmedReferer</a></td>
+<td>Private method to generate the trimmed referer header URL.</td>
+</tr><tr>
 <td><a href="#NetworkUrlInterceptor.installUrlInterceptor">installUrlInterceptor</a></td>
 <td>Public method to install an URL interceptor.</td>
 </tr><tr>
@@ -96,7 +111,109 @@
 <b>__loadSettings</b>(<i></i>)
 <p>
         Private method to load the Network Manager settings.
-</p><a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a>
+</p><a NAME="NetworkUrlInterceptor.__potentiallyTrustworthy" ID="NetworkUrlInterceptor.__potentiallyTrustworthy"></a>
+<h4>NetworkUrlInterceptor.__potentiallyTrustworthy</h4>
+<b>__potentiallyTrustworthy</b>(<i>url</i>)
+<p>
+        Private method to check, if the given URL is potentially trustworthy.
+</p><dl>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to be checked
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a potentially trustworthy URL
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="NetworkUrlInterceptor.__refererOrigin" ID="NetworkUrlInterceptor.__refererOrigin"></a>
+<h4>NetworkUrlInterceptor.__refererOrigin</h4>
+<b>__refererOrigin</b>(<i>url</i>)
+<p>
+        Private method to generate an origin referer header URL.
+</p><dl>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to generate the header from
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+origin referer header URL
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QByteArray or bytes
+</dd>
+</dl><a NAME="NetworkUrlInterceptor.__sameOrigin" ID="NetworkUrlInterceptor.__sameOrigin"></a>
+<h4>NetworkUrlInterceptor.__sameOrigin</h4>
+<b>__sameOrigin</b>(<i>url1, url2</i>)
+<p>
+        Private method to test the "same origin" policy.
+</p><dl>
+<dt><i>url1</i> (QUrl)</dt>
+<dd>
+first URL for the test
+</dd><dt><i>url2</i> (QUrl)</dt>
+<dd>
+second URL for the test
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating that both URLs have the same origin
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="NetworkUrlInterceptor.__setRefererHeader" ID="NetworkUrlInterceptor.__setRefererHeader"></a>
+<h4>NetworkUrlInterceptor.__setRefererHeader</h4>
+<b>__setRefererHeader</b>(<i>info</i>)
+<p>
+        Private method to set the 'Referer' header depending on the configured
+        rule set.
+</p><dl>
+<dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
+<dd>
+URL request information
+</dd>
+</dl><dl>
+<dt><b>See Also:</b></dt>
+<dd>
+<a href="https://wiki.mozilla.org/Security/Referrer">            Mozilla Referrer</a>
+</dd>
+<dd>
+<a href="https://www.w3.org/TR/referrer-policy/">            W3C Referrer Policy</a>
+</dd>
+</dl><a NAME="NetworkUrlInterceptor.__trimmedReferer" ID="NetworkUrlInterceptor.__trimmedReferer"></a>
+<h4>NetworkUrlInterceptor.__trimmedReferer</h4>
+<b>__trimmedReferer</b>(<i>url</i>)
+<p>
+        Private method to generate the trimmed referer header URL.
+</p><dl>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to be trimmed as a referer header
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+trimmed referer header URL
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QByteArray or bytes
+</dd>
+</dl><a NAME="NetworkUrlInterceptor.installUrlInterceptor" ID="NetworkUrlInterceptor.installUrlInterceptor"></a>
 <h4>NetworkUrlInterceptor.installUrlInterceptor</h4>
 <b>installUrlInterceptor</b>(<i>interceptor</i>)
 <p>
--- a/changelog	Thu May 10 18:42:17 2018 +0200
+++ b/changelog	Thu May 10 18:44:19 2018 +0200
@@ -5,6 +5,8 @@
 - Editor
   -- added a configuration option (Editor->Style page) to show the marker map
      on the left or right of the editor
+- Web Browser (NG)
+  -- improved the sending of the "Referer" header like it is done by Firefox
 
 Version 18.05:
 - bug fixes

eric ide

mercurial