File: wx.ShowEvent.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 (177 lines) | stat: -rw-r--r-- 4,713 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
.. 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.ShowEvent:

==========================================================================================================================================
|phoenix_title|  **wx.ShowEvent**
==========================================================================================================================================

An event being sent when the window is shown or hidden.          

The event is triggered by calls to :meth:`wx.Window.Show` , and any user action showing a previously hidden window or vice versa (if allowed by the current platform and/or window manager). Notice that the event is not triggered when the application is iconized (minimized) or restored under wxMSW. 









.. _ShowEvent-events:

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

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

Event macros: 

- EVT_SHOW: Process a  ``wxEVT_SHOW``   event.   








         



.. availability:: Only available for MSW, GTK, OS2.  







.. seealso:: :ref:`Events and Event Handling <events and event handling>`, :meth:`wx.Window.Show` , :meth:`wx.Window.IsShown`     







|

|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>ShowEvent</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.ShowEvent_inheritance.png" alt="Inheritance diagram of ShowEvent" 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="21,83,99,112"/> <area shape="rect" id="node3" href="wx.ShowEvent.html" title="wx.ShowEvent" alt="" coords="4,160,115,189"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="19,5,100,35"/> </map> 
   </p>

|


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

================================================================================ ================================================================================
:meth:`~wx.ShowEvent.__init__`                                                   Constructor.
:meth:`~wx.ShowEvent.IsShown`                                                    Return ``True`` if the window has been shown, ``False`` if it has been hidden.
:meth:`~wx.ShowEvent.SetShow`                                                    Set whether the windows was shown or hidden.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.ShowEvent.Show`                                                       See :meth:`~wx.ShowEvent.IsShown` and :meth:`~wx.ShowEvent.SetShow`
================================================================================ ================================================================================


|


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


.. class:: wx.ShowEvent(Event)

   **Possible constructors**::

       ShowEvent(winid=0, show=False)
       
   
   An event being sent when the window is shown or hidden.



   .. method:: __init__(self, winid=0, show=False)

      Constructor.                  


      :param `winid`: 
      :type `winid`: int
      :param `show`: 
      :type `show`: bool







   .. method:: IsShown(self)

      Return ``True`` if the window has been shown, ``False`` if it has been hidden.                  

      :rtype: `bool`








   .. method:: SetShow(self, show)

      Set whether the windows was shown or hidden.                  


      :param `show`: 
      :type `show`: bool







   .. attribute:: Show

      See :meth:`~wx.ShowEvent.IsShown` and :meth:`~wx.ShowEvent.SetShow`