.. 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.RibbonBarEvent:

==========================================================================================================================================
|phoenix_title|  **wx.ribbon.RibbonBarEvent**
==========================================================================================================================================

Event used to indicate various actions relating to a :ref:`wx.ribbon.RibbonBar`. 
         

See :ref:`wx.ribbon.RibbonBar`  for available event types. 








         



.. seealso:: :ref:`wx.ribbon.RibbonBar`    







|

|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>RibbonBarEvent</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.RibbonBarEvent_inheritance.svg" alt="Inheritance diagram of RibbonBarEvent" 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.RibbonBarEvent.html" title="Event used to indicate various actions relating to a wx.ribbon.RibbonBar." alt="" coords="5,313,225,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="48,236,183,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="31,159,199,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="68,82,162,111"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="66,5,165,34"/> </map> 
   </p>
   </div>

|


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

================================================================================ ================================================================================
:meth:`~wx.ribbon.RibbonBarEvent.__init__`                                       Constructor.
:meth:`~wx.ribbon.RibbonBarEvent.GetPage`                                        Returns the page being changed to, or being clicked on.
:meth:`~wx.ribbon.RibbonBarEvent.SetPage`                                        Sets the page relating to this event.
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
:attr:`~wx.ribbon.RibbonBarEvent.Page`                                           See :meth:`~wx.ribbon.RibbonBarEvent.GetPage` and :meth:`~wx.ribbon.RibbonBarEvent.SetPage`
================================================================================ ================================================================================


|


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


.. class:: wx.ribbon.RibbonBarEvent(NotifyEvent)

   **Possible constructors**::

       RibbonBarEvent(command_type: EventType=wxEVT_NULL, win_id: int=0, page:
                      Optional[RibbonPage]=None) -> None
       
   
   Event used to indicate various actions relating to a RibbonBar.



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

      Constructor. 
                 


      :param `command_type`: 
      :type `command_type`: wx.EventType
      :param `win_id`: 
      :type `win_id`: int
      :param `page`: 
      :type `page`: wx.ribbon.RibbonPage




      :rtype: `None`     








   .. method:: GetPage(self)

      Returns the page being changed to, or being clicked on. 
                 

      :rtype: :ref:`wx.ribbon.RibbonPage`








   .. method:: SetPage(self, page : RibbonPage)

      Sets the page relating to this event. 
                 


      :param `page`: 
      :type `page`: wx.ribbon.RibbonPage




      :rtype: `None`     








   .. attribute:: Page

      See :meth:`~wx.ribbon.RibbonBarEvent.GetPage` and :meth:`~wx.ribbon.RibbonBarEvent.SetPage`