Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Snapshot.SnapshotDefaultGrabber.html
src/eric7/Documentation/Source/eric7.Snapshot.SnapshotDefaultGrabber.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10431
- 64157aeb0312
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Snapshot.SnapshotDefaultGrabber</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Snapshot.SnapshotDefaultGrabber</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a grabber object for non-Wayland desktops. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#SnapshotDefaultGrabber">SnapshotDefaultGrabber</a></td> | |
| 25 <td>Class implementing a grabber object for non-Wayland desktops.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="SnapshotDefaultGrabber" ID="SnapshotDefaultGrabber"></a> | |
| 36 <h2>SnapshotDefaultGrabber</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a grabber object for non-Wayland desktops. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>grabbed(QPixmap)</dt> | |
| 45 <dd> | |
| 46 emitted after the grab operation is finished | |
| 47 </dd> | |
| 48 </dl> | |
| 49 <h3>Derived from</h3> | |
| 50 QObject | |
| 51 <h3>Class Attributes</h3> | |
| 52 | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 | |
| 65 <tr> | |
| 66 <td><a href="#SnapshotDefaultGrabber.__init__">SnapshotDefaultGrabber</a></td> | |
| 67 <td>Constructor</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#SnapshotDefaultGrabber.__captured">__captured</a></td> | |
| 71 <td>Private slot to show a preview of the snapshot.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#SnapshotDefaultGrabber.__grabEllipse">__grabEllipse</a></td> | |
| 75 <td>Private method to grab an elliptical screen region.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#SnapshotDefaultGrabber.__grabFreehand">__grabFreehand</a></td> | |
| 79 <td>Private method to grab a non-rectangular screen region.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#SnapshotDefaultGrabber.__grabRectangle">__grabRectangle</a></td> | |
| 83 <td>Private method to grab a rectangular screen region.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#SnapshotDefaultGrabber.__grabTimerTimeout">__grabTimerTimeout</a></td> | |
| 87 <td>Private slot to perform a delayed grab operation.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#SnapshotDefaultGrabber.__performGrab">__performGrab</a></td> | |
| 91 <td>Private method to perform a screen grab other than a selected region.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#SnapshotDefaultGrabber.__startUndelayedGrab">__startUndelayedGrab</a></td> | |
| 95 <td>Private slot to perform an undelayed grab operation.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#SnapshotDefaultGrabber.eventFilter">eventFilter</a></td> | |
| 99 <td>Public method to handle event for other objects.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#SnapshotDefaultGrabber.grab">grab</a></td> | |
| 103 <td>Public method to perform a grab operation potentially after a delay.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#SnapshotDefaultGrabber.supportedModes">supportedModes</a></td> | |
| 107 <td>Public method to get the supported screenshot modes.</td> | |
| 108 </tr> | |
| 109 </table> | |
| 110 <h3>Static Methods</h3> | |
| 111 | |
| 112 <table> | |
| 113 <tr><td>None</td></tr> | |
| 114 </table> | |
| 115 | |
| 116 <a NAME="SnapshotDefaultGrabber.__init__" ID="SnapshotDefaultGrabber.__init__"></a> | |
| 117 <h4>SnapshotDefaultGrabber (Constructor)</h4> | |
| 118 <b>SnapshotDefaultGrabber</b>(<i>parent=None</i>) | |
| 119 | |
| 120 <p> | |
| 121 Constructor | |
| 122 </p> | |
| 123 <dl> | |
| 124 | |
| 125 <dt><i>parent</i> (QObject)</dt> | |
| 126 <dd> | |
| 127 reference to the parent object | |
| 128 </dd> | |
| 129 </dl> | |
| 130 <a NAME="SnapshotDefaultGrabber.__captured" ID="SnapshotDefaultGrabber.__captured"></a> | |
| 131 <h4>SnapshotDefaultGrabber.__captured</h4> | |
| 132 <b>__captured</b>(<i>pixmap</i>) | |
| 133 | |
| 134 <p> | |
| 135 Private slot to show a preview of the snapshot. | |
| 136 </p> | |
| 137 <dl> | |
| 138 | |
| 139 <dt><i>pixmap</i></dt> | |
| 140 <dd> | |
| 141 pixmap of the snapshot (QPixmap) | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <a NAME="SnapshotDefaultGrabber.__grabEllipse" ID="SnapshotDefaultGrabber.__grabEllipse"></a> | |
| 145 <h4>SnapshotDefaultGrabber.__grabEllipse</h4> | |
| 146 <b>__grabEllipse</b>(<i></i>) | |
| 147 | |
| 148 <p> | |
| 149 Private method to grab an elliptical screen region. | |
| 150 </p> | |
| 151 <a NAME="SnapshotDefaultGrabber.__grabFreehand" ID="SnapshotDefaultGrabber.__grabFreehand"></a> | |
| 152 <h4>SnapshotDefaultGrabber.__grabFreehand</h4> | |
| 153 <b>__grabFreehand</b>(<i></i>) | |
| 154 | |
| 155 <p> | |
| 156 Private method to grab a non-rectangular screen region. | |
| 157 </p> | |
| 158 <a NAME="SnapshotDefaultGrabber.__grabRectangle" ID="SnapshotDefaultGrabber.__grabRectangle"></a> | |
| 159 <h4>SnapshotDefaultGrabber.__grabRectangle</h4> | |
| 160 <b>__grabRectangle</b>(<i></i>) | |
| 161 | |
| 162 <p> | |
| 163 Private method to grab a rectangular screen region. | |
| 164 </p> | |
| 165 <a NAME="SnapshotDefaultGrabber.__grabTimerTimeout" ID="SnapshotDefaultGrabber.__grabTimerTimeout"></a> | |
| 166 <h4>SnapshotDefaultGrabber.__grabTimerTimeout</h4> | |
| 167 <b>__grabTimerTimeout</b>(<i></i>) | |
| 168 | |
| 169 <p> | |
| 170 Private slot to perform a delayed grab operation. | |
| 171 </p> | |
| 172 <a NAME="SnapshotDefaultGrabber.__performGrab" ID="SnapshotDefaultGrabber.__performGrab"></a> | |
| 173 <h4>SnapshotDefaultGrabber.__performGrab</h4> | |
| 174 <b>__performGrab</b>(<i>mode</i>) | |
| 175 | |
| 176 <p> | |
| 177 Private method to perform a screen grab other than a selected region. | |
| 178 </p> | |
| 179 <dl> | |
| 180 | |
| 181 <dt><i>mode</i> (SnapshotModes)</dt> | |
| 182 <dd> | |
| 183 screenshot mode | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <a NAME="SnapshotDefaultGrabber.__startUndelayedGrab" ID="SnapshotDefaultGrabber.__startUndelayedGrab"></a> | |
| 187 <h4>SnapshotDefaultGrabber.__startUndelayedGrab</h4> | |
| 188 <b>__startUndelayedGrab</b>(<i></i>) | |
| 189 | |
| 190 <p> | |
| 191 Private slot to perform an undelayed grab operation. | |
| 192 </p> | |
| 193 <a NAME="SnapshotDefaultGrabber.eventFilter" ID="SnapshotDefaultGrabber.eventFilter"></a> | |
| 194 <h4>SnapshotDefaultGrabber.eventFilter</h4> | |
| 195 <b>eventFilter</b>(<i>obj, evt</i>) | |
| 196 | |
| 197 <p> | |
| 198 Public method to handle event for other objects. | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>obj</i></dt> | |
| 203 <dd> | |
| 204 reference to the object (QObject) | |
| 205 </dd> | |
| 206 <dt><i>evt</i></dt> | |
| 207 <dd> | |
| 208 reference to the event (QEvent) | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <dl> | |
| 212 <dt>Return:</dt> | |
| 213 <dd> | |
| 214 flag indicating that the event should be filtered out (boolean) | |
| 215 </dd> | |
| 216 </dl> | |
| 217 <a NAME="SnapshotDefaultGrabber.grab" ID="SnapshotDefaultGrabber.grab"></a> | |
| 218 <h4>SnapshotDefaultGrabber.grab</h4> | |
| 219 <b>grab</b>(<i>mode, delay=0, captureCursor=False, captureDecorations=False</i>) | |
| 220 | |
| 221 <p> | |
| 222 Public method to perform a grab operation potentially after a delay. | |
| 223 </p> | |
| 224 <dl> | |
| 225 | |
| 226 <dt><i>mode</i> (ScreenshotModes)</dt> | |
| 227 <dd> | |
| 228 screenshot mode | |
| 229 </dd> | |
| 230 <dt><i>delay</i> (int)</dt> | |
| 231 <dd> | |
| 232 delay in seconds | |
| 233 </dd> | |
| 234 <dt><i>captureCursor</i> (bool)</dt> | |
| 235 <dd> | |
| 236 flag indicating to include the mouse cursor | |
| 237 (not used) | |
| 238 </dd> | |
| 239 <dt><i>captureDecorations</i> (bool)</dt> | |
| 240 <dd> | |
| 241 flag indicating to include the window | |
| 242 decorations (not used) | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <a NAME="SnapshotDefaultGrabber.supportedModes" ID="SnapshotDefaultGrabber.supportedModes"></a> | |
| 246 <h4>SnapshotDefaultGrabber.supportedModes</h4> | |
| 247 <b>supportedModes</b>(<i></i>) | |
| 248 | |
| 249 <p> | |
| 250 Public method to get the supported screenshot modes. | |
| 251 </p> | |
| 252 <dl> | |
| 253 <dt>Return:</dt> | |
| 254 <dd> | |
| 255 tuple of supported screenshot modes | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <dl> | |
| 259 <dt>Return Type:</dt> | |
| 260 <dd> | |
| 261 tuple of SnapshotModes | |
| 262 </dd> | |
| 263 </dl> | |
| 264 <div align="right"><a href="#top">Up</a></div> | |
| 265 <hr /> | |
| 266 </body></html> |
