File: wx.SizeEvent.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 (212 lines) | stat: -rw-r--r-- 6,033 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
.. 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



.. _wx.SizeEvent:

==========================================================================================================================================
|phoenix_title|  **wx.SizeEvent**
==========================================================================================================================================

A size event holds information about size change events of :ref:`wx.Window`.          

The ``EVT_SIZE`` handler function will be called when the window has been resized. 

You may wish to use this for frames to resize their child windows as appropriate. 

Note that the size passed is of the whole window: call :meth:`wx.Window.GetClientSize`   for the area which may be used by the application. 

When a window is resized, usually only a small part of the window is damaged and you may only need to repaint that area. However, if your drawing depends on the size of the window, you may need to clear the DC explicitly and repaint the whole window. In which case, you may need to call :meth:`wx.Window.Refresh`   to invalidate the entire window. 

**Important**  : Sizers ( see :ref:`Sizers Overview <sizers overview>`  ) rely on size events to function correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all size events you catch (and don't catch size events at all when you don't need to). 







.. _SizeEvent-events:

|events| Events Emitted by this Class
=====================================

Handlers bound for the following event types will receive a :ref:`wx.SizeEvent` parameter.

Event macros: 

- EVT_SIZE: Process a  ``wxEVT_SIZE``   event.   








         



.. seealso:: :ref:`wx.Size`, :ref:`Events and Event Handling <events and event handling>`    







|

|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>SizeEvent</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.SizeEvent_inheritance.png" alt="Inheritance diagram of SizeEvent" 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.Event.html" title="wx.Event" alt="" coords="18,83,96,112"/> <area shape="rect" id="node3" href="wx.SizeEvent.html" title="wx.SizeEvent" alt="" coords="5,160,109,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="16,5,97,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.SizeEvent.__init__`                                                   Constructor.
:meth:`~wx.SizeEvent.GetRect`                                                    
:meth:`~wx.SizeEvent.GetSize`                                                    Returns the entire size of the window generating the size change event.
:meth:`~wx.SizeEvent.SetRect`                                                    
:meth:`~wx.SizeEvent.SetSize`                                                    
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.SizeEvent.Rect`                                                       See :meth:`~wx.SizeEvent.GetRect` and :meth:`~wx.SizeEvent.SetRect`
:attr:`~wx.SizeEvent.Size`                                                       See :meth:`~wx.SizeEvent.GetSize` and :meth:`~wx.SizeEvent.SetSize`
================================================================================ ================================================================================


|


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


.. class:: wx.SizeEvent(Event)

   **Possible constructors**::

       SizeEvent(sz, id=0)
       
   
   A size event holds information about size change events of Window.



   .. method:: __init__(self, sz, id=0)

      Constructor.                  


      :param `sz`: 
      :type `sz`: wx.Size
      :param `id`: 
      :type `id`: int







   .. method:: GetRect(self)



      :rtype: :ref:`wx.Rect`








   .. method:: GetSize(self)

      Returns the entire size of the window generating the size change event.                  

      This is the new total size of the window, i.e. the same size as would be returned by :meth:`wx.Window.GetSize`   if it were called now. Use :meth:`wx.Window.GetClientSize`   if you catch this event in a top level window such as :ref:`wx.Frame`  to find the size available for the window contents.                  

      :rtype: :ref:`wx.Size`








   .. method:: SetRect(self, rect)




      :param `rect`: 
      :type `rect`: wx.Rect







   .. method:: SetSize(self, size)




      :param `size`: 
      :type `size`: wx.Size







   .. attribute:: Rect

      See :meth:`~wx.SizeEvent.GetRect` and :meth:`~wx.SizeEvent.SetRect`


   .. attribute:: Size

      See :meth:`~wx.SizeEvent.GetSize` and :meth:`~wx.SizeEvent.SetSize`