.. 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.ribbon.RibbonToolBarEvent:

==========================================================================================================================================
|phoenix_title|  **wx.ribbon.RibbonToolBarEvent**
==========================================================================================================================================





|

|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>RibbonToolBarEvent</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.ribbon.RibbonToolBarEvent_inheritance.svg" alt="Inheritance diagram of RibbonToolBarEvent" 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.ribbon.RibbonToolBarEvent.html" title="wx.ribbon.RibbonToolBarEvent" alt="" coords="5,236,255,265"/> <area shape="rect" id="node2" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="46,159,214,188"/> <area shape="rect" id="node3" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="83,82,177,111"/> <area shape="rect" id="node4" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="81,5,180,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.ribbon.RibbonToolBarEvent.__init__`                                   
:meth:`~wx.ribbon.RibbonToolBarEvent.GetBar`                                     
:meth:`~wx.ribbon.RibbonToolBarEvent.PopupMenu`                                  
:meth:`~wx.ribbon.RibbonToolBarEvent.SetBar`                                     
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.ribbon.RibbonToolBarEvent.Bar`                                        See :meth:`~wx.ribbon.RibbonToolBarEvent.GetBar` and :meth:`~wx.ribbon.RibbonToolBarEvent.SetBar`
================================================================================ ================================================================================


|


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


.. class:: wx.ribbon.RibbonToolBarEvent(CommandEvent)

   **Possible constructors**::

       RibbonToolBarEvent(command_type: EventType=wxEVT_NULL, win_id: int=0,
                          bar: Optional[RibbonToolBar]=None) -> None
       



   .. method:: __init__(self, command_type: EventType=wxEVT_NULL, win_id: int=0, bar: Optional[RibbonToolBar]=None)




      :param `command_type`: 
      :type `command_type`: wx.EventType
      :param `win_id`: 
      :type `win_id`: int
      :param `bar`: 
      :type `bar`: wx.ribbon.RibbonToolBar




      :rtype: `None`     








   .. method:: GetBar(self)



      :rtype: :ref:`wx.ribbon.RibbonToolBar`








   .. method:: PopupMenu(self, menu : Menu)




      :param `menu`: 
      :type `menu`: wx.Menu




      :rtype: `bool`








   .. method:: SetBar(self, bar : RibbonToolBar)




      :param `bar`: 
      :type `bar`: wx.ribbon.RibbonToolBar




      :rtype: `None`     








   .. attribute:: Bar

      See :meth:`~wx.ribbon.RibbonToolBarEvent.GetBar` and :meth:`~wx.ribbon.RibbonToolBarEvent.SetBar`