**********
wx.Control
**********

Inheritance diagram for `wx.Control`:

|

.. inheritance-diagram:: wx.Control

|

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

This is the base class for a control or "widget".

A control is generally a small window which processes user input and/or displays one or more item of data.

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


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

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


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

`wx.BitmapButton <wx.BitmapButton.html>`_, `wx.BookCtrlBase <wx.BookCtrlBase.html>`_, `wx.Button <wx.Button.html>`_, `wx.CheckBox <wx.CheckBox.html>`_, 
`wx.CheckListBox <wx.CheckListBox.html>`_, `wx.Choice <wx.Choice.html>`_, `wx.Choicebook <wx.Choicebook.html>`_, `wx.CollapsiblePane <wx.CollapsiblePane.html>`_, 
`wx.ColourPickerCtrl <wx.ColourPickerCtrl.html>`_, `wx.ComboBox <wx.ComboBox.html>`_, `wx.ContextHelpButton <wx.ContextHelpButton.html>`_, 
`wx.ControlWithItems <wx.ControlWithItems.html>`_, `wx.DatePickerCtrl <wx.DatePickerCtrl.html>`_, `wx.DatePickerCtrlBase <wx.DatePickerCtrlBase.html>`_, 
`wx.DirFilterListCtrl <wx.DirFilterListCtrl.html>`_, `wx.DirPickerCtrl <wx.DirPickerCtrl.html>`_, `wx.FilePickerCtrl <wx.FilePickerCtrl.html>`_, 
`wx.FontPickerCtrl <wx.FontPickerCtrl.html>`_, `wx.Gauge <wx.Gauge.html>`_, `wx.GenericDatePickerCtrl <wx.GenericDatePickerCtrl.html>`_, 
`wx.GenericDirCtrl <wx.GenericDirCtrl.html>`_, `wx.HyperlinkCtrl <wx.HyperlinkCtrl.html>`_, `wx.ListBox <wx.ListBox.html>`_, `wx.ListCtrl <wx.ListCtrl.html>`_, 
`wx.ListView <wx.ListView.html>`_, `wx.Listbook <wx.Listbook.html>`_, `wx.Notebook <wx.Notebook.html>`_, `wx.PickerBase <wx.PickerBase.html>`_, 
`wx.PyControl <wx.PyControl.html>`_, `wx.RadioBox <wx.RadioBox.html>`_, `wx.RadioButton <wx.RadioButton.html>`_, `wx.ScrollBar <wx.ScrollBar.html>`_, 
`wx.SearchCtrl <wx.SearchCtrl.html>`_, `wx.Slider <wx.Slider.html>`_, `wx.SpinButton <wx.SpinButton.html>`_, `wx.SpinCtrl <wx.SpinCtrl.html>`_, 
`wx.StaticBitmap <wx.StaticBitmap.html>`_, `wx.StaticBox <wx.StaticBox.html>`_, `wx.StaticLine <wx.StaticLine.html>`_, `wx.StaticText <wx.StaticText.html>`_, 
`wx.TextCtrl <wx.TextCtrl.html>`_, `wx.ToggleButton <wx.ToggleButton.html>`_, `wx.ToolBar <wx.ToolBar.html>`_, `wx.ToolBarBase <wx.ToolBarBase.html>`_, 
`wx.Toolbook <wx.Toolbook.html>`_, `wx.TreeCtrl <wx.TreeCtrl.html>`_, `wx.Treebook <wx.Treebook.html>`_



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

* `__init__ <#__init__>`_ 
* `Command <#Command>`_ 
* `GetAlignment <#GetAlignment>`_ 
* `GetLabel <#GetLabel>`_ 
* `GetLabelText <#GetLabelText>`_ 
* `SetLabel <#SetLabel>`_ 

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

* `Alignment <#Alignment>`_ 
* `LabelText <#LabelText>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(parent, id=-1, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ControlNameStr)

   Create a Control.  Normally you should only call this from a subclass' 
   `__init__` as a plain old `wx.Control` is not very useful.
   

   **Parameters:**

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

   |

   **Returns:**

   `wx.Control <wx.Control.html>`_
 

--------

.. method:: Command(event)

   Simulates the effect of the user issuing a command to the item. 

   **Parameters:**

   * `event` (`wx.CommandEvent <../Events/wx.CommandEvent.html>`_) 


.. seealso:: `wx.CommandEvent <../Events/wx.CommandEvent.html>`_ 

--------

.. method:: GetAlignment()

   Get the control alignment (left/right/centre, top/bottom/centre)
   
   |

   **Returns:**

   `int` 

--------

.. method:: GetLabel()

   Returns the control's text.

   |

   **Returns:**

   `string` 

.. note:: Note that the returned string contains the mnemonics (``&`` characters) if any, use `GetLabelText <#GetLabelText>`_ if they are undesired.

--------

.. method:: GetLabelText()

   Returns the control's label or the given `label` string for the static version without the mnemonics characters.

   |

   **Returns:**

   `string` 

--------

.. method:: SetLabel(label)

   Sets the item's text.

   The ``&`` characters in the label are special and indicate that the following character is a mnemonic for this control 
   and can be used to activate it from the keyboard (typically by using ``Alt`` key in combination with it). To insert a 
   literal ampersand character, you need to double it, i.e. use ``&&``.

   **Parameters:**

   * `label` (string): the item label.


--------


Properties
^^^^^^^^^^


.. attribute:: Alignment

   See `GetAlignment <#GetAlignment>`_
   

.. attribute:: LabelText

   See `GetLabelText <#GetLabelText>`_