Documentation/Source/eric5.E5Gui.E5MapWidget.html

changeset 3339
d0a603f1bfcd
parent 3329
1ee38e29ed4f
child 3591
2f2a4a76dd22
equal deleted inserted replaced
3337:49faa820151a 3339:d0a603f1bfcd
61 <td>Constructor</td> 61 <td>Constructor</td>
62 </tr><tr> 62 </tr><tr>
63 <td><a href="#E5MapWidget.__generateSliderRange">__generateSliderRange</a></td> 63 <td><a href="#E5MapWidget.__generateSliderRange">__generateSliderRange</a></td>
64 <td>Private method to generate the slider rectangle.</td> 64 <td>Private method to generate the slider rectangle.</td>
65 </tr><tr> 65 </tr><tr>
66 <td><a href="#E5MapWidget.__setSliderColor">__setSliderColor</a></td>
67 <td>Set the slider color depending upon the background color.</td>
68 </tr><tr>
66 <td><a href="#E5MapWidget.__updateMasterViewportWidth">__updateMasterViewportWidth</a></td> 69 <td><a href="#E5MapWidget.__updateMasterViewportWidth">__updateMasterViewportWidth</a></td>
67 <td>Private method to update the master's viewport width.</td> 70 <td>Private method to update the master's viewport width.</td>
68 </tr><tr> 71 </tr><tr>
69 <td><a href="#E5MapWidget._paintIt">_paintIt</a></td> 72 <td><a href="#E5MapWidget._paintIt">_paintIt</a></td>
70 <td>Protected method for painting the widget's indicators.</td> 73 <td>Protected method for painting the widget's indicators.</td>
82 <td>Public method to check the enabled state.</td> 85 <td>Public method to check the enabled state.</td>
83 </tr><tr> 86 </tr><tr>
84 <td><a href="#E5MapWidget.lineDimensions">lineDimensions</a></td> 87 <td><a href="#E5MapWidget.lineDimensions">lineDimensions</a></td>
85 <td>Public method to get the line (indicator) dimensions.</td> 88 <td>Public method to get the line (indicator) dimensions.</td>
86 </tr><tr> 89 </tr><tr>
87 <td><a href="#E5MapWidget.mouseReleaseEvent">mouseReleaseEvent</a></td> 90 <td><a href="#E5MapWidget.mouseMoveEvent">mouseMoveEvent</a></td>
88 <td>Protected method to handle a mouse button release.</td> 91 <td>Protected method to handle a mouse moves.</td>
92 </tr><tr>
93 <td><a href="#E5MapWidget.mousePressEvent">mousePressEvent</a></td>
94 <td>Protected method to handle a mouse button press.</td>
89 </tr><tr> 95 </tr><tr>
90 <td><a href="#E5MapWidget.paintEvent">paintEvent</a></td> 96 <td><a href="#E5MapWidget.paintEvent">paintEvent</a></td>
91 <td>Protected method to handle a paint event.</td> 97 <td>Protected method to handle a paint event.</td>
92 </tr><tr> 98 </tr><tr>
93 <td><a href="#E5MapWidget.position2Value">position2Value</a></td> 99 <td><a href="#E5MapWidget.position2Value">position2Value</a></td>
106 <td>Public method to set the line (indicator) dimensions.</td> 112 <td>Public method to set the line (indicator) dimensions.</td>
107 </tr><tr> 113 </tr><tr>
108 <td><a href="#E5MapWidget.setMaster">setMaster</a></td> 114 <td><a href="#E5MapWidget.setMaster">setMaster</a></td>
109 <td>Public method to set the map master widget.</td> 115 <td>Public method to set the map master widget.</td>
110 </tr><tr> 116 </tr><tr>
111 <td><a href="#E5MapWidget.setSliderColors">setSliderColors</a></td>
112 <td>Public method to set the slider colors.</td>
113 </tr><tr>
114 <td><a href="#E5MapWidget.setWidth">setWidth</a></td> 117 <td><a href="#E5MapWidget.setWidth">setWidth</a></td>
115 <td>Public method to set the widget width.</td> 118 <td>Public method to set the widget width.</td>
116 </tr><tr> 119 </tr><tr>
117 <td><a href="#E5MapWidget.sizeHint">sizeHint</a></td> 120 <td><a href="#E5MapWidget.sizeHint">sizeHint</a></td>
118 <td>Public method to give an indication about the preferred size.</td> 121 <td>Public method to give an indication about the preferred size.</td>
119 </tr><tr> 122 </tr><tr>
120 <td><a href="#E5MapWidget.sliderColors">sliderColors</a></td>
121 <td>Public method to get the slider colors.</td>
122 </tr><tr>
123 <td><a href="#E5MapWidget.value2Position">value2Position</a></td> 123 <td><a href="#E5MapWidget.value2Position">value2Position</a></td>
124 <td>Public method to convert a scrollbar value into a position.</td> 124 <td>Public method to convert a scrollbar value into a position.</td>
125 </tr><tr>
126 <td><a href="#E5MapWidget.wheelEvent">wheelEvent</a></td>
127 <td>Protected slot handling mouse wheel events.</td>
125 </tr><tr> 128 </tr><tr>
126 <td><a href="#E5MapWidget.width">width</a></td> 129 <td><a href="#E5MapWidget.width">width</a></td>
127 <td>Public method to get the widget's width.</td> 130 <td>Public method to get the widget's width.</td>
128 </tr> 131 </tr>
129 </table> 132 </table>
154 </dl><dl> 157 </dl><dl>
155 <dt>Returns:</dt> 158 <dt>Returns:</dt>
156 <dd> 159 <dd>
157 slider rectangle (QRect) 160 slider rectangle (QRect)
158 </dd> 161 </dd>
159 </dl><a NAME="E5MapWidget.__updateMasterViewportWidth" ID="E5MapWidget.__updateMasterViewportWidth"></a> 162 </dl><a NAME="E5MapWidget.__setSliderColor" ID="E5MapWidget.__setSliderColor"></a>
163 <h4>E5MapWidget.__setSliderColor</h4>
164 <b>__setSliderColor</b>(<i></i>)
165 <p>
166 Set the slider color depending upon the background color.
167 </p><a NAME="E5MapWidget.__updateMasterViewportWidth" ID="E5MapWidget.__updateMasterViewportWidth"></a>
160 <h4>E5MapWidget.__updateMasterViewportWidth</h4> 168 <h4>E5MapWidget.__updateMasterViewportWidth</h4>
161 <b>__updateMasterViewportWidth</b>(<i></i>) 169 <b>__updateMasterViewportWidth</b>(<i></i>)
162 <p> 170 <p>
163 Private method to update the master's viewport width. 171 Private method to update the master's viewport width.
164 </p><a NAME="E5MapWidget._paintIt" ID="E5MapWidget._paintIt"></a> 172 </p><a NAME="E5MapWidget._paintIt" ID="E5MapWidget._paintIt"></a>
221 </p><dl> 229 </p><dl>
222 <dt>Returns:</dt> 230 <dt>Returns:</dt>
223 <dd> 231 <dd>
224 tuple with border width (integer) and line height (integer) 232 tuple with border width (integer) and line height (integer)
225 </dd> 233 </dd>
226 </dl><a NAME="E5MapWidget.mouseReleaseEvent" ID="E5MapWidget.mouseReleaseEvent"></a> 234 </dl><a NAME="E5MapWidget.mouseMoveEvent" ID="E5MapWidget.mouseMoveEvent"></a>
227 <h4>E5MapWidget.mouseReleaseEvent</h4> 235 <h4>E5MapWidget.mouseMoveEvent</h4>
228 <b>mouseReleaseEvent</b>(<i>event</i>) 236 <b>mouseMoveEvent</b>(<i>event</i>)
229 <p> 237 <p>
230 Protected method to handle a mouse button release. 238 Protected method to handle a mouse moves.
231 </p><dl> 239 </p><dl>
232 <dt><i>event</i></dt> 240 <dt><i>event</i></dt>
233 <dd> 241 <dd>
234 mouse event (QMouseEvent) 242 reference to the mouse event (QMouseEvent)
243 </dd>
244 </dl><a NAME="E5MapWidget.mousePressEvent" ID="E5MapWidget.mousePressEvent"></a>
245 <h4>E5MapWidget.mousePressEvent</h4>
246 <b>mousePressEvent</b>(<i>event</i>)
247 <p>
248 Protected method to handle a mouse button press.
249 </p><dl>
250 <dt><i>event</i></dt>
251 <dd>
252 reference to the mouse event (QMouseEvent)
235 </dd> 253 </dd>
236 </dl><a NAME="E5MapWidget.paintEvent" ID="E5MapWidget.paintEvent"></a> 254 </dl><a NAME="E5MapWidget.paintEvent" ID="E5MapWidget.paintEvent"></a>
237 <h4>E5MapWidget.paintEvent</h4> 255 <h4>E5MapWidget.paintEvent</h4>
238 <b>paintEvent</b>(<i>event</i>) 256 <b>paintEvent</b>(<i>event</i>)
239 <p> 257 <p>
319 </p><dl> 337 </p><dl>
320 <dt><i>master</i></dt> 338 <dt><i>master</i></dt>
321 <dd> 339 <dd>
322 map master widget (QAbstractScrollArea) 340 map master widget (QAbstractScrollArea)
323 </dd> 341 </dd>
324 </dl><a NAME="E5MapWidget.setSliderColors" ID="E5MapWidget.setSliderColors"></a>
325 <h4>E5MapWidget.setSliderColors</h4>
326 <b>setSliderColors</b>(<i>border, background</i>)
327 <p>
328 Public method to set the slider colors.
329 </p><dl>
330 <dt><i>border</i></dt>
331 <dd>
332 border color (QColor)
333 </dd><dt><i>background</i></dt>
334 <dd>
335 background color (QColor)
336 </dd>
337 </dl><a NAME="E5MapWidget.setWidth" ID="E5MapWidget.setWidth"></a> 342 </dl><a NAME="E5MapWidget.setWidth" ID="E5MapWidget.setWidth"></a>
338 <h4>E5MapWidget.setWidth</h4> 343 <h4>E5MapWidget.setWidth</h4>
339 <b>setWidth</b>(<i>width</i>) 344 <b>setWidth</b>(<i>width</i>)
340 <p> 345 <p>
341 Public method to set the widget width. 346 Public method to set the widget width.
352 </p><dl> 357 </p><dl>
353 <dt>Returns:</dt> 358 <dt>Returns:</dt>
354 <dd> 359 <dd>
355 preferred size (QSize) 360 preferred size (QSize)
356 </dd> 361 </dd>
357 </dl><a NAME="E5MapWidget.sliderColors" ID="E5MapWidget.sliderColors"></a>
358 <h4>E5MapWidget.sliderColors</h4>
359 <b>sliderColors</b>(<i></i>)
360 <p>
361 Public method to get the slider colors.
362 </p><dl>
363 <dt>Returns:</dt>
364 <dd>
365 tuple with the slider's border color (QColor) and
366 background color (QColor)
367 </dd>
368 </dl><a NAME="E5MapWidget.value2Position" ID="E5MapWidget.value2Position"></a> 362 </dl><a NAME="E5MapWidget.value2Position" ID="E5MapWidget.value2Position"></a>
369 <h4>E5MapWidget.value2Position</h4> 363 <h4>E5MapWidget.value2Position</h4>
370 <b>value2Position</b>(<i>value, slider=False</i>) 364 <b>value2Position</b>(<i>value, slider=False</i>)
371 <p> 365 <p>
372 Public method to convert a scrollbar value into a position. 366 Public method to convert a scrollbar value into a position.
381 </dd> 375 </dd>
382 </dl><dl> 376 </dl><dl>
383 <dt>Returns:</dt> 377 <dt>Returns:</dt>
384 <dd> 378 <dd>
385 position (integer) 379 position (integer)
380 </dd>
381 </dl><a NAME="E5MapWidget.wheelEvent" ID="E5MapWidget.wheelEvent"></a>
382 <h4>E5MapWidget.wheelEvent</h4>
383 <b>wheelEvent</b>(<i>event</i>)
384 <p>
385 Protected slot handling mouse wheel events.
386 </p><dl>
387 <dt><i>event</i></dt>
388 <dd>
389 reference to the wheel event (QWheelEvent)
386 </dd> 390 </dd>
387 </dl><a NAME="E5MapWidget.width" ID="E5MapWidget.width"></a> 391 </dl><a NAME="E5MapWidget.width" ID="E5MapWidget.width"></a>
388 <h4>E5MapWidget.width</h4> 392 <h4>E5MapWidget.width</h4>
389 <b>width</b>(<i></i>) 393 <b>width</b>(<i></i>)
390 <p> 394 <p>

eric ide

mercurial