File: wx.ProcessEvent.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 (173 lines) | stat: -rw-r--r-- 4,702 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
.. 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



.. _wx.ProcessEvent:

==========================================================================================================================================
|phoenix_title|  **wx.ProcessEvent**
==========================================================================================================================================

A process event is sent to the :ref:`wx.EvtHandler`  specified to :ref:`wx.Process`  when a process is terminated.          

^^ 





.. _ProcessEvent-events:

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

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

Event macros: 

- EVT_END_PROCESS: Process a  ``wxEVT_END_PROCESS``   event.  `id`  is the identifier of the process object (the id passed to the :ref:`wx.Process`  constructor) or a window to receive the event. ^^ 






         



.. seealso:: :ref:`wx.Process`, :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>ProcessEvent</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.ProcessEvent_inheritance.png" alt="Inheritance diagram of ProcessEvent" 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.ProcessEvent.html" title="wx.ProcessEvent" alt="" coords="5,160,137,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="30,83,113,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="28,5,115,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.ProcessEvent.__init__`                                                Constructor.
:meth:`~wx.ProcessEvent.GetExitCode`                                             Returns the exist status.
:meth:`~wx.ProcessEvent.GetPid`                                                  Returns the process id.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.ProcessEvent.ExitCode`                                                See :meth:`~wx.ProcessEvent.GetExitCode`
:attr:`~wx.ProcessEvent.Pid`                                                     See :meth:`~wx.ProcessEvent.GetPid`
================================================================================ ================================================================================


|


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


.. class:: wx.ProcessEvent(Event)

   **Possible constructors**::

       ProcessEvent(id=0, pid=0, exitcode=0)
       
   
   A process event is sent to the EvtHandler specified to Process
   when a process is terminated.



   .. method:: __init__(self, id=0, pid=0, exitcode=0)

      Constructor.                  

      Takes a ProcessObject or window id, a process id and an exit status.                  


      :param `id`: 
      :type `id`: int
      :param `pid`: 
      :type `pid`: int
      :param `exitcode`: 
      :type `exitcode`: int







   .. method:: GetExitCode(self)

      Returns the exist status.                  

      :rtype: `int`








   .. method:: GetPid(self)

      Returns the process id.                  

      :rtype: `int`








   .. attribute:: ExitCode

      See :meth:`~wx.ProcessEvent.GetExitCode`


   .. attribute:: Pid

      See :meth:`~wx.ProcessEvent.GetPid`