--- a/eric6/Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.AutoScroll.AutoScroller.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,253 +18,329 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.AutoScroll.AutoScroller</h1> + <p> Module implementing the automatic scroller. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#AutoScroller">AutoScroller</a></td> <td>Class implementing the automatic scroller.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="AutoScroller" ID="AutoScroller"></a> <h2>AutoScroller</h2> + <p> Class implementing the automatic scroller. </p> <h3>Derived from</h3> QObject <h3>Class Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#AutoScroller.__init__">AutoScroller</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.__indicatorGlobalRect">__indicatorGlobalRect</a></td> <td>Private method to calculate the global indicator parameters.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.__showIndicator">__showIndicator</a></td> <td>Private method to show the auto scroll indicator.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.__stopScrolling">__stopScrolling</a></td> <td>Private method to stop scrolling.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.eventFilter">eventFilter</a></td> <td>Public method to handle event for an object.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.isEnabled">isEnabled</a></td> <td>Public method to get the enabled state.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.mouseMove">mouseMove</a></td> <td>Public method to handle mouse move events.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.mousePress">mousePress</a></td> <td>Public method to handle mouse button presses.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.mouseRelease">mouseRelease</a></td> <td>Public method to handle mouse button releases.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.preferencesChanged">preferencesChanged</a></td> <td>Public method to handle a change of the settings.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AutoScroller.wheel">wheel</a></td> <td>Public method to handle a mouse wheel event.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="AutoScroller.__init__" ID="AutoScroller.__init__"></a> <h4>AutoScroller (Constructor)</h4> <b>AutoScroller</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i> (QObject)</dt> <dd> reference to the parent object </dd> -</dl><a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a> +</dl> +<a NAME="AutoScroller.__indicatorGlobalRect" ID="AutoScroller.__indicatorGlobalRect"></a> <h4>AutoScroller.__indicatorGlobalRect</h4> <b>__indicatorGlobalRect</b>(<i></i>) + <p> Private method to calculate the global indicator parameters. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> global indicator parameters </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> QRect </dd> -</dl><a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a> +</dl> +<a NAME="AutoScroller.__showIndicator" ID="AutoScroller.__showIndicator"></a> <h4>AutoScroller.__showIndicator</h4> <b>__showIndicator</b>(<i>view, pos</i>) + <p> Private method to show the auto scroll indicator. -</p><dl> +</p> +<dl> + <dt><i>view</i> (WebBrowserView)</dt> <dd> reference to the view to show the indicator on -</dd><dt><i>pos</i> (QPoint)</dt> +</dd> +<dt><i>pos</i> (QPoint)</dt> <dd> position to show the indicator at </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the indicator is shown </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a> +</dl> +<a NAME="AutoScroller.__stopScrolling" ID="AutoScroller.__stopScrolling"></a> <h4>AutoScroller.__stopScrolling</h4> <b>__stopScrolling</b>(<i></i>) + <p> Private method to stop scrolling. -</p><a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a> +</p> +<a NAME="AutoScroller.eventFilter" ID="AutoScroller.eventFilter"></a> <h4>AutoScroller.eventFilter</h4> <b>eventFilter</b>(<i>obj, evt</i>) + <p> Public method to handle event for an object. -</p><dl> +</p> +<dl> + <dt><i>obj</i> (QObject)</dt> <dd> refernce to the object sending the event -</dd><dt><i>evt</i> (QEvent)</dt> +</dd> +<dt><i>evt</i> (QEvent)</dt> <dd> reference to the event to be handled </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the event was handled </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.isEnabled" ID="AutoScroller.isEnabled"></a> +</dl> +<a NAME="AutoScroller.isEnabled" ID="AutoScroller.isEnabled"></a> <h4>AutoScroller.isEnabled</h4> <b>isEnabled</b>(<i></i>) + <p> Public method to get the enabled state. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> enabled state </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a> +</dl> +<a NAME="AutoScroller.mouseMove" ID="AutoScroller.mouseMove"></a> <h4>AutoScroller.mouseMove</h4> <b>mouseMove</b>(<i>evt</i>) + <p> Public method to handle mouse move events. -</p><dl> +</p> +<dl> + <dt><i>evt</i> (QMouseEvent)</dt> <dd> reference to the mouse move event </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the event was handled </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a> +</dl> +<a NAME="AutoScroller.mousePress" ID="AutoScroller.mousePress"></a> <h4>AutoScroller.mousePress</h4> <b>mousePress</b>(<i>view, evt</i>) + <p> Public method to handle mouse button presses. -</p><dl> +</p> +<dl> + <dt><i>view</i> (WebBrowserView)</dt> <dd> reference to the web view the button was pressed on -</dd><dt><i>evt</i> (QMouseEvent)</dt> +</dd> +<dt><i>evt</i> (QMouseEvent)</dt> <dd> reference to the mouse button press event </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the event was handled </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a> +</dl> +<a NAME="AutoScroller.mouseRelease" ID="AutoScroller.mouseRelease"></a> <h4>AutoScroller.mouseRelease</h4> <b>mouseRelease</b>(<i>evt</i>) + <p> Public method to handle mouse button releases. -</p><dl> +</p> +<dl> + <dt><i>evt</i> (QMouseEvent)</dt> <dd> reference to the mouse button release event </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the event was handled </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a> +</dl> +<a NAME="AutoScroller.preferencesChanged" ID="AutoScroller.preferencesChanged"></a> <h4>AutoScroller.preferencesChanged</h4> <b>preferencesChanged</b>(<i></i>) + <p> Public method to handle a change of the settings. -</p><a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a> +</p> +<a NAME="AutoScroller.wheel" ID="AutoScroller.wheel"></a> <h4>AutoScroller.wheel</h4> <b>wheel</b>(<i></i>) + <p> Public method to handle a mouse wheel event. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> flag indicating, that the event was handled </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool