Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Snapshot.SnapshotRegionGrabber.html

Documentation/Source/eric5.Snapshot.SnapshotRegionGrabber.html

changeset 1770
c17e67e69ef5
child 1772
f325dfdc8f6b
equal deleted inserted replaced
1768:8a04ce23e083 1770:c17e67e69ef5
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric5.Snapshot.SnapshotRegionGrabber</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Snapshot.SnapshotRegionGrabber</h1>
24 <p>
25 Module implementing the snapshot region grabber widget.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#SnapshotRegionGrabber">SnapshotRegionGrabber</a></td>
35 <td>Class implementing the snapshot region grabber widget.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr>
41 <td><a href="#drawRect">drawRect</a></td>
42 <td>Module function to draw a rectangle with the given parameters.</td>
43 </tr>
44 </table>
45 <hr /><hr />
46 <a NAME="SnapshotRegionGrabber" ID="SnapshotRegionGrabber"></a>
47 <h2>SnapshotRegionGrabber</h2>
48 <p>
49 Class implementing the snapshot region grabber widget.
50 </p><h3>Signals</h3>
51 <dl>
52 <dt>grabbed(QPixmap)</dt>
53 <dd>
54 emitted after the region was grabbed
55 </dd>
56 </dl>
57 <h3>Derived from</h3>
58 QWidget
59 <h3>Class Attributes</h3>
60 <table>
61 <tr><td>FillMask</td></tr><tr><td>ModeFullscreen</td></tr><tr><td>ModeRectangle</td></tr><tr><td>StrokeMask</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68 <table>
69 <tr>
70 <td><a href="#SnapshotRegionGrabber.__init__">SnapshotRegionGrabber</a></td>
71 <td>Constructor</td>
72 </tr><tr>
73 <td><a href="#SnapshotRegionGrabber.__grabRect">__grabRect</a></td>
74 <td>Private method to grab the selected rectangle (i.e.</td>
75 </tr><tr>
76 <td><a href="#SnapshotRegionGrabber.__handleMask">__handleMask</a></td>
77 <td>Private method to calculate the handle mask.</td>
78 </tr><tr>
79 <td><a href="#SnapshotRegionGrabber.__initialize">__initialize</a></td>
80 <td>Private slot to initialize the rest of the widget.</td>
81 </tr><tr>
82 <td><a href="#SnapshotRegionGrabber.__limitPointToRect">__limitPointToRect</a></td>
83 <td>Private method to limit the given point to the given rectangle.</td>
84 </tr><tr>
85 <td><a href="#SnapshotRegionGrabber.__normalizeSelection">__normalizeSelection</a></td>
86 <td>Private method to normalize the given selection.</td>
87 </tr><tr>
88 <td><a href="#SnapshotRegionGrabber.__updateHandles">__updateHandles</a></td>
89 <td>Private method to update the handles.</td>
90 </tr><tr>
91 <td><a href="#SnapshotRegionGrabber.keyPressEvent">keyPressEvent</a></td>
92 <td>Protected method to handle key presses.</td>
93 </tr><tr>
94 <td><a href="#SnapshotRegionGrabber.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
95 <td>Protected method to handle mouse double clicks.</td>
96 </tr><tr>
97 <td><a href="#SnapshotRegionGrabber.mouseMoveEvent">mouseMoveEvent</a></td>
98 <td>Protected method to handle mouse movements.</td>
99 </tr><tr>
100 <td><a href="#SnapshotRegionGrabber.mousePressEvent">mousePressEvent</a></td>
101 <td>Protected method to handle mouse button presses.</td>
102 </tr><tr>
103 <td><a href="#SnapshotRegionGrabber.mouseReleaseEvent">mouseReleaseEvent</a></td>
104 <td>Protected method to handle mouse button releases.</td>
105 </tr><tr>
106 <td><a href="#SnapshotRegionGrabber.paintEvent">paintEvent</a></td>
107 <td>Protected method handling paint events.</td>
108 </tr><tr>
109 <td><a href="#SnapshotRegionGrabber.resizeEvent">resizeEvent</a></td>
110 <td>Protected method to handle resize events.</td>
111 </tr>
112 </table>
113 <h3>Static Methods</h3>
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117 <a NAME="SnapshotRegionGrabber.__init__" ID="SnapshotRegionGrabber.__init__"></a>
118 <h4>SnapshotRegionGrabber (Constructor)</h4>
119 <b>SnapshotRegionGrabber</b>(<i>mode, delay</i>)
120 <p>
121 Constructor
122 </p><dl>
123 <dt><i>mode</i></dt>
124 <dd>
125 snapshot mode (SnapshotRegionGrabber.ModeFullscreen,
126 SnapshotRegionGrabber.ModeRectangle)
127 </dd><dt><i>delay</i></dt>
128 <dd>
129 delay in seconds before taking the snapshot (int)
130 </dd>
131 </dl><a NAME="SnapshotRegionGrabber.__grabRect" ID="SnapshotRegionGrabber.__grabRect"></a>
132 <h4>SnapshotRegionGrabber.__grabRect</h4>
133 <b>__grabRect</b>(<i></i>)
134 <p>
135 Private method to grab the selected rectangle (i.e. do the snapshot).
136 </p><a NAME="SnapshotRegionGrabber.__handleMask" ID="SnapshotRegionGrabber.__handleMask"></a>
137 <h4>SnapshotRegionGrabber.__handleMask</h4>
138 <b>__handleMask</b>(<i>maskType</i>)
139 <p>
140 Private method to calculate the handle mask.
141 </p><dl>
142 <dt><i>maskType</i></dt>
143 <dd>
144 type of the mask to be used (SnapshotRegionGrabber.FillMask or
145 SnapshotRegionGrabber.StrokeMask)
146 </dd>
147 </dl><dl>
148 <dt>Returns:</dt>
149 <dd>
150 calculated mask (QRegion)
151 </dd>
152 </dl><a NAME="SnapshotRegionGrabber.__initialize" ID="SnapshotRegionGrabber.__initialize"></a>
153 <h4>SnapshotRegionGrabber.__initialize</h4>
154 <b>__initialize</b>(<i></i>)
155 <p>
156 Private slot to initialize the rest of the widget.
157 </p><a NAME="SnapshotRegionGrabber.__limitPointToRect" ID="SnapshotRegionGrabber.__limitPointToRect"></a>
158 <h4>SnapshotRegionGrabber.__limitPointToRect</h4>
159 <b>__limitPointToRect</b>(<i>point, rect</i>)
160 <p>
161 Private method to limit the given point to the given rectangle.
162 </p><dl>
163 <dt><i>point</i></dt>
164 <dd>
165 point to be limited (QPoint)
166 </dd><dt><i>rect</i></dt>
167 <dd>
168 rectangle the point shall be limited to (QRect)
169 </dd>
170 </dl><dl>
171 <dt>Returns:</dt>
172 <dd>
173 limited point (QPoint)
174 </dd>
175 </dl><a NAME="SnapshotRegionGrabber.__normalizeSelection" ID="SnapshotRegionGrabber.__normalizeSelection"></a>
176 <h4>SnapshotRegionGrabber.__normalizeSelection</h4>
177 <b>__normalizeSelection</b>(<i>sel</i>)
178 <p>
179 Private method to normalize the given selection.
180 </p><dl>
181 <dt><i>sel</i></dt>
182 <dd>
183 selection to be normalized (QRect)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 normalized selection (QRect)
189 </dd>
190 </dl><a NAME="SnapshotRegionGrabber.__updateHandles" ID="SnapshotRegionGrabber.__updateHandles"></a>
191 <h4>SnapshotRegionGrabber.__updateHandles</h4>
192 <b>__updateHandles</b>(<i></i>)
193 <p>
194 Private method to update the handles.
195 </p><a NAME="SnapshotRegionGrabber.keyPressEvent" ID="SnapshotRegionGrabber.keyPressEvent"></a>
196 <h4>SnapshotRegionGrabber.keyPressEvent</h4>
197 <b>keyPressEvent</b>(<i>evt</i>)
198 <p>
199 Protected method to handle key presses.
200 </p><dl>
201 <dt><i>evt</i></dt>
202 <dd>
203 key press event (QKeyEvent)
204 </dd>
205 </dl><a NAME="SnapshotRegionGrabber.mouseDoubleClickEvent" ID="SnapshotRegionGrabber.mouseDoubleClickEvent"></a>
206 <h4>SnapshotRegionGrabber.mouseDoubleClickEvent</h4>
207 <b>mouseDoubleClickEvent</b>(<i>evt</i>)
208 <p>
209 Protected method to handle mouse double clicks.
210 </p><dl>
211 <dt><i>evt</i></dt>
212 <dd>
213 mouse double click event (QMouseEvent)
214 </dd>
215 </dl><a NAME="SnapshotRegionGrabber.mouseMoveEvent" ID="SnapshotRegionGrabber.mouseMoveEvent"></a>
216 <h4>SnapshotRegionGrabber.mouseMoveEvent</h4>
217 <b>mouseMoveEvent</b>(<i>evt</i>)
218 <p>
219 Protected method to handle mouse movements.
220 </p><dl>
221 <dt><i>evt</i></dt>
222 <dd>
223 mouse move event (QMouseEvent)
224 </dd>
225 </dl><a NAME="SnapshotRegionGrabber.mousePressEvent" ID="SnapshotRegionGrabber.mousePressEvent"></a>
226 <h4>SnapshotRegionGrabber.mousePressEvent</h4>
227 <b>mousePressEvent</b>(<i>evt</i>)
228 <p>
229 Protected method to handle mouse button presses.
230 </p><dl>
231 <dt><i>evt</i></dt>
232 <dd>
233 mouse press event (QMouseEvent)
234 </dd>
235 </dl><a NAME="SnapshotRegionGrabber.mouseReleaseEvent" ID="SnapshotRegionGrabber.mouseReleaseEvent"></a>
236 <h4>SnapshotRegionGrabber.mouseReleaseEvent</h4>
237 <b>mouseReleaseEvent</b>(<i>evt</i>)
238 <p>
239 Protected method to handle mouse button releases.
240 </p><dl>
241 <dt><i>evt</i></dt>
242 <dd>
243 mouse release event (QMouseEvent)
244 </dd>
245 </dl><a NAME="SnapshotRegionGrabber.paintEvent" ID="SnapshotRegionGrabber.paintEvent"></a>
246 <h4>SnapshotRegionGrabber.paintEvent</h4>
247 <b>paintEvent</b>(<i>evt</i>)
248 <p>
249 Protected method handling paint events.
250 </p><dl>
251 <dt><i>evt</i></dt>
252 <dd>
253 paint event (QPaintEvent)
254 </dd>
255 </dl><a NAME="SnapshotRegionGrabber.resizeEvent" ID="SnapshotRegionGrabber.resizeEvent"></a>
256 <h4>SnapshotRegionGrabber.resizeEvent</h4>
257 <b>resizeEvent</b>(<i>evt</i>)
258 <p>
259 Protected method to handle resize events.
260 </p><dl>
261 <dt><i>evt</i></dt>
262 <dd>
263 resize event (QResizeEvent)
264 </dd>
265 </dl>
266 <div align="right"><a href="#top">Up</a></div>
267 <hr /><hr />
268 <a NAME="drawRect" ID="drawRect"></a>
269 <h2>drawRect</h2>
270 <b>drawRect</b>(<i>painter, rect, outline, fill=QColor()</i>)
271 <p>
272 Module function to draw a rectangle with the given parameters.
273 </p><dl>
274 <dt><i>painter</i></dt>
275 <dd>
276 reference to the painter to be used (QPainter)
277 </dd><dt><i>rect</i></dt>
278 <dd>
279 rectangle to be drawn (QRect)
280 </dd><dt><i>outline</i></dt>
281 <dd>
282 color of the outline (QColor)
283 </dd><dt><i>fill</i></dt>
284 <dd>
285 fill color (QColor)
286 </dd>
287 </dl>
288 <div align="right"><a href="#top">Up</a></div>
289 <hr />
290 </body></html>

Mercurial Repository: eric

eric ide

mercurial