.. 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.FocusEvent:

==========================================================================================================================================
|phoenix_title|  **wx.FocusEvent**
==========================================================================================================================================

A focus event is sent when a window's focus changes.          

The window losing focus receives a "kill focus" event while the window gaining it gets a "set focus" one. 

Notice that the set focus event happens both when the user gives focus to the window (whether using the mouse or keyboard) and when it is done from the program itself using :meth:`wx.Window.SetFocus` . 

The focus event handlers should almost invariably call :meth:`wx.Event.Skip`   on their event argument to allow the default handling to take place. Failure to do this may result in incorrect behaviour of the native controls. Also note that wxEVT_KILL_FOCUS handler must not call :meth:`wx.Window.SetFocus`   as this, again, is not supported by all native controls. If you need to do this, consider using the :ref:`Delayed Action Mechanism <wx.IdleEvent>`  described in :ref:`wx.IdleEvent`  documentation. 

^^ 





.. _FocusEvent-events:

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

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

 

- EVT_SET_FOCUS: Process a  ``wxEVT_SET_FOCUS``   event.   
- EVT_KILL_FOCUS: Process a  ``wxEVT_KILL_FOCUS``   event. ^^ 






         



.. seealso:: :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>FocusEvent</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.FocusEvent_inheritance.png" alt="Inheritance diagram of FocusEvent" 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.FocusEvent.html" title="A focus event is sent when a window's focus changes." alt="" coords="5,160,120,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="23,83,102,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="21,5,104,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.FocusEvent.__init__`                                                  Constructor.
:meth:`~wx.FocusEvent.GetWindow`                                                 Returns the window associated with this event, that is the window which had the focus before for the  ``wxEVT_SET_FOCUS``   event and the window which is going to receive focus for the   ``wxEVT_KILL_FOCUS``   one.
:meth:`~wx.FocusEvent.SetWindow`                                                 
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.FocusEvent.Window`                                                    See :meth:`~wx.FocusEvent.GetWindow` and :meth:`~wx.FocusEvent.SetWindow`
================================================================================ ================================================================================


|


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


.. class:: wx.FocusEvent(Event)

   **Possible constructors**::

       FocusEvent(eventType=wxEVT_NULL, id=0)
       
   
   A focus event is sent when a window's focus changes.



   .. method:: __init__(self, eventType=wxEVT_NULL, id=0)

      Constructor.                  


      :param `eventType`: 
      :type `eventType`: wx.EventType
      :param `id`: 
      :type `id`: int







   .. method:: GetWindow(self)

      Returns the window associated with this event, that is the window which had the focus before for the  ``wxEVT_SET_FOCUS``   event and the window which is going to receive focus for the   ``wxEVT_KILL_FOCUS``   one.                   

      Warning: the window pointer may be ``None``!                  

      :rtype: :ref:`wx.Window`








   .. method:: SetWindow(self, win)




      :param `win`: 
      :type `win`: wx.Window







   .. attribute:: Window

      See :meth:`~wx.FocusEvent.GetWindow` and :meth:`~wx.FocusEvent.SetWindow`