File: wx.lib.dragscroller.DragScroller.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (119 lines) | stat: -rw-r--r-- 3,969 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.dragscroller

.. highlight:: python



.. _wx.lib.dragscroller.DragScroller:

==========================================================================================================================================
|phoenix_title|  **wx.lib.dragscroller.DragScroller**
==========================================================================================================================================

Scrolls a wx.ScrollWindow in the direction and speed of a mouse drag.

Call Start with the position of the drag start.
Call Stop on the drag release. 



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>DragScroller</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.dragscroller.DragScroller_inheritance.png" alt="Inheritance diagram of DragScroller" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.dragscroller.DragScroller.html" title="wx.lib.dragscroller.DragScroller" alt="" coords="5,5,231,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.dragscroller.DragScroller.__init__`                               Initialize self.  See help(type(self)) for accurate signature.
:meth:`~wx.lib.dragscroller.DragScroller.GetScrollWindow`                        
:meth:`~wx.lib.dragscroller.DragScroller.GetSensitivity`                         
:meth:`~wx.lib.dragscroller.DragScroller.GetUpdateRate`                          
:meth:`~wx.lib.dragscroller.DragScroller.OnTimerDoScroll`                        
:meth:`~wx.lib.dragscroller.DragScroller.SetScrollWindow`                        
:meth:`~wx.lib.dragscroller.DragScroller.SetSensitivity`                         
:meth:`~wx.lib.dragscroller.DragScroller.SetUpdateRate`                          
:meth:`~wx.lib.dragscroller.DragScroller.Start`                                  Start a drag scroll operation
:meth:`~wx.lib.dragscroller.DragScroller.Stop`                                   Stops a drag scroll operation
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: DragScroller

   Scrolls a wx.ScrollWindow in the direction and speed of a mouse drag.
   
   Call Start with the position of the drag start.
   Call Stop on the drag release. 

   .. method:: __init__(self, scrollwin=None, rate=30, sensitivity=0.75)

      Initialize self.  See help(type(self)) for accurate signature.


   .. method:: GetScrollWindow(self)


   .. method:: GetSensitivity(self)


   .. method:: GetUpdateRate(self)


   .. method:: OnTimerDoScroll(self, event)


   .. method:: SetScrollWindow(self, scrollwin)


   .. method:: SetSensitivity(self, sensitivity)


   .. method:: SetUpdateRate(self, rate)


   .. method:: Start(self, pos)

      Start a drag scroll operation 


   .. method:: Stop(self)

      Stops a drag scroll operation