--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.AutoScroll.FrameScroller.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.AutoScroll.FrameScroller</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.WebBrowser.AutoScroll.FrameScroller</h1> + +<p> +Module implementing an object to scroll a web page. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#FrameScroller">FrameScroller</a></td> +<td>Class implementing a web page scroller object.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="FrameScroller" ID="FrameScroller"></a> +<h2>FrameScroller</h2> + +<p> + Class implementing a web page scroller object. +</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="#FrameScroller.__init__">FrameScroller</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#FrameScroller.__scrollStep">__scrollStep</a></td> +<td>Private slot to scroll one step.</td> +</tr> +<tr> +<td><a href="#FrameScroller.scrollDivider">scrollDivider</a></td> +<td>Public method to get the current scroll divider value.</td> +</tr> +<tr> +<td><a href="#FrameScroller.setPage">setPage</a></td> +<td>Public method to set the web page to be scrolled.</td> +</tr> +<tr> +<td><a href="#FrameScroller.setScrollDivider">setScrollDivider</a></td> +<td>Public method to set the scroll divider value.</td> +</tr> +<tr> +<td><a href="#FrameScroller.startScrolling">startScrolling</a></td> +<td>Public method to start scrolling.</td> +</tr> +<tr> +<td><a href="#FrameScroller.stopScrolling">stopScrolling</a></td> +<td>Public method to stop scrolling.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="FrameScroller.__init__" ID="FrameScroller.__init__"></a> +<h4>FrameScroller (Constructor)</h4> +<b>FrameScroller</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QObject)</dt> +<dd> +reference to the parent object +</dd> +</dl> +<a NAME="FrameScroller.__scrollStep" ID="FrameScroller.__scrollStep"></a> +<h4>FrameScroller.__scrollStep</h4> +<b>__scrollStep</b>(<i></i>) + +<p> + Private slot to scroll one step. +</p> +<a NAME="FrameScroller.scrollDivider" ID="FrameScroller.scrollDivider"></a> +<h4>FrameScroller.scrollDivider</h4> +<b>scrollDivider</b>(<i></i>) + +<p> + Public method to get the current scroll divider value. +</p> +<dl> +<dt>Return:</dt> +<dd> +scroll divider +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +float +</dd> +</dl> +<a NAME="FrameScroller.setPage" ID="FrameScroller.setPage"></a> +<h4>FrameScroller.setPage</h4> +<b>setPage</b>(<i>page</i>) + +<p> + Public method to set the web page to be scrolled. +</p> +<dl> + +<dt><i>page</i> (WebBrowserPage)</dt> +<dd> +page to be scrolled +</dd> +</dl> +<a NAME="FrameScroller.setScrollDivider" ID="FrameScroller.setScrollDivider"></a> +<h4>FrameScroller.setScrollDivider</h4> +<b>setScrollDivider</b>(<i>divider</i>) + +<p> + Public method to set the scroll divider value. +</p> +<dl> + +<dt><i>divider</i> (float)</dt> +<dd> +scroll divider +</dd> +</dl> +<a NAME="FrameScroller.startScrolling" ID="FrameScroller.startScrolling"></a> +<h4>FrameScroller.startScrolling</h4> +<b>startScrolling</b>(<i>lengthX, lengthY</i>) + +<p> + Public method to start scrolling. +</p> +<dl> + +<dt><i>lengthX</i> (int)</dt> +<dd> +X distance from scroll indicator +</dd> +<dt><i>lengthY</i> (int)</dt> +<dd> +Y distance from scroll indicator +</dd> +</dl> +<a NAME="FrameScroller.stopScrolling" ID="FrameScroller.stopScrolling"></a> +<h4>FrameScroller.stopScrolling</h4> +<b>stopScrolling</b>(<i></i>) + +<p> + Public method to stop scrolling. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file