Fri, 27 Oct 2023 14:09:40 +0200
Regenerated the source documentation with the corrected module parser.
<!DOCTYPE html> <html><head> <title>eric7.Snapshot.SnapshotFreehandGrabber</title> <meta charset="UTF-8"> <link rel="stylesheet" href="styles.css"> </head> <body> <a NAME="top" ID="top"></a> <h1>eric7.Snapshot.SnapshotFreehandGrabber</h1> <p> Module implementing a grabber widget for a freehand snapshot region. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#SnapshotFreehandGrabber">SnapshotFreehandGrabber</a></td> <td>Class implementing a grabber widget for a freehand snapshot region.</td> </tr> </table> <h3>Functions</h3> <table> <tr> <td><a href="#drawPolygon">drawPolygon</a></td> <td>Module function to draw a polygon with the given parameters.</td> </tr> </table> <hr /> <hr /> <a NAME="SnapshotFreehandGrabber" ID="SnapshotFreehandGrabber"></a> <h2>SnapshotFreehandGrabber</h2> <p> Class implementing a grabber widget for a freehand snapshot region. </p> <h3>Signals</h3> <dl> <dt>grabbed(QPixmap)</dt> <dd> emitted after the region was grabbed </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="#SnapshotFreehandGrabber.__init__">SnapshotFreehandGrabber</a></td> <td>Constructor</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.__grabRegion">__grabRegion</a></td> <td>Private method to grab the selected region (i.e.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.__initialize">__initialize</a></td> <td>Private slot to initialize the rest of the widget.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.keyPressEvent">keyPressEvent</a></td> <td>Protected method to handle key presses.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td> <td>Protected method to handle mouse double clicks.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.mouseMoveEvent">mouseMoveEvent</a></td> <td>Protected method to handle mouse movements.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.mousePressEvent">mousePressEvent</a></td> <td>Protected method to handle mouse button presses.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.mouseReleaseEvent">mouseReleaseEvent</a></td> <td>Protected method to handle mouse button releases.</td> </tr> <tr> <td><a href="#SnapshotFreehandGrabber.paintEvent">paintEvent</a></td> <td>Protected method handling paint events.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> <a NAME="SnapshotFreehandGrabber.__init__" ID="SnapshotFreehandGrabber.__init__"></a> <h4>SnapshotFreehandGrabber (Constructor)</h4> <b>SnapshotFreehandGrabber</b>(<i></i>) <p> Constructor </p> <a NAME="SnapshotFreehandGrabber.__grabRegion" ID="SnapshotFreehandGrabber.__grabRegion"></a> <h4>SnapshotFreehandGrabber.__grabRegion</h4> <b>__grabRegion</b>(<i></i>) <p> Private method to grab the selected region (i.e. do the snapshot). </p> <a NAME="SnapshotFreehandGrabber.__initialize" ID="SnapshotFreehandGrabber.__initialize"></a> <h4>SnapshotFreehandGrabber.__initialize</h4> <b>__initialize</b>(<i></i>) <p> Private slot to initialize the rest of the widget. </p> <a NAME="SnapshotFreehandGrabber.keyPressEvent" ID="SnapshotFreehandGrabber.keyPressEvent"></a> <h4>SnapshotFreehandGrabber.keyPressEvent</h4> <b>keyPressEvent</b>(<i>evt</i>) <p> Protected method to handle key presses. </p> <dl> <dt><i>evt</i></dt> <dd> key press event (QKeyEvent) </dd> </dl> <a NAME="SnapshotFreehandGrabber.mouseDoubleClickEvent" ID="SnapshotFreehandGrabber.mouseDoubleClickEvent"></a> <h4>SnapshotFreehandGrabber.mouseDoubleClickEvent</h4> <b>mouseDoubleClickEvent</b>(<i>evt</i>) <p> Protected method to handle mouse double clicks. </p> <dl> <dt><i>evt</i></dt> <dd> mouse double click event (QMouseEvent) </dd> </dl> <a NAME="SnapshotFreehandGrabber.mouseMoveEvent" ID="SnapshotFreehandGrabber.mouseMoveEvent"></a> <h4>SnapshotFreehandGrabber.mouseMoveEvent</h4> <b>mouseMoveEvent</b>(<i>evt</i>) <p> Protected method to handle mouse movements. </p> <dl> <dt><i>evt</i></dt> <dd> mouse move event (QMouseEvent) </dd> </dl> <a NAME="SnapshotFreehandGrabber.mousePressEvent" ID="SnapshotFreehandGrabber.mousePressEvent"></a> <h4>SnapshotFreehandGrabber.mousePressEvent</h4> <b>mousePressEvent</b>(<i>evt</i>) <p> Protected method to handle mouse button presses. </p> <dl> <dt><i>evt</i></dt> <dd> mouse press event (QMouseEvent) </dd> </dl> <a NAME="SnapshotFreehandGrabber.mouseReleaseEvent" ID="SnapshotFreehandGrabber.mouseReleaseEvent"></a> <h4>SnapshotFreehandGrabber.mouseReleaseEvent</h4> <b>mouseReleaseEvent</b>(<i>evt</i>) <p> Protected method to handle mouse button releases. </p> <dl> <dt><i>evt</i></dt> <dd> mouse release event (QMouseEvent) </dd> </dl> <a NAME="SnapshotFreehandGrabber.paintEvent" ID="SnapshotFreehandGrabber.paintEvent"></a> <h4>SnapshotFreehandGrabber.paintEvent</h4> <b>paintEvent</b>(<i>evt</i>) <p> Protected method handling paint events. </p> <dl> <dt><i>evt</i></dt> <dd> paint event (QPaintEvent) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="drawPolygon" ID="drawPolygon"></a> <h2>drawPolygon</h2> <b>drawPolygon</b>(<i>painter, polygon, outline, fill=None</i>) <p> Module function to draw a polygon with the given parameters. </p> <dl> <dt><i>painter</i></dt> <dd> reference to the painter to be used (QPainter) </dd> <dt><i>polygon</i></dt> <dd> polygon to be drawn (QPolygon) </dd> <dt><i>outline</i></dt> <dd> color of the outline (QColor) </dd> <dt><i>fill</i></dt> <dd> fill color (QColor) </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>