File: wx.lib.ogl.basic.ShapeEvtHandler.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (294 lines) | stat: -rw-r--r-- 9,496 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
.. wxPython Phoenix documentation

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

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

.. include:: headings.inc

.. currentmodule:: wx.lib.ogl.basic

.. highlight:: python



.. _wx.lib.ogl.basic.ShapeEvtHandler:

==========================================================================================================================================
|phoenix_title|  **wx.lib.ogl.basic.ShapeEvtHandler**
==========================================================================================================================================

The :class:`ShapeEvtHandler` class.



|

|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>ShapeEvtHandler</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.ogl.basic.ShapeEvtHandler_inheritance.png" alt="Inheritance diagram of ShapeEvtHandler" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.ogl.basic.ShapeEvtHandler.html" title="wx.lib.ogl.basic.ShapeEvtHandler" alt="" coords="5,5,235,35"/> </map> 
   </p>

|


|sub_classes| Known Subclasses
==============================

:class:`wx.lib.ogl.basic.Shape`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.__init__`                               Default class constructor.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.GetPreviousHandler`                     Get previous event handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.GetShape`                               Get associated shape.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnBeginDragLeft`                        The begin drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnBeginDragRight`                       The begin drag right handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnBeginSize`                            not implemented???
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnChangeAttachment`                     The change attachment handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDelete`                               The delete handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDragLeft`                             The drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDragRight`                            The drag right handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDraw`                                 The draw handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDrawBranches`                         The draw branches handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDrawContents`                         The draw contents handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDrawControlPoints`                    The draw control points handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnDrawOutline`                          The drag outline handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnEndDragLeft`                          The end drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnEndDragRight`                         The end drag right handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnEndSize`                              not implemented???
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnErase`                                The erase handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnEraseContents`                        The erase contents handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnEraseControlPoints`                   The erase control points handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnHighlight`                            The highlight handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnLeftClick`                            The left click handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnLeftDoubleClick`                      The left double click handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnMoveLink`                             The move link handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnMoveLinks`                            The move links handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnMovePost`                             The post move handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnMovePre`                              The pre move handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnRightClick`                           The right click handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnSize`                                 The size handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnSizingBeginDragLeft`                  The sizing begin drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnSizingDragLeft`                       The sizing drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.OnSizingEndDragLeft`                    The sizing end drag left handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.SetPreviousHandler`                     Set previous event handler.
:meth:`~wx.lib.ogl.basic.ShapeEvtHandler.SetShape`                               Set associated shape
================================================================================ ================================================================================


|


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


.. class:: ShapeEvtHandler(object)

   The :class:`ShapeEvtHandler` class.

   .. method:: __init__(self, prev = None, shape = None)

      Default class constructor.
      
      :param `pref`: the previous event handler, an instance of
       :class:`ShapeEvtHandler` ???
      :param `shape`: the shape, an instance of :class:`Shape`


   .. method:: GetPreviousHandler(self)

      Get previous event handler.


   .. method:: GetShape(self)

      Get associated shape.


   .. method:: OnBeginDragLeft(self, x, y, keys = 0, attachment = 0)

      The begin drag left handler.


   .. method:: OnBeginDragRight(self, x, y, keys = 0, attachment = 0)

      The begin drag right handler.


   .. method:: OnBeginSize(self, w, h)

      not implemented???


   .. method:: OnChangeAttachment(self, attachment, line, ordering)

      The change attachment handler.


   .. method:: OnDelete(self)

      The delete handler.


   .. method:: OnDragLeft(self, draw, x, y, keys = 0, attachment = 0)

      The drag left handler.


   .. method:: OnDragRight(self, draw, x, y, keys = 0, attachment = 0)

      The drag right handler.


   .. method:: OnDraw(self, dc)

      The draw handler.


   .. method:: OnDrawBranches(self, dc, erase = False)

      The draw branches handler.


   .. method:: OnDrawContents(self, dc)

      The draw contents handler.


   .. method:: OnDrawControlPoints(self, dc)

      The draw control points handler.


   .. method:: OnDrawOutline(self, dc, x, y, w, h)

      The drag outline handler.


   .. method:: OnEndDragLeft(self, x, y, keys = 0, attachment = 0)

      The end drag left handler.


   .. method:: OnEndDragRight(self, x, y, keys = 0, attachment = 0)

      The end drag right handler.


   .. method:: OnEndSize(self, w, h)

      not implemented???


   .. method:: OnErase(self, dc)

      The erase handler.


   .. method:: OnEraseContents(self, dc)

      The erase contents handler.


   .. method:: OnEraseControlPoints(self, dc)

      The erase control points handler.


   .. method:: OnHighlight(self, dc)

      The highlight handler.


   .. method:: OnLeftClick(self, x, y, keys, attachment)

      The left click handler.


   .. method:: OnLeftDoubleClick(self, x, y, keys = 0, attachment = 0)

      The left double click handler.


   .. method:: OnMoveLink(self, dc, moveControlPoints = True)

      The move link handler.


   .. method:: OnMoveLinks(self, dc)

      The move links handler.


   .. method:: OnMovePost(self, dc, x, y, old_x, old_y, display = True)

      The post move handler.


   .. method:: OnMovePre(self, dc, x, y, old_x, old_y, display = True)

      The pre move handler.


   .. method:: OnRightClick(self, x, y, keys = 0, attachment = 0)

      The right click handler.


   .. method:: OnSize(self, x, y)

      The size handler.


   .. method:: OnSizingBeginDragLeft(self, pt, x, y, keys = 0, attachment = 0)

      The sizing begin drag left handler.


   .. method:: OnSizingDragLeft(self, pt, draw, x, y, keys = 0, attachment = 0)

      The sizing drag left handler.


   .. method:: OnSizingEndDragLeft(self, pt, x, y, keys = 0, attachment = 0)

      The sizing end drag left handler.


   .. method:: SetPreviousHandler(self, handler)

      Set previous event handler.
      
      :param `handler`: the previous handler, an instance of
       :class:`ShapeEvtHandler` ???


   .. method:: SetShape(self, sh)

      Set associated shape
      
      :param `sh`:  the shape, an instance of :class:`Shape`