diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.EricWidgets.EricZoomWidget.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricZoomWidget.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,522 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricWidgets.EricZoomWidget</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.EricWidgets.EricZoomWidget</h1> + +<p> +Module implementing a zoom widget for the status bar. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#EricZoomWidget">EricZoomWidget</a></td> +<td>Class implementing a zoom widget for the status bar.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="EricZoomWidget" ID="EricZoomWidget"></a> +<h2>EricZoomWidget</h2> + +<p> + Class implementing a zoom widget for the status bar. +</p> +<h3>Signals</h3> +<dl> + +<dt>valueChanged(value)</dt> +<dd> +emitted to indicate the new zoom value (int) +</dd> +</dl> +<h3>Derived from</h3> +QWidget, Ui_EricZoomWidget +<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="#EricZoomWidget.__init__">EricZoomWidget</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.__indexForValue">__indexForValue</a></td> +<td>Private method to get the nearest index for a given value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.__setValueLabelWidth">__setValueLabelWidth</a></td> +<td>Private slot to determine the width of the zoom value label.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.__zoomIn">__zoomIn</a></td> +<td>Private slot to zoom in one step.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.__zoomOut">__zoomOut</a></td> +<td>Private slot to zoom out one step.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.__zoomReset">__zoomReset</a></td> +<td>Private slot to reset the value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget._sliderValueChanged">_sliderValueChanged</a></td> +<td>Protected slot to handle changes of the slider value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.default">default</a></td> +<td>Public method to get the default zoom value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.isMapped">isMapped</a></td> +<td>Public method to check for a mapped zoom widget.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.isPercent">isPercent</a></td> +<td>Public method to get the percent mode.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.mapping">mapping</a></td> +<td>Public method to get the current mapping.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.maximum">maximum</a></td> +<td>Public method to get the maximum value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.minimum">minimum</a></td> +<td>Public method to get the minimum value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.on_slider_sliderMoved">on_slider_sliderMoved</a></td> +<td>Private slot to handle changes of the zoom value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.pageStep">pageStep</a></td> +<td>Public method to get the page step value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setDefault">setDefault</a></td> +<td>Public method to set the default zoom value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setMapping">setMapping</a></td> +<td>Public method to set a zoom level mapping.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setMaximum">setMaximum</a></td> +<td>Public method to set the maximum value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setMinimum">setMinimum</a></td> +<td>Public method to set the minimum value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setPageStep">setPageStep</a></td> +<td>Public method to set the page step value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setPercent">setPercent</a></td> +<td>Public method to set the percent mode of the widget.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setSingleStep">setSingleStep</a></td> +<td>Public method to set the single step value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.setValue">setValue</a></td> +<td>Public slot to set the value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.singleStep">singleStep</a></td> +<td>Public method to get the single step value.</td> +</tr> +<tr> +<td><a href="#EricZoomWidget.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="EricZoomWidget.__init__" ID="EricZoomWidget.__init__"></a> +<h4>EricZoomWidget (Constructor)</h4> +<b>EricZoomWidget</b>(<i>outPix, inPix, resetPix, parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>outPix</i></dt> +<dd> +pixmap for the zoom out button (QPixmap) +</dd> +<dt><i>inPix</i></dt> +<dd> +pixmap for the zoom in button (QPixmap) +</dd> +<dt><i>resetPix</i></dt> +<dd> +pixmap for the zoom reset button (QPixmap) +</dd> +<dt><i>parent</i></dt> +<dd> +reference to the parent widget (QWidget) +</dd> +</dl> +<a NAME="EricZoomWidget.__indexForValue" ID="EricZoomWidget.__indexForValue"></a> +<h4>EricZoomWidget.__indexForValue</h4> +<b>__indexForValue</b>(<i>value</i>) + +<p> + Private method to get the nearest index for a given value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +value to get the index for (integer) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +index into the mapping list or the unchanged value, + if mapping is not set (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.__setValueLabelWidth" ID="EricZoomWidget.__setValueLabelWidth"></a> +<h4>EricZoomWidget.__setValueLabelWidth</h4> +<b>__setValueLabelWidth</b>(<i></i>) + +<p> + Private slot to determine the width of the zoom value label. +</p> +<a NAME="EricZoomWidget.__zoomIn" ID="EricZoomWidget.__zoomIn"></a> +<h4>EricZoomWidget.__zoomIn</h4> +<b>__zoomIn</b>(<i></i>) + +<p> + Private slot to zoom in one step. +</p> +<a NAME="EricZoomWidget.__zoomOut" ID="EricZoomWidget.__zoomOut"></a> +<h4>EricZoomWidget.__zoomOut</h4> +<b>__zoomOut</b>(<i></i>) + +<p> + Private slot to zoom out one step. +</p> +<a NAME="EricZoomWidget.__zoomReset" ID="EricZoomWidget.__zoomReset"></a> +<h4>EricZoomWidget.__zoomReset</h4> +<b>__zoomReset</b>(<i></i>) + +<p> + Private slot to reset the value. +</p> +<a NAME="EricZoomWidget._sliderValueChanged" ID="EricZoomWidget._sliderValueChanged"></a> +<h4>EricZoomWidget._sliderValueChanged</h4> +<b>_sliderValueChanged</b>(<i>value</i>) + +<p> + Protected slot to handle changes of the slider value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +slider value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.default" ID="EricZoomWidget.default"></a> +<h4>EricZoomWidget.default</h4> +<b>default</b>(<i></i>) + +<p> + Public method to get the default zoom value. +</p> +<dl> +<dt>Return:</dt> +<dd> +default zoom value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.isMapped" ID="EricZoomWidget.isMapped"></a> +<h4>EricZoomWidget.isMapped</h4> +<b>isMapped</b>(<i></i>) + +<p> + Public method to check for a mapped zoom widget. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating a mapped zoom widget (boolean) +</dd> +</dl> +<a NAME="EricZoomWidget.isPercent" ID="EricZoomWidget.isPercent"></a> +<h4>EricZoomWidget.isPercent</h4> +<b>isPercent</b>(<i></i>) + +<p> + Public method to get the percent mode. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating percent mode (boolean) +</dd> +</dl> +<a NAME="EricZoomWidget.mapping" ID="EricZoomWidget.mapping"></a> +<h4>EricZoomWidget.mapping</h4> +<b>mapping</b>(<i></i>) + +<p> + Public method to get the current mapping. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of the mapping and the default index + (list of integer, integer) +</dd> +</dl> +<a NAME="EricZoomWidget.maximum" ID="EricZoomWidget.maximum"></a> +<h4>EricZoomWidget.maximum</h4> +<b>maximum</b>(<i></i>) + +<p> + Public method to get the maximum value. +</p> +<dl> +<dt>Return:</dt> +<dd> +maximum value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.minimum" ID="EricZoomWidget.minimum"></a> +<h4>EricZoomWidget.minimum</h4> +<b>minimum</b>(<i></i>) + +<p> + Public method to get the minimum value. +</p> +<dl> +<dt>Return:</dt> +<dd> +minimum value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.on_slider_sliderMoved" ID="EricZoomWidget.on_slider_sliderMoved"></a> +<h4>EricZoomWidget.on_slider_sliderMoved</h4> +<b>on_slider_sliderMoved</b>(<i>value</i>) + +<p> + Private slot to handle changes of the zoom value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +value of the slider (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.pageStep" ID="EricZoomWidget.pageStep"></a> +<h4>EricZoomWidget.pageStep</h4> +<b>pageStep</b>(<i></i>) + +<p> + Public method to get the page step value. +</p> +<dl> +<dt>Return:</dt> +<dd> +page step value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setDefault" ID="EricZoomWidget.setDefault"></a> +<h4>EricZoomWidget.setDefault</h4> +<b>setDefault</b>(<i>value</i>) + +<p> + Public method to set the default zoom value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +default zoom value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setMapping" ID="EricZoomWidget.setMapping"></a> +<h4>EricZoomWidget.setMapping</h4> +<b>setMapping</b>(<i>mapping, default, percent=True</i>) + +<p> + Public method to set a zoom level mapping. +</p> +<p> + When zoom level mapping is activated, the slider covers + values from 0 to the max. index of the mapping list. The + default value is the value of the default zoom level. If + percent is given, the zoom level is shown as a percent value. +</p> +<dl> + +<dt><i>mapping</i></dt> +<dd> +list of mapping values (list of integer) +</dd> +<dt><i>default</i></dt> +<dd> +index of the default value (integer) +</dd> +<dt><i>percent</i></dt> +<dd> +flag indicating to show zoom value in percent + (boolean) +</dd> +</dl> +<a NAME="EricZoomWidget.setMaximum" ID="EricZoomWidget.setMaximum"></a> +<h4>EricZoomWidget.setMaximum</h4> +<b>setMaximum</b>(<i>maximum</i>) + +<p> + Public method to set the maximum value. +</p> +<dl> + +<dt><i>maximum</i></dt> +<dd> +new maximum value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setMinimum" ID="EricZoomWidget.setMinimum"></a> +<h4>EricZoomWidget.setMinimum</h4> +<b>setMinimum</b>(<i>minimum</i>) + +<p> + Public method to set the minimum value. +</p> +<dl> + +<dt><i>minimum</i></dt> +<dd> +new minimum value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setPageStep" ID="EricZoomWidget.setPageStep"></a> +<h4>EricZoomWidget.setPageStep</h4> +<b>setPageStep</b>(<i>value</i>) + +<p> + Public method to set the page step value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +page step value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setPercent" ID="EricZoomWidget.setPercent"></a> +<h4>EricZoomWidget.setPercent</h4> +<b>setPercent</b>(<i>on</i>) + +<p> + Public method to set the percent mode of the widget. +</p> +<dl> + +<dt><i>on</i></dt> +<dd> +flag indicating percent mode (boolean) +</dd> +</dl> +<a NAME="EricZoomWidget.setSingleStep" ID="EricZoomWidget.setSingleStep"></a> +<h4>EricZoomWidget.setSingleStep</h4> +<b>setSingleStep</b>(<i>value</i>) + +<p> + Public method to set the single step value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +value for the single step (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.setValue" ID="EricZoomWidget.setValue"></a> +<h4>EricZoomWidget.setValue</h4> +<b>setValue</b>(<i>value</i>) + +<p> + Public slot to set the value. +</p> +<dl> + +<dt><i>value</i></dt> +<dd> +new zoom value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.singleStep" ID="EricZoomWidget.singleStep"></a> +<h4>EricZoomWidget.singleStep</h4> +<b>singleStep</b>(<i></i>) + +<p> + Public method to get the single step value. +</p> +<dl> +<dt>Return:</dt> +<dd> +single step value (integer) +</dd> +</dl> +<a NAME="EricZoomWidget.value" ID="EricZoomWidget.value"></a> +<h4>EricZoomWidget.value</h4> +<b>value</b>(<i></i>) + +<p> + Public method to get the current value. +</p> +<dl> +<dt>Return:</dt> +<dd> +current zoom value (integer) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file