.. 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.aui.AuiToolBarEvent:

==========================================================================================================================================
|phoenix_title|  **wx.aui.AuiToolBarEvent**
==========================================================================================================================================

:ref:`wx.aui.AuiToolBarEvent`  is used for the events generated by :ref:`wx.aui.AuiToolBar`. 
         









|

|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>AuiToolBarEvent</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.aui.AuiToolBarEvent_inheritance.svg" alt="Inheritance diagram of AuiToolBarEvent" 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.aui.AuiToolBarEvent.html" title="wx.aui.AuiToolBarEvent  is used for the events generated by wx.aui.AuiToolBar." alt="" coords="5,313,204,341"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="This class is not used by the event handlers by itself, but is a base class for other event classes (such as wx.BookCtrlEvent)." alt="" coords="37,236,172,265"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="21,159,189,188"/> <area shape="rect" id="node4" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="58,82,152,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="55,5,154,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.aui.AuiToolBarEvent.__init__`                                         
:meth:`~wx.aui.AuiToolBarEvent.GetClickPoint`                                    Returns the point where the user clicked with the mouse.
:meth:`~wx.aui.AuiToolBarEvent.GetItemRect`                                      Returns the :ref:`wx.aui.AuiToolBarItem`  rectangle bounding the mouse click point.
:meth:`~wx.aui.AuiToolBarEvent.GetToolId`                                        Returns the :ref:`wx.aui.AuiToolBarItem`  identifier.
:meth:`~wx.aui.AuiToolBarEvent.IsDropDownClicked`                                Returns whether the drop down menu has been clicked.
:meth:`~wx.aui.AuiToolBarEvent.SetClickPoint`                                    
:meth:`~wx.aui.AuiToolBarEvent.SetDropDownClicked`                               
:meth:`~wx.aui.AuiToolBarEvent.SetItemRect`                                      
:meth:`~wx.aui.AuiToolBarEvent.SetToolId`                                        
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.aui.AuiToolBarEvent.ClickPoint`                                       See :meth:`~wx.aui.AuiToolBarEvent.GetClickPoint` and :meth:`~wx.aui.AuiToolBarEvent.SetClickPoint`
:attr:`~wx.aui.AuiToolBarEvent.ItemRect`                                         See :meth:`~wx.aui.AuiToolBarEvent.GetItemRect` and :meth:`~wx.aui.AuiToolBarEvent.SetItemRect`
:attr:`~wx.aui.AuiToolBarEvent.ToolId`                                           See :meth:`~wx.aui.AuiToolBarEvent.GetToolId` and :meth:`~wx.aui.AuiToolBarEvent.SetToolId`
================================================================================ ================================================================================


|


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


.. class:: wx.aui.AuiToolBarEvent(NotifyEvent)

   **Possible constructors**::

       AuiToolBarEvent(commandType: EventType=wxEVT_NULL, winId: int=0) -> None
       
       AuiToolBarEvent(c : AuiToolBarEvent) -> None
       
   
   AuiToolBarEvent is used for the events generated by AuiToolBar.



   .. method:: __init__(self, *args, **kw)



      |overload| **Overloaded Implementations:**

      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, commandType: EventType=wxEVT_NULL, winId: int=0)`
      
      
      
      
      :param `commandType`: 
      :type `commandType`: wx.EventType
      :param `winId`: 
      :type `winId`: int
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`

      
      **__init__** `(self, c : AuiToolBarEvent)`
      
      
      
      
      :param `c`: 
      :type `c`: wx.aui.AuiToolBarEvent
      
      
      
      
      :rtype: `None`     
      
      
      
      
      
      
      
      :html:`<hr class="overloadsep" /><br />`






   .. method:: GetClickPoint(self)

      Returns the point where the user clicked with the mouse. 
                 

      :rtype: `Point`     








   .. method:: GetItemRect(self)

      Returns the :ref:`wx.aui.AuiToolBarItem`  rectangle bounding the mouse click point. 
                 

      :rtype: `Rect`     








   .. method:: GetToolId(self)

      Returns the :ref:`wx.aui.AuiToolBarItem`  identifier. 
                 

      :rtype: `int`








   .. method:: IsDropDownClicked(self)

      Returns whether the drop down menu has been clicked. 
                 

      :rtype: `bool`








   .. method:: SetClickPoint(self, p : Point)




      :param `p`: 
      :type `p`: wx.Point




      :rtype: `None`     








   .. method:: SetDropDownClicked(self, c : bool)




      :param `c`: 
      :type `c`: bool




      :rtype: `None`     








   .. method:: SetItemRect(self, r : Rect)




      :param `r`: 
      :type `r`: wx.Rect




      :rtype: `None`     








   .. method:: SetToolId(self, toolId : int)




      :param `toolId`: 
      :type `toolId`: int




      :rtype: `None`     








   .. attribute:: ClickPoint

      See :meth:`~wx.aui.AuiToolBarEvent.GetClickPoint` and :meth:`~wx.aui.AuiToolBarEvent.SetClickPoint`


   .. attribute:: ItemRect

      See :meth:`~wx.aui.AuiToolBarEvent.GetItemRect` and :meth:`~wx.aui.AuiToolBarEvent.SetItemRect`


   .. attribute:: ToolId

      See :meth:`~wx.aui.AuiToolBarEvent.GetToolId` and :meth:`~wx.aui.AuiToolBarEvent.SetToolId`