--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricMapWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricMapWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricMapWidget</h1>
-
<p>
Module implementing a base class for showing a document map.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricMapWidget">EricMapWidget</a></td>
<td>Class implementing a base class for showing a document map.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricMapWidget" ID="EricMapWidget"></a>
<h2>EricMapWidget</h2>
-
<p>
Class implementing a base class for showing a document map.
</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="#EricMapWidget.__init__">EricMapWidget</a></td>
<td>Constructor</td>
@@ -159,19 +156,20 @@
<td>Public method to get the widget's width.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricMapWidget.__init__" ID="EricMapWidget.__init__"></a>
<h4>EricMapWidget (Constructor)</h4>
<b>EricMapWidget</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -182,10 +180,10 @@
<a NAME="EricMapWidget.__generateSliderRange" ID="EricMapWidget.__generateSliderRange"></a>
<h4>EricMapWidget.__generateSliderRange</h4>
<b>__generateSliderRange</b>(<i>scrollbar</i>)
-
<p>
Private method to generate the slider rectangle.
</p>
+
<dl>
<dt><i>scrollbar</i> (QScrollBar)</dt>
@@ -208,28 +206,28 @@
<a NAME="EricMapWidget.__setSliderColor" ID="EricMapWidget.__setSliderColor"></a>
<h4>EricMapWidget.__setSliderColor</h4>
<b>__setSliderColor</b>(<i></i>)
-
<p>
Private method to set the slider color depending upon the background
color.
</p>
+
<a NAME="EricMapWidget.__updateControllerViewportWidth" ID="EricMapWidget.__updateControllerViewportWidth"></a>
<h4>EricMapWidget.__updateControllerViewportWidth</h4>
<b>__updateControllerViewportWidth</b>(<i></i>)
-
<p>
Private method to update the controller's viewport width.
</p>
+
<a NAME="EricMapWidget._paintIt" ID="EricMapWidget._paintIt"></a>
<h4>EricMapWidget._paintIt</h4>
<b>_paintIt</b>(<i>painter</i>)
-
<p>
Protected method for painting the widget's indicators.
</p>
<p>
Note: This method should be implemented by subclasses.
</p>
+
<dl>
<dt><i>painter</i> (QPainter)</dt>
@@ -240,10 +238,10 @@
<a NAME="EricMapWidget.backgroundColor" ID="EricMapWidget.backgroundColor"></a>
<h4>EricMapWidget.backgroundColor</h4>
<b>backgroundColor</b>(<i></i>)
-
<p>
Public method to get the background color.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -259,17 +257,17 @@
<a NAME="EricMapWidget.calculateGeometry" ID="EricMapWidget.calculateGeometry"></a>
<h4>EricMapWidget.calculateGeometry</h4>
<b>calculateGeometry</b>(<i></i>)
-
<p>
Public method to recalculate the map widget's geometry.
</p>
+
<a NAME="EricMapWidget.generateIndicatorRect" ID="EricMapWidget.generateIndicatorRect"></a>
<h4>EricMapWidget.generateIndicatorRect</h4>
<b>generateIndicatorRect</b>(<i>position</i>)
-
<p>
Public method to generate an indicator rectangle.
</p>
+
<dl>
<dt><i>position</i> (int)</dt>
@@ -292,10 +290,10 @@
<a NAME="EricMapWidget.isEnabled" ID="EricMapWidget.isEnabled"></a>
<h4>EricMapWidget.isEnabled</h4>
<b>isEnabled</b>(<i></i>)
-
<p>
Public method to check the enabled state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -311,11 +309,11 @@
<a NAME="EricMapWidget.isOnRightSide" ID="EricMapWidget.isOnRightSide"></a>
<h4>EricMapWidget.isOnRightSide</h4>
<b>isOnRightSide</b>(<i></i>)
-
<p>
Public method to test, if the map is shown on the right side of the
controller widget.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -332,10 +330,10 @@
<a NAME="EricMapWidget.lineDimensions" ID="EricMapWidget.lineDimensions"></a>
<h4>EricMapWidget.lineDimensions</h4>
<b>lineDimensions</b>(<i></i>)
-
<p>
Public method to get the line (indicator) dimensions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -351,10 +349,10 @@
<a NAME="EricMapWidget.mouseMoveEvent" ID="EricMapWidget.mouseMoveEvent"></a>
<h4>EricMapWidget.mouseMoveEvent</h4>
<b>mouseMoveEvent</b>(<i>event</i>)
-
<p>
Protected method to handle a mouse moves.
</p>
+
<dl>
<dt><i>event</i> (QMouseEvent)</dt>
@@ -365,10 +363,10 @@
<a NAME="EricMapWidget.mousePressEvent" ID="EricMapWidget.mousePressEvent"></a>
<h4>EricMapWidget.mousePressEvent</h4>
<b>mousePressEvent</b>(<i>event</i>)
-
<p>
Protected method to handle a mouse button press.
</p>
+
<dl>
<dt><i>event</i> (QMouseEvent)</dt>
@@ -379,10 +377,10 @@
<a NAME="EricMapWidget.paintEvent" ID="EricMapWidget.paintEvent"></a>
<h4>EricMapWidget.paintEvent</h4>
<b>paintEvent</b>(<i>event</i>)
-
<p>
Protected method to handle a paint event.
</p>
+
<dl>
<dt><i>event</i> (QPaintEvent)</dt>
@@ -393,10 +391,10 @@
<a NAME="EricMapWidget.position2Value" ID="EricMapWidget.position2Value"></a>
<h4>EricMapWidget.position2Value</h4>
<b>position2Value</b>(<i>position, slider=False</i>)
-
<p>
Public method to convert a position into a scrollbar value.
</p>
+
<dl>
<dt><i>position</i> (int)</dt>
@@ -423,10 +421,10 @@
<a NAME="EricMapWidget.scaleFactor" ID="EricMapWidget.scaleFactor"></a>
<h4>EricMapWidget.scaleFactor</h4>
<b>scaleFactor</b>(<i>slider=False</i>)
-
<p>
Public method to determine the scrollbar's scale factor.
</p>
+
<dl>
<dt><i>slider</i> (bool)</dt>
@@ -449,10 +447,10 @@
<a NAME="EricMapWidget.setBackgroundColor" ID="EricMapWidget.setBackgroundColor"></a>
<h4>EricMapWidget.setBackgroundColor</h4>
<b>setBackgroundColor</b>(<i>color</i>)
-
<p>
Public method to set the widget background color.
</p>
+
<dl>
<dt><i>color</i> (QColor)</dt>
@@ -463,10 +461,10 @@
<a NAME="EricMapWidget.setController" ID="EricMapWidget.setController"></a>
<h4>EricMapWidget.setController</h4>
<b>setController</b>(<i>controller</i>)
-
<p>
Public method to set the map controller widget.
</p>
+
<dl>
<dt><i>controller</i> (QAbstractScrollArea)</dt>
@@ -477,10 +475,10 @@
<a NAME="EricMapWidget.setEnabled" ID="EricMapWidget.setEnabled"></a>
<h4>EricMapWidget.setEnabled</h4>
<b>setEnabled</b>(<i>enable</i>)
-
<p>
Public method to set the enabled state.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -491,10 +489,10 @@
<a NAME="EricMapWidget.setLineDimensions" ID="EricMapWidget.setLineDimensions"></a>
<h4>EricMapWidget.setLineDimensions</h4>
<b>setLineDimensions</b>(<i>border, height</i>)
-
<p>
Public method to set the line (indicator) dimensions.
</p>
+
<dl>
<dt><i>border</i> (int)</dt>
@@ -509,11 +507,11 @@
<a NAME="EricMapWidget.setMapPosition" ID="EricMapWidget.setMapPosition"></a>
<h4>EricMapWidget.setMapPosition</h4>
<b>setMapPosition</b>(<i>onRight</i>)
-
<p>
Public method to set, whether the map should be shown to the right or
left of the controller widget.
</p>
+
<dl>
<dt><i>onRight</i> (bool)</dt>
@@ -525,10 +523,10 @@
<a NAME="EricMapWidget.setWidth" ID="EricMapWidget.setWidth"></a>
<h4>EricMapWidget.setWidth</h4>
<b>setWidth</b>(<i>width</i>)
-
<p>
Public method to set the widget width.
</p>
+
<dl>
<dt><i>width</i> (int)</dt>
@@ -539,10 +537,10 @@
<a NAME="EricMapWidget.sizeHint" ID="EricMapWidget.sizeHint"></a>
<h4>EricMapWidget.sizeHint</h4>
<b>sizeHint</b>(<i></i>)
-
<p>
Public method to give an indication about the preferred size.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -558,10 +556,10 @@
<a NAME="EricMapWidget.value2Position" ID="EricMapWidget.value2Position"></a>
<h4>EricMapWidget.value2Position</h4>
<b>value2Position</b>(<i>value, slider=False</i>)
-
<p>
Public method to convert a scrollbar value into a position.
</p>
+
<dl>
<dt><i>value</i> (int)</dt>
@@ -588,10 +586,10 @@
<a NAME="EricMapWidget.wheelEvent" ID="EricMapWidget.wheelEvent"></a>
<h4>EricMapWidget.wheelEvent</h4>
<b>wheelEvent</b>(<i>event</i>)
-
<p>
Protected slot handling mouse wheel events.
</p>
+
<dl>
<dt><i>event</i> (QWheelEvent)</dt>
@@ -602,10 +600,10 @@
<a NAME="EricMapWidget.width" ID="EricMapWidget.width"></a>
<h4>EricMapWidget.width</h4>
<b>width</b>(<i></i>)
-
<p>
Public method to get the widget's width.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -620,4 +618,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
