********
wx.Panel
********

Inheritance diagram for `wx.Panel`:

|

.. inheritance-diagram:: wx.Panel

|

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

A panel is a window on which controls are placed. It is usually placed within a frame. It contains minimal extra functionality 
over and above its parent class wx.Window; its main purpose is to be similar in appearance and functionality to a dialog, but 
with the flexibility of having any window as a parent.

.. tip:: if not all characters are being intercepted by your `OnKeyDown` or `OnChar` handler, it may be because you are using the 
   ``wx.TAB_TRAVERSAL`` style, which grabs some keypresses for use by child controls.

.. seealso:: `wx.Dialog <wx.Dialog.html>`_


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

* `wx.Window <wx.Window.html>`_ 
* `wx.EvtHandler <wx.EvtHandler.html>`_ 
* `wx.Object <wx.Object.html>`_ 


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

`wx.HtmlListBox <wx.HtmlListBox.html>`_, `wx.NotebookPage`, `wx.PreviewCanvas <wx.PreviewCanvas.html>`_, 
`wx.PreviewControlBar <wx.PreviewControlBar.html>`_, `wx.PyPanel <wx.PyPanel.html>`_, `wx.PyPreviewControlBar <wx.PyPreviewControlBar.html>`_, 
`wx.PyScrolledWindow <wx.PyScrolledWindow.html>`_, `wx.ScrolledWindow <wx.ScrolledWindow.html>`_, `wx.SimpleHtmlListBox <wx.SimpleHtmlListBox.html>`_, 
`wx.VListBox <wx.VListBox.html>`_, `wx.VScrolledWindow <wx.VScrolledWindow.html>`_

Remarks
^^^^^^^

By default, a panel has the same colouring as a dialog.


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

* `__init__ <#__init__>`_ 
* `SetFocus <#SetFocus>`_ 
* `SetFocusIgnoringChildren <#SetFocusIgnoringChildren>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.TAB_TRAVERSAL|wx.NO_BORDER, name=wx.PanelNameStr)

   Constructor.

   **Parameters:**

   * `parent` (`wx.Window <wx.Window.html>`_)
   * `id` (int)
   * `pos` (`wx.Point <wx.Point.html>`_)
   * `size` (`wx.Size <wx.Size.html>`_)
   * `style` (long)
   * `name` (string)

   |

   **Returns:**

   `wx.Panel <wx.Panel.html>`_
 

--------

.. method:: SetFocus()

   Overrides `wx.Window.SetFocus <wx.Window.html#SetFocus>`_. 

   This method uses the mix-in class `wx.ControlContainer <wx.ControlContainer.html>`_ which manages the focus and ``TAB`` logic for controls 
   which usually have child controls. In practice, if you call this method and the control has at least one child window, the 
   focus will be given to the child window.

.. seealso:: `wx.FocusEvent <../Events/wx.FocusEvent.html>`_, `wx.Window.SetFocus <wx.Window.html#SetFocus>`_
  

--------

.. method:: SetFocusIgnoringChildren()

   In contrast to `SetFocus <#SetFocus>`_ (see above) this will set the focus to the panel even of there are child windows 
   in the panel. This is only rarely needed.