diff -r f99d60d6b59b -r 2602857055c5 eric6/Documentation/Source/eric6.Snapshot.SnapshotWaylandGrabber.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/eric6/Documentation/Source/eric6.Snapshot.SnapshotWaylandGrabber.html Sun Apr 14 15:09:21 2019 +0200
@@ -0,0 +1,217 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.Snapshot.SnapshotWaylandGrabber</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>eric6.Snapshot.SnapshotWaylandGrabber</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="#SnapshotWaylandGrabber">SnapshotWaylandGrabber</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="SnapshotWaylandGrabber" ID="SnapshotWaylandGrabber"></a>
+<h2>SnapshotWaylandGrabber</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="#SnapshotWaylandGrabber.__init__">SnapshotWaylandGrabber</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__checkReply">__checkReply</a></td>
+<td>Private method to check, if a reply is valid.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__grabFullscreen">__grabFullscreen</a></td>
+<td>Private method to grab the complete desktop.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__grabRectangle">__grabRectangle</a></td>
+<td>Private method to grab a rectangular desktop area.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__grabSelectedScreen">__grabSelectedScreen</a></td>
+<td>Private method to grab a selected screen.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__grabSelectedWindow">__grabSelectedWindow</a></td>
+<td>Private method to grab a selected window.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__performGrab">__performGrab</a></td>
+<td>Private method to perform the grab operations.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.__temporaryFilename">__temporaryFilename</a></td>
+<td>Private method to generate a temporary filename.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.grab">grab</a></td>
+<td>Public method to perform a grab operation potentially after a delay.</td>
+</tr><tr>
+<td><a href="#SnapshotWaylandGrabber.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="SnapshotWaylandGrabber.__init__" ID="SnapshotWaylandGrabber.__init__"></a>
+<h4>SnapshotWaylandGrabber (Constructor)</h4>
+<b>SnapshotWaylandGrabber</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="SnapshotWaylandGrabber.__checkReply" ID="SnapshotWaylandGrabber.__checkReply"></a>
+<h4>SnapshotWaylandGrabber.__checkReply</h4>
+<b>__checkReply</b>(<i>reply, argumentsCount</i>)
+<p>
+ Private method to check, if a reply is valid.
+</p><dl>
+<dt><i>reply</i> (QDBusMessage)</dt>
+<dd>
+reference to the reply message
+</dd><dt><i>argumentsCount</i> (int)</dt>
+<dd>
+number of expected arguments
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating validity
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl><a NAME="SnapshotWaylandGrabber.__grabFullscreen" ID="SnapshotWaylandGrabber.__grabFullscreen"></a>
+<h4>SnapshotWaylandGrabber.__grabFullscreen</h4>
+<b>__grabFullscreen</b>(<i></i>)
+<p>
+ Private method to grab the complete desktop.
+</p><a NAME="SnapshotWaylandGrabber.__grabRectangle" ID="SnapshotWaylandGrabber.__grabRectangle"></a>
+<h4>SnapshotWaylandGrabber.__grabRectangle</h4>
+<b>__grabRectangle</b>(<i></i>)
+<p>
+ Private method to grab a rectangular desktop area.
+</p><a NAME="SnapshotWaylandGrabber.__grabSelectedScreen" ID="SnapshotWaylandGrabber.__grabSelectedScreen"></a>
+<h4>SnapshotWaylandGrabber.__grabSelectedScreen</h4>
+<b>__grabSelectedScreen</b>(<i></i>)
+<p>
+ Private method to grab a selected screen.
+</p><a NAME="SnapshotWaylandGrabber.__grabSelectedWindow" ID="SnapshotWaylandGrabber.__grabSelectedWindow"></a>
+<h4>SnapshotWaylandGrabber.__grabSelectedWindow</h4>
+<b>__grabSelectedWindow</b>(<i></i>)
+<p>
+ Private method to grab a selected window.
+</p><a NAME="SnapshotWaylandGrabber.__performGrab" ID="SnapshotWaylandGrabber.__performGrab"></a>
+<h4>SnapshotWaylandGrabber.__performGrab</h4>
+<b>__performGrab</b>(<i></i>)
+<p>
+ Private method to perform the grab operations.
+</p><dl>
+<dt>Raises <b>RuntimeError</b>:</dt>
+<dd>
+raised to indicate an unsupported grab mode
+</dd>
+</dl><a NAME="SnapshotWaylandGrabber.__temporaryFilename" ID="SnapshotWaylandGrabber.__temporaryFilename"></a>
+<h4>SnapshotWaylandGrabber.__temporaryFilename</h4>
+<b>__temporaryFilename</b>(<i></i>)
+<p>
+ Private method to generate a temporary filename.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+path name for a unique, temporary file
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl><a NAME="SnapshotWaylandGrabber.grab" ID="SnapshotWaylandGrabber.grab"></a>
+<h4>SnapshotWaylandGrabber.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
+</dd><dt><i>captureDecorations</i> (bool)</dt>
+<dd>
+flag indicating to include the window
+ decorations (only used for mode SnapshotModes.SelectedWindow)
+</dd>
+</dl><a NAME="SnapshotWaylandGrabber.supportedModes" ID="SnapshotWaylandGrabber.supportedModes"></a>
+<h4>SnapshotWaylandGrabber.supportedModes</h4>
+<b>supportedModes</b>(<i></i>)
+<p>
+ Public method to get the supported screenshot modes.
+</p><dl>
+<dt>Returns:</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
