--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Snapshot.SnapshotDefaultGrabber.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,280 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Snapshot.SnapshotDefaultGrabber</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Snapshot.SnapshotDefaultGrabber</h1> + +<p> +Module implementing a grabber object for non-Wayland desktops. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#SnapshotDefaultGrabber">SnapshotDefaultGrabber</a></td> +<td>Class implementing a grabber object for non-Wayland desktops.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="SnapshotDefaultGrabber" ID="SnapshotDefaultGrabber"></a> +<h2>SnapshotDefaultGrabber</h2> + +<p> + Class implementing a grabber object for non-Wayland desktops. +</p> +<h3>Signals</h3> +<dl> + +<dt>grabbed(QPixmap)</dt> +<dd> +emitted after the grab operation is finished +</dd> +</dl> +<h3>Derived from</h3> +QObject +<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="#SnapshotDefaultGrabber.__init__">SnapshotDefaultGrabber</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__captured">__captured</a></td> +<td>Private slot to show a preview of the snapshot.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__grabEllipse">__grabEllipse</a></td> +<td>Private method to grab an elliptical screen region.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__grabFreehand">__grabFreehand</a></td> +<td>Private method to grab a non-rectangular screen region.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__grabRectangle">__grabRectangle</a></td> +<td>Private method to grab a rectangular screen region.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__grabTimerTimeout">__grabTimerTimeout</a></td> +<td>Private slot to perform a delayed grab operation.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__performGrab">__performGrab</a></td> +<td>Private method to perform a screen grab other than a selected region.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.__startUndelayedGrab">__startUndelayedGrab</a></td> +<td>Private slot to perform an undelayed grab operation.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.eventFilter">eventFilter</a></td> +<td>Public method to handle event for other objects.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.grab">grab</a></td> +<td>Public method to perform a grab operation potentially after a delay.</td> +</tr> +<tr> +<td><a href="#SnapshotDefaultGrabber.supportedModes">supportedModes</a></td> +<td>Public method to get the supported screenshot modes.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="SnapshotDefaultGrabber.__init__" ID="SnapshotDefaultGrabber.__init__"></a> +<h4>SnapshotDefaultGrabber (Constructor)</h4> +<b>SnapshotDefaultGrabber</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QObject)</dt> +<dd> +reference to the parent object +</dd> +</dl> +<a NAME="SnapshotDefaultGrabber.__captured" ID="SnapshotDefaultGrabber.__captured"></a> +<h4>SnapshotDefaultGrabber.__captured</h4> +<b>__captured</b>(<i>pixmap</i>) + +<p> + Private slot to show a preview of the snapshot. +</p> +<dl> + +<dt><i>pixmap</i></dt> +<dd> +pixmap of the snapshot (QPixmap) +</dd> +</dl> +<a NAME="SnapshotDefaultGrabber.__grabEllipse" ID="SnapshotDefaultGrabber.__grabEllipse"></a> +<h4>SnapshotDefaultGrabber.__grabEllipse</h4> +<b>__grabEllipse</b>(<i></i>) + +<p> + Private method to grab an elliptical screen region. +</p> +<a NAME="SnapshotDefaultGrabber.__grabFreehand" ID="SnapshotDefaultGrabber.__grabFreehand"></a> +<h4>SnapshotDefaultGrabber.__grabFreehand</h4> +<b>__grabFreehand</b>(<i></i>) + +<p> + Private method to grab a non-rectangular screen region. +</p> +<a NAME="SnapshotDefaultGrabber.__grabRectangle" ID="SnapshotDefaultGrabber.__grabRectangle"></a> +<h4>SnapshotDefaultGrabber.__grabRectangle</h4> +<b>__grabRectangle</b>(<i></i>) + +<p> + Private method to grab a rectangular screen region. +</p> +<a NAME="SnapshotDefaultGrabber.__grabTimerTimeout" ID="SnapshotDefaultGrabber.__grabTimerTimeout"></a> +<h4>SnapshotDefaultGrabber.__grabTimerTimeout</h4> +<b>__grabTimerTimeout</b>(<i></i>) + +<p> + Private slot to perform a delayed grab operation. +</p> +<a NAME="SnapshotDefaultGrabber.__performGrab" ID="SnapshotDefaultGrabber.__performGrab"></a> +<h4>SnapshotDefaultGrabber.__performGrab</h4> +<b>__performGrab</b>(<i>mode</i>) + +<p> + Private method to perform a screen grab other than a selected region. +</p> +<dl> + +<dt><i>mode</i> (SnapshotModes)</dt> +<dd> +screenshot mode +</dd> +</dl> +<a NAME="SnapshotDefaultGrabber.__startUndelayedGrab" ID="SnapshotDefaultGrabber.__startUndelayedGrab"></a> +<h4>SnapshotDefaultGrabber.__startUndelayedGrab</h4> +<b>__startUndelayedGrab</b>(<i></i>) + +<p> + Private slot to perform an undelayed grab operation. +</p> +<a NAME="SnapshotDefaultGrabber.eventFilter" ID="SnapshotDefaultGrabber.eventFilter"></a> +<h4>SnapshotDefaultGrabber.eventFilter</h4> +<b>eventFilter</b>(<i>obj, evt</i>) + +<p> + Public method to handle event for other objects. +</p> +<dl> + +<dt><i>obj</i></dt> +<dd> +reference to the object (QObject) +</dd> +<dt><i>evt</i></dt> +<dd> +reference to the event (QEvent) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating that the event should be filtered out (boolean) +</dd> +</dl> +<a NAME="SnapshotDefaultGrabber.grab" ID="SnapshotDefaultGrabber.grab"></a> +<h4>SnapshotDefaultGrabber.grab</h4> +<b>grab</b>(<i>mode, delay=0, captureCursor=False, captureDecorations=False</i>) + +<p> + Public method to perform a grab operation potentially after a delay. +</p> +<dl> + +<dt><i>mode</i> (ScreenshotModes)</dt> +<dd> +screenshot mode +</dd> +<dt><i>delay</i> (int)</dt> +<dd> +delay in seconds +</dd> +<dt><i>captureCursor</i> (bool)</dt> +<dd> +flag indicating to include the mouse cursor + (not used) +</dd> +<dt><i>captureDecorations</i> (bool)</dt> +<dd> +flag indicating to include the window + decorations (not used) +</dd> +</dl> +<a NAME="SnapshotDefaultGrabber.supportedModes" ID="SnapshotDefaultGrabber.supportedModes"></a> +<h4>SnapshotDefaultGrabber.supportedModes</h4> +<b>supportedModes</b>(<i></i>) + +<p> + Public method to get the supported screenshot modes. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple of supported screenshot modes +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of SnapshotModes +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file