diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Snapshot.SnapshotDefaultGrabber.html
--- a/eric6/Documentation/Source/eric6.Snapshot.SnapshotDefaultGrabber.html Wed Sep 25 19:40:31 2019 +0200
+++ b/eric6/Documentation/Source/eric6.Snapshot.SnapshotDefaultGrabber.html Wed Sep 25 19:42:44 2019 +0200
@@ -18,33 +18,43 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>eric6.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 />
+<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>
+</p>
+<h3>Signals</h3>
<dl>
+
<dt>grabbed(QPixmap)</dt>
<dd>
emitted after the grab operation is finished
@@ -53,159 +63,213 @@
<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>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__captured">__captured</a></td>
<td>Private slot to show a preview of the snapshot.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__grabEllipse">__grabEllipse</a></td>
<td>Private method to grab an elliptical screen region.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__grabFreehand">__grabFreehand</a></td>
<td>Private method to grab a non-rectangular screen region.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__grabRectangle">__grabRectangle</a></td>
<td>Private method to grab a rectangular screen region.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__grabTimerTimeout">__grabTimerTimeout</a></td>
<td>Private slot to perform a delayed grab operation.</td>
-</tr><tr>
+</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>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.__startUndelayedGrab">__startUndelayedGrab</a></td>
<td>Private slot to perform an undelayed grab operation.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#SnapshotDefaultGrabber.eventFilter">eventFilter</a></td>
<td>Public method to handle event for other objects.</td>
-</tr><tr>
+</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>
+</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>
+</p>
+<dl>
+
<dt><i>parent</i> (QObject)</dt>
<dd>
reference to the parent object
</dd>
-</dl><a NAME="SnapshotDefaultGrabber.__captured" ID="SnapshotDefaultGrabber.__captured"></a>
+</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>
+</p>
+<dl>
+
<dt><i>pixmap</i></dt>
<dd>
pixmap of the snapshot (QPixmap)
</dd>
-</dl><a NAME="SnapshotDefaultGrabber.__grabEllipse" ID="SnapshotDefaultGrabber.__grabEllipse"></a>
+</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>
+</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>
+</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>
+</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>
+</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>
+</p>
+<dl>
+
<dt><i>mode</i> (SnapshotModes)</dt>
<dd>
screenshot mode
</dd>
-</dl><a NAME="SnapshotDefaultGrabber.__startUndelayedGrab" ID="SnapshotDefaultGrabber.__startUndelayedGrab"></a>
+</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>
+</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>
+</p>
+<dl>
+
<dt><i>obj</i></dt>
<dd>
reference to the object (QObject)
-</dd><dt><i>evt</i></dt>
+</dd>
+<dt><i>evt</i></dt>
<dd>
reference to the event (QEvent)
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
flag indicating that the event should be filtered out (boolean)
</dd>
-</dl><a NAME="SnapshotDefaultGrabber.grab" ID="SnapshotDefaultGrabber.grab"></a>
+</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>
+</p>
+<dl>
+
<dt><i>mode</i> (ScreenshotModes)</dt>
<dd>
screenshot mode
-</dd><dt><i>delay</i> (int)</dt>
+</dd>
+<dt><i>delay</i> (int)</dt>
<dd>
delay in seconds
-</dd><dt><i>captureCursor</i> (bool)</dt>
+</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>
+<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>
+</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>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
tuple of supported screenshot modes
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Return Type:</dt>
<dd>
tuple of SnapshotModes
