********
wx.Event
********

Inheritance diagram for `wx.Event`:

|

.. inheritance-diagram:: wx.Event

|

Description
===========

An event is a structure holding information about an event passed to a callback or member function. `wx.Event` used to be a multipurpose 
event object, and is an abstract base class for other event classes.

.. seealso:: `wx.CommandEvent <wx.CommandEvent.html>`_, `wx.MouseEvent <wx.MouseEvent.html>`_

Derived From
^^^^^^^^^^^^^

* `wx.Object <../Widgets/wx.Object.html>`_ 


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.ActivateEvent <wx.ActivateEvent.html>`_, `wx.BookCtrlBaseEvent`, `wx.CalculateLayoutEvent <wx.CalculateLayoutEvent.html>`_, 
`wx.ChildFocusEvent <wx.ChildFocusEvent.html>`_, `wx.ChoicebookEvent`, `wx.ClipboardTextEvent <wx.ClipboardTextEvent.html>`_, `wx.CloseEvent <wx.CloseEvent.html>`_, 
`wx.CollapsiblePaneEvent <wx.CollapsiblePaneEvent.html>`_, `wx.ColourPickerEvent <wx.ColourPickerEvent.html>`_, `wx.CommandEvent <wx.CommandEvent.html>`_, 
`wx.ContextMenuEvent <wx.ContextMenuEvent.html>`_, `wx.DateEvent <wx.DateEvent.html>`_, `wx.DisplayChangedEvent`, `wx.DropFilesEvent <wx.DropFilesEvent.html>`_, 
`wx.EraseEvent <wx.EraseEvent.html>`_, `wx.FileDirPickerEvent <wx.FileDirPickerEvent.html>`_, `wx.FindDialogEvent <wx.FindDialogEvent.html>`_, 
`wx.FocusEvent <wx.FocusEvent.html>`_, `wx.FontPickerEvent <wx.FontPickerEvent.html>`_, `wx.HelpEvent <wx.HelpEvent.html>`_, `wx.HyperlinkEvent <wx.HyperlinkEvent.html>`_, 
`wx.IconizeEvent <wx.IconizeEvent.html>`_, `wx.IdleEvent <wx.IdleEvent.html>`_, `wx.InitDialogEvent <wx.InitDialogEvent.html>`_, `wx.JoystickEvent <wx.JoystickEvent.html>`_, 
`wx.KeyEvent <wx.KeyEvent.html>`_, `wx.ListEvent <wx.ListEvent.html>`_, `wx.ListbookEvent`, `wx.MaximizeEvent <wx.MaximizeEvent.html>`_, `wx.MenuEvent <wx.MenuEvent.html>`_, 
`wx.MouseCaptureChangedEvent <wx.MouseCaptureChangedEvent.html>`_, `wx.MouseCaptureLostEvent <wx.MouseCaptureLostEvent.html>`_, `wx.MouseEvent <wx.MouseEvent.html>`_, 
`wx.MoveEvent <wx.MoveEvent.html>`_, `wx.NavigationKeyEvent`, `wx.NcPaintEvent`, `wx.NotebookEvent <wx.NotebookEvent.html>`_, `wx.NotifyEvent <wx.NotifyEvent.html>`_, 
`wx.PaintEvent <wx.PaintEvent.html>`_, `wx.PaletteChangedEvent`, `wx.PowerEvent <wx.PowerEvent.html>`_, `wx.ProcessEvent <wx.ProcessEvent.html>`_, 
`wx.PyCommandEvent <wx.PyCommandEvent.html>`_, `wx.PyEvent <wx.PyEvent.html>`_, `wx.QueryLayoutInfoEvent <wx.QueryLayoutInfoEvent.html>`_, `wx.QueryNewPaletteEvent`, 
`wx.SashEvent <wx.SashEvent.html>`_, `wx.ScrollEvent <wx.ScrollEvent.html>`_, `wx.ScrollWinEvent <wx.ScrollWinEvent.html>`_, `wx.SetCursorEvent <wx.SetCursorEvent.html>`_, 
`wx.ShowEvent`, `wx.SizeEvent <wx.SizeEvent.html>`_, `wx.SpinEvent <wx.SpinEvent.html>`_, `wx.SplitterEvent <wx.SplitterEvent.html>`_, 
`wx.SysColourChangedEvent <wx.SysColourChangedEvent.html>`_, `wx.TaskBarIconEvent`, `wx.TextUrlEvent`, `wx.TimerEvent <wx.TimerEvent.html>`_, 
`wx.ToolbookEvent`, `wx.TreeEvent <wx.TreeEvent.html>`_, `wx.TreebookEvent <wx.TreebookEvent.html>`_, `wx.UpdateUIEvent <wx.UpdateUIEvent.html>`_, 
`wx.WindowCreateEvent <wx.WindowCreateEvent.html>`_, `wx.WindowDestroyEvent <wx.WindowDestroyEvent.html>`_



Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `Clone <#Clone>`_ 
* `GetEventObject <#GetEventObject>`_ 
* `GetEventType <#GetEventType>`_ 
* `GetId <#GetId>`_ 
* `GetSkipped <#GetSkipped>`_ 
* `GetTimestamp <#GetTimestamp>`_ 
* `IsCommandEvent <#IsCommandEvent>`_ 
* `ResumePropagation <#ResumePropagation>`_ 
* `SetEventObject <#SetEventObject>`_ 
* `SetEventType <#SetEventType>`_ 
* `SetId <#SetId>`_ 
* `SetTimestamp <#SetTimestamp>`_ 
* `ShouldPropagate <#ShouldPropagate>`_ 
* `Skip <#Skip>`_ 
* `StopPropagation <#StopPropagation>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `EventObject <#EventObject>`_ 
* `EventType <#EventType>`_ 
* `Id <#Id>`_ 
* `Skipped <#Skipped>`_ 
* `Timestamp <#Timestamp>`_ 

Class API
=========

Methods
^^^^^^^


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

   Constructor. Should not need to be used directly by an application.

   **Parameters:**

   * `id` (int) 
   * `eventType` (eventtype) 

   |

   **Returns:**

   `wx.Event <wx.Event.html>`_

--------


.. method:: Clone()

   Returns a copy of the event.

   Any event that is posted to the wxWidgets event system for later action (via `wx.EvtHandler.AddPendingEvent <../Widgets/wx.EvtHandler.html#AddPendingEvent>`_ 
   or `wx.PostEvent <../wxFunctions.html#PostEvent>`_) must implement this method. All wxWidgets events fully implement this method, but any derived events 
   implemented by the user should also implement this method just in case they (or some event derived from them) are ever posted.

   |

   **Returns:**

   `wx.Event <wx.Event.html>`_
 

--------

.. method:: GetEventObject()

   Returns the object (usually a window) associated with the event, if any.

   |

   **Returns:**

   `wx.Object <../Widgets/wx.Object.html>`_
 

--------

.. method:: GetEventType()

   Returns the identifier of the given event type, such as ``wx.wxEVT_COMMAND_BUTTON_CLICKED``.

   |

   **Returns:**

   `int` 

--------

.. method:: GetId()

   Returns the identifier associated with this event, such as a button command id.

   |

   **Returns:**

   `int` 

--------

.. method:: GetSkipped()

   Returns ``True`` if the event handler should be skipped, ``False`` otherwise.

   |

   **Returns:**

   `bool` 

--------

.. method:: GetTimestamp()

   Gets the timestamp for the event. The timestamp is the time in milliseconds since some fixed moment (**not** necessarily the standard Unix Epoch, 
   so only differences between the timestamps and not their absolute values usually make sense).

   |

   **Returns:**

   `long` 

--------

.. method:: IsCommandEvent()

   Returns ``True`` if the event is or is derived from `wx.CommandEvent <wx.CommandEvent.html>`_ else it returns ``False``. 

   |

   **Returns:**

   `bool` 


.. note:: This method exists only for optimization purposes.


--------

.. method:: ResumePropagation(propagationLevel)

   Sets the propagation level to the given value (for example returned from an earlier call to `StopPropagation <#StopPropagation>`_).

   **Parameters:**

   * `propagationLevel` (int) 


--------

.. method:: SetEventObject(object)

   Sets the originating object.

   **Parameters:**

   * `object` (`wx.Object <../Widgets/wx.Object.html>`_) 

--------

.. method:: SetEventType(type)

   Sets the event type.

   **Parameters:**

   * `type` (int) 

--------

.. method:: SetId(id)

   Sets the identifier associated with this event, such as a button command id.

   **Parameters:**

   * `id` (int) 

--------

.. method:: SetTimestamp(timeStamp)

   Sets the timestamp for the event.

   **Parameters:**

   * `timeStamp` (long) 

--------

.. method:: ShouldPropagate()

   Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.

   |

   **Returns:**

   `bool` 

--------

.. method:: Skip()

   This method can be used inside an event handler to control whether further event handlers bound to this event will be called 
   after the current one returns. Without `Skip()` (or equivalently if `Skip(False)` is used), the event will not be processed any more. 
   If `Skip(True)` is called, the event processing system continues searching for a further handler function for this event, even though 
   it has been processed already in the current handler.

   In general, it is recommended to skip all non-command events to allow the default handling to take place. The command events are, however, 
   normally not skipped as usually a single command such as a button click or menu item selection must only be processed by one handler.


--------

.. method:: StopPropagation()

   Stop the event from propagating to its parent window.

   Returns the old propagation level value which may be later passed to  `ResumePropagation <#ResumePropagation>`_ to allow propagating the event again.

   |

   **Returns:**

   `int` 

--------

Properties
^^^^^^^^^^


.. attribute:: EventObject

   See `GetEventObject <#GetEventObject>`_ and `SetEventObject <#SetEventObject>`_
   

.. attribute:: EventType

   See `GetEventType <#GetEventType>`_ and `SetEventType <#SetEventType>`_
   
   
.. attribute:: Id

   See `GetId <#GetId>`_ and `SetId <#SetId>`_
   
   
.. attribute:: Skipped

   See `GetSkipped <#GetSkipped>`_
   
   
.. attribute:: Timestamp

   See `GetTimestamp <#GetTimestamp>`_ and `SetTimestamp <#SetTimestamp>`_