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

==========================================================================================================================================
|phoenix_title|  **wx.MouseCaptureChangedEvent**
==========================================================================================================================================

A mouse capture changed event is sent to a window that loses its mouse capture.          

This is called even if :meth:`wx.Window.ReleaseMouse`   was called by the application code. Handling this event allows an application to cater for unexpected capture releases which might otherwise confuse mouse handling code. 



^^ 





.. _MouseCaptureChangedEvent-events:

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

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

Event macros: 

- EVT_MOUSE_CAPTURE_CHANGED: Process a  ``wxEVT_MOUSE_CAPTURE_CHANGED``   event. ^^ 






         



.. availability:: Only available for MSW.  







.. seealso:: :ref:`wx.MouseCaptureLostEvent`, :ref:`Events and Event Handling <events and event handling>`, :meth:`wx.Window.CaptureMouse` , :meth:`wx.Window.ReleaseMouse` , :meth:`wx.Window.GetCapture`     







|

|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>MouseCaptureChangedEvent</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.MouseCaptureChangedEvent_inheritance.png" alt="Inheritance diagram of MouseCaptureChangedEvent" 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.MouseCaptureChangedEvent.html" title="wx.MouseCaptureChangedEvent" alt="" coords="5,160,237,189"/> <area shape="rect" id="node2" href="wx.Event.html" title="wx.Event" alt="" coords="80,83,163,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="78,5,165,35"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.MouseCaptureChangedEvent.__init__`                                    Constructor.
:meth:`~wx.MouseCaptureChangedEvent.GetCapturedWindow`                           Returns the window that gained the capture, or ``None`` if it was a non-wxWidgets window.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.MouseCaptureChangedEvent.CapturedWindow`                              See :meth:`~wx.MouseCaptureChangedEvent.GetCapturedWindow`
================================================================================ ================================================================================


|


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


.. class:: wx.MouseCaptureChangedEvent(Event)

   **Possible constructors**::

       MouseCaptureChangedEvent(windowId=0, gainedCapture=None)
       
   
   A mouse capture changed event is sent to a window that loses its mouse
   capture.



   .. method:: __init__(self, windowId=0, gainedCapture=None)

      Constructor.                  


      :param `windowId`: 
      :type `windowId`: wx.WindowID
      :param `gainedCapture`: 
      :type `gainedCapture`: wx.Window







   .. method:: GetCapturedWindow(self)

      Returns the window that gained the capture, or ``None`` if it was a non-wxWidgets window.                  

      :rtype: :ref:`wx.Window`








   .. attribute:: CapturedWindow

      See :meth:`~wx.MouseCaptureChangedEvent.GetCapturedWindow`

