File: wx.lib.resizewidget.ResizeWidget.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 (233 lines) | stat: -rw-r--r-- 8,431 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
.. 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.resizewidget

.. highlight:: python



.. _wx.lib.resizewidget.ResizeWidget:

==========================================================================================================================================
|phoenix_title|  **wx.lib.resizewidget.ResizeWidget**
==========================================================================================================================================

Reparents a given widget into a specialized panel that provides a resize
handle for the widget.



|

|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>ResizeWidget</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.resizewidget.ResizeWidget_inheritance.png" alt="Inheritance diagram of ResizeWidget" 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.resizewidget.ResizeWidget.html" title="wx.lib.resizewidget.ResizeWidget" alt="" coords="5,392,245,421"/> <area shape="rect" id="node2" href="wx.Panel.html" title="wx.Panel" alt="" coords="85,315,165,344"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window" alt="" coords="77,237,174,267"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="61,160,190,189"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="67,83,184,112"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="22,5,109,35"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="133,5,240,35"/> </map> 
   </p>
   </div>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Panel`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.resizewidget.ResizeWidget.__init__`                               Default class constructor.
:meth:`~wx.lib.resizewidget.ResizeWidget.AddChild`                               Add the child to manage.
:meth:`~wx.lib.resizewidget.ResizeWidget.AdjustToChild`                          Adjust the size to the child.
:meth:`~wx.lib.resizewidget.ResizeWidget.AdjustToSize`                           Adjust to given size.
:meth:`~wx.lib.resizewidget.ResizeWidget.DoGetBestSize`                          Return the best size.
:meth:`~wx.lib.resizewidget.ResizeWidget.EnableResize`                           Enable resizing.
:meth:`~wx.lib.resizewidget.ResizeWidget.GetManagedChild`                        Get the managed child.
:meth:`~wx.lib.resizewidget.ResizeWidget.IsResizeEnabled`                        Is resize enabled?
:meth:`~wx.lib.resizewidget.ResizeWidget.OnLeftDown`                             Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.OnLeftUp`                               Handles the ``wx.EVT_LEFT_UP`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.OnMouseLeave`                           Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.OnMouseMove`                            Handles the ``wx.EVT_MOTION`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.OnPaint`                                Handles the ``wx.EVT_PAINT`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.OnSize`                                 Handles the ``wx.EVT_SIZE`` event for :class:`ResizeWidget`.
:meth:`~wx.lib.resizewidget.ResizeWidget.RemoveChild`                            Remove the managed child.
:meth:`~wx.lib.resizewidget.ResizeWidget.SetColors`                              Set the colors of handles.
:meth:`~wx.lib.resizewidget.ResizeWidget.SetDimensions`                          Set the dimensions of handles.
:meth:`~wx.lib.resizewidget.ResizeWidget.SetManagedChild`                        Set a managed child.
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.lib.resizewidget.ResizeWidget.ManagedChild`                           Get the managed child.
================================================================================ ================================================================================


|


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


.. class:: ResizeWidget(wx.Panel)

   Reparents a given widget into a specialized panel that provides a resize
   handle for the widget.

   .. method:: __init__(self, \*args, \*\*kw)

      Default class constructor.
      
      :param `args`: arguments will be passed on to the wx.Panel
      :param `kw`: key words will be passed on to the wx.Panel


   .. method:: AddChild(self, child)

      Add the child to manage.
      
      :param `child`: the child to manage.


   .. method:: AdjustToChild(self)

      Adjust the size to the child.


   .. method:: AdjustToSize(self, size)

      Adjust to given size.
      
      :param `size`: size to adjust to.


   .. method:: DoGetBestSize(self)

      Return the best size.


   .. method:: EnableResize(self, enable=True)

      Enable resizing.
      
      :param boolean `enable`: enable or disable resizing.


   .. method:: GetManagedChild(self)

      Get the managed child.


   .. method:: IsResizeEnabled(self)

      Is resize enabled?


   .. method:: OnLeftDown(self, evt)

      Handles the ``wx.EVT_LEFT_DOWN`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`MouseEvent` event to be processed.


   .. method:: OnLeftUp(self, evt)

      Handles the ``wx.EVT_LEFT_UP`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`MouseEvent` event to be processed.


   .. method:: OnMouseLeave(self, evt)

      Handles the ``wx.EVT_LEAVE_WINDOW`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`MouseEvent` event to be processed.


   .. method:: OnMouseMove(self, evt)

      Handles the ``wx.EVT_MOTION`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`MouseEvent` event to be processed.


   .. method:: OnPaint(self, evt)

      Handles the ``wx.EVT_PAINT`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`PaintEvent` event to be processed.


   .. method:: OnSize(self, evt)

      Handles the ``wx.EVT_SIZE`` event for :class:`ResizeWidget`.
      
      :param `evt`: a :class:`wx.SizeEvent` event to be processed.


   .. method:: RemoveChild(self, child)

      Remove the managed child.
      
      :param `child`: child to remove.


   .. method:: SetColors(self, pen=RW_PEN, fill=RW_FILL, fill2=RW_FILL2)

      Set the colors of handles.
      
      :param `pen`: the pen color
      :param `fill`: the fill color
      :param `fill2`: the secondary fill color


   .. method:: SetDimensions(self, thickness=RW_THICKNESS, length=RW_LENGTH)

      Set the dimensions of handles.
      
      :param `thickness`: the thickness of the handles
      :param `length`: the length of the handles


   .. method:: SetManagedChild(self, child)

      Set a managed child.
      
      :param `child`: child to manage


   .. attribute:: ManagedChild

      Get the managed child.