--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.PdfViewer.PdfInfoWidget.html Tue Jan 24 11:54:40 2023 +0100 @@ -0,0 +1,171 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.PdfViewer.PdfInfoWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.PdfViewer.PdfInfoWidget</h1> + +<p> +Module implementing an info widget showing data of a PDF document. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#PdfInfoWidget">PdfInfoWidget</a></td> +<td>Class implementing an info widget showing data of a PDF document.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="PdfInfoWidget" ID="PdfInfoWidget"></a> +<h2>PdfInfoWidget</h2> + +<p> + Class implementing an info widget showing data of a PDF document. +</p> +<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="#PdfInfoWidget.__init__">PdfInfoWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#PdfInfoWidget.__handlePageCountChanged">__handlePageCountChanged</a></td> +<td>Private slot to handle a change of the page count.</td> +</tr> +<tr> +<td><a href="#PdfInfoWidget.__handlePasswordChanged">__handlePasswordChanged</a></td> +<td>Private slot to handle a change of the password.</td> +</tr> +<tr> +<td><a href="#PdfInfoWidget.__populateInfoLabels">__populateInfoLabels</a></td> +<td>Private slot to populate the info labels upon a change of the document status.</td> +</tr> +<tr> +<td><a href="#PdfInfoWidget.setDocument">setDocument</a></td> +<td>Public method to set the reference to the PDF document.</td> +</tr> +<tr> +<td><a href="#PdfInfoWidget.setFileName">setFileName</a></td> +<td>Public method to set the file name info.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="PdfInfoWidget.__init__" ID="PdfInfoWidget.__init__"></a> +<h4>PdfInfoWidget (Constructor)</h4> +<b>PdfInfoWidget</b>(<i>document, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>document</i> (QPdfDocument)</dt> +<dd> +reference to the PDF document object +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="PdfInfoWidget.__handlePageCountChanged" ID="PdfInfoWidget.__handlePageCountChanged"></a> +<h4>PdfInfoWidget.__handlePageCountChanged</h4> +<b>__handlePageCountChanged</b>(<i>pageCount</i>) + +<p> + Private slot to handle a change of the page count. +</p> +<dl> + +<dt><i>pageCount</i> (int)</dt> +<dd> +changed page count +</dd> +</dl> +<a NAME="PdfInfoWidget.__handlePasswordChanged" ID="PdfInfoWidget.__handlePasswordChanged"></a> +<h4>PdfInfoWidget.__handlePasswordChanged</h4> +<b>__handlePasswordChanged</b>(<i></i>) + +<p> + Private slot to handle a change of the password. +</p> +<a NAME="PdfInfoWidget.__populateInfoLabels" ID="PdfInfoWidget.__populateInfoLabels"></a> +<h4>PdfInfoWidget.__populateInfoLabels</h4> +<b>__populateInfoLabels</b>(<i>status</i>) + +<p> + Private slot to populate the info labels upon a change of the document status. +</p> +<dl> + +<dt><i>status</i> (QPdfDocument.Status)</dt> +<dd> +document status +</dd> +</dl> +<a NAME="PdfInfoWidget.setDocument" ID="PdfInfoWidget.setDocument"></a> +<h4>PdfInfoWidget.setDocument</h4> +<b>setDocument</b>(<i>document</i>) + +<p> + Public method to set the reference to the PDF document. +</p> +<dl> + +<dt><i>document</i> (QPdfDocument)</dt> +<dd> +reference to the document +</dd> +</dl> +<a NAME="PdfInfoWidget.setFileName" ID="PdfInfoWidget.setFileName"></a> +<h4>PdfInfoWidget.setFileName</h4> +<b>setFileName</b>(<i>filename</i>) + +<p> + Public method to set the file name info. +</p> +<dl> + +<dt><i>filename</i> (TYPE)</dt> +<dd> +DESCRIPTION +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file