src/eric7/Documentation/Source/eric7.PdfViewer.PdfPageSelector.html

branch
eric7
changeset 9730
00cf7289d899
child 10479
856476537696
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.PdfViewer.PdfPageSelector.html	Tue Jan 24 11:54:40 2023 +0100
@@ -0,0 +1,253 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.PdfViewer.PdfPageSelector</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.PdfViewer.PdfPageSelector</h1>
+
+<p>
+Module implementing a widget to select a PDF page to be shown.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#PdfPageSelector">PdfPageSelector</a></td>
+<td>Class implementing a widget to select a PDF page to be shown.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="PdfPageSelector" ID="PdfPageSelector"></a>
+<h2>PdfPageSelector</h2>
+
+<p>
+    Class implementing a widget to select a PDF page to be shown.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>gotoPage()</dt>
+<dd>
+emitted to indicate the want to enter a page number via the
+        Go To dialog
+</dd>
+<dt>valueChanged(int)</dt>
+<dd>
+emitted to signal the new value of the selector
+</dd>
+</dl>
+<h3>Derived from</h3>
+QWidget
+<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="#PdfPageSelector.__init__">PdfPageSelector</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__decrement">__decrement</a></td>
+<td>Private slot to decrement the current value.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__documentStatusChanged">__documentStatusChanged</a></td>
+<td>Private slot to handle a change of the document status.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__increment">__increment</a></td>
+<td>Private slot to increment the current value.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__initialize">__initialize</a></td>
+<td>Private method to initialize some internal state.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__pageButtonTriggered">__pageButtonTriggered</a></td>
+<td>Private slot to handle the page button trigger.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.__pageEntered">__pageEntered</a></td>
+<td>Private slot to handle the entering of a page value.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.setDocument">setDocument</a></td>
+<td>Public method to set a reference to the associated PDF document.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.setMaximum">setMaximum</a></td>
+<td>Public method to set the maximum value.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.setValue">setValue</a></td>
+<td>Public slot to set the value.</td>
+</tr>
+<tr>
+<td><a href="#PdfPageSelector.value">value</a></td>
+<td>Public method to get the current value.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="PdfPageSelector.__init__" ID="PdfPageSelector.__init__"></a>
+<h4>PdfPageSelector (Constructor)</h4>
+<b>PdfPageSelector</b>(<i>parent=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="PdfPageSelector.__decrement" ID="PdfPageSelector.__decrement"></a>
+<h4>PdfPageSelector.__decrement</h4>
+<b>__decrement</b>(<i></i>)
+
+<p>
+        Private slot to decrement the current value.
+</p>
+<a NAME="PdfPageSelector.__documentStatusChanged" ID="PdfPageSelector.__documentStatusChanged"></a>
+<h4>PdfPageSelector.__documentStatusChanged</h4>
+<b>__documentStatusChanged</b>(<i>status</i>)
+
+<p>
+        Private slot to handle a change of the document status.
+</p>
+<dl>
+
+<dt><i>status</i> (QPdfDocument.Status)</dt>
+<dd>
+current document status
+</dd>
+</dl>
+<a NAME="PdfPageSelector.__increment" ID="PdfPageSelector.__increment"></a>
+<h4>PdfPageSelector.__increment</h4>
+<b>__increment</b>(<i></i>)
+
+<p>
+        Private slot to increment the current value.
+</p>
+<a NAME="PdfPageSelector.__initialize" ID="PdfPageSelector.__initialize"></a>
+<h4>PdfPageSelector.__initialize</h4>
+<b>__initialize</b>(<i></i>)
+
+<p>
+        Private method to initialize some internal state.
+</p>
+<a NAME="PdfPageSelector.__pageButtonTriggered" ID="PdfPageSelector.__pageButtonTriggered"></a>
+<h4>PdfPageSelector.__pageButtonTriggered</h4>
+<b>__pageButtonTriggered</b>(<i></i>)
+
+<p>
+        Private slot to handle the page button trigger.
+</p>
+<a NAME="PdfPageSelector.__pageEntered" ID="PdfPageSelector.__pageEntered"></a>
+<h4>PdfPageSelector.__pageEntered</h4>
+<b>__pageEntered</b>(<i></i>)
+
+<p>
+        Private slot to handle the entering of a page value.
+</p>
+<a NAME="PdfPageSelector.setDocument" ID="PdfPageSelector.setDocument"></a>
+<h4>PdfPageSelector.setDocument</h4>
+<b>setDocument</b>(<i>document</i>)
+
+<p>
+        Public method to set a reference to the associated PDF document.
+</p>
+<dl>
+
+<dt><i>document</i> (QPdfDocument)</dt>
+<dd>
+reference to the associated PDF document
+</dd>
+</dl>
+<a NAME="PdfPageSelector.setMaximum" ID="PdfPageSelector.setMaximum"></a>
+<h4>PdfPageSelector.setMaximum</h4>
+<b>setMaximum</b>(<i>maximum</i>)
+
+<p>
+        Public method to set the maximum value.
+</p>
+<p>
+        Note: maximum is 0 based.
+</p>
+<dl>
+
+<dt><i>maximum</i> (int)</dt>
+<dd>
+maximum value to be set
+</dd>
+</dl>
+<a NAME="PdfPageSelector.setValue" ID="PdfPageSelector.setValue"></a>
+<h4>PdfPageSelector.setValue</h4>
+<b>setValue</b>(<i>value</i>)
+
+<p>
+        Public slot to set the value.
+</p>
+<p>
+        Note: value is 0 based.
+</p>
+<dl>
+
+<dt><i>value</i> (int)</dt>
+<dd>
+value to be set
+</dd>
+</dl>
+<a NAME="PdfPageSelector.value" ID="PdfPageSelector.value"></a>
+<h4>PdfPageSelector.value</h4>
+<b>value</b>(<i></i>)
+
+<p>
+        Public method to get the current value.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+current value
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial