*******************
wx.AcceleratorEntry
*******************

Inheritance diagram for `wx.AcceleratorEntry`:

|

.. inheritance-diagram:: wx.AcceleratorEntry

|

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

An object used by an application wishing to create an *accelerator table*.


.. seealso: `wx.AcceleratorTable <wx.AcceleratorTable.html>`_ , `wx.Window.SetAcceleratorTable <wx.Window.html#SetAcceleratorTable>`_


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

* `__init__ <#__init__>`_ 
* `Create <#Create>`_ 
* `FromString <#FromString>`_ 
* `GetCommand <#GetCommand>`_ 
* `GetFlags <#GetFlags>`_ 
* `GetKeyCode <#GetKeyCode>`_ 
* `IsOk <#IsOk>`_ 
* `Set <#Set>`_ 
* `ToString <#ToString>`_ 

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

* `Command <#Command>`_ 
* `Flags <#Flags>`_ 
* `KeyCode <#KeyCode>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(flags=0, keyCode=0, cmdID=0)

   Construct a `wx.AcceleratorEntry`.
   
   **Parameters:**

   * `flags` (int)
   * `keyCode` (int)
   * `cmdID` (int)

   |

   **Returns:**

   `wx.AcceleratorEntry <wx.AcceleratorEntry.html>`_
 

--------

.. method:: Create(str)

   Create accelerator corresponding to the specified string, or ``None`` if
   it coulnd't be parsed.
   
   **Parameters:**

   * `str` (string)

   |

   **Returns:**

   `wx.AcceleratorEntry <wx.AcceleratorEntry.html>`_
 

--------

.. method:: FromString(str)

   Returns ``True`` if the given string correctly initialized this object.
   
   **Parameters:**

   * `str` (string)

   |

   **Returns:**

   `bool` 

--------

.. method:: GetCommand()

   Returns the command identifier for the accelerator table entry.

   |

   **Returns:**

   `int` 

--------

.. method:: GetFlags()

   Returns the flags for the accelerator table entry.

   |

   **Returns:**

   `int` 

--------

.. method:: GetKeyCode()

   Returns the keycode for the accelerator table entry.

   |

   **Returns:**

   `int` 

--------

.. method:: IsOk()

   `No docstrings available for this method.` 

--------

.. method:: Set(flags, keyCode, cmd)

   Sets the accelerator entry parameters.

   **Parameters:**

   * `flags` (int): One of ``wx.ACCEL_ALT``, ``wx.ACCEL_SHIFT``, ``wx.ACCEL_CTRL`` and ``wx.ACCEL_NORMAL``. Indicates which modifier key is held down.
   * `keyCode` (int): The keycode to be detected.
   * `cmd` (int): The menu or control command identifier.

--------

.. method:: ToString()

   Returns a string representation for the this accelerator.  

   The string is formatted using the <flags>-<keycode> format where <flags> maybe a
   hyphen-separed list of "shift|alt|ctrl"
      
   |

   **Returns:**

   `string` 

--------

Properties
^^^^^^^^^^


.. attribute:: Command

   See `GetCommand <#GetCommand>`_
   
   
.. attribute:: Flags

   See `GetFlags <#GetFlags>`_
   
   
.. attribute:: KeyCode

   See `GetKeyCode <#GetKeyCode>`_