.. 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.RibbonPanelEvent:
==========================================================================================================================================
|phoenix_title| **wx.ribbon.RibbonPanelEvent**
==========================================================================================================================================
Event used to indicate various actions relating to a :ref:`wx.ribbon.RibbonPanel`.
See :ref:`wx.ribbon.RibbonPanel` for available event types.
.. versionadded:: 2.9.4
.. seealso:: :ref:`wx.ribbon.RibbonPanel`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
RibbonPanelEvent:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ribbon.RibbonPanelEvent.__init__` Constructor.
:meth:`~wx.ribbon.RibbonPanelEvent.GetPanel` Returns the panel relating to this event.
:meth:`~wx.ribbon.RibbonPanelEvent.SetPanel` Sets the page relating to this event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ribbon.RibbonPanelEvent.Panel` See :meth:`~wx.ribbon.RibbonPanelEvent.GetPanel` and :meth:`~wx.ribbon.RibbonPanelEvent.SetPanel`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ribbon.RibbonPanelEvent(CommandEvent)
**Possible constructors**::
RibbonPanelEvent(command_type: EventType=wxEVT_NULL, win_id: int=0,
panel: Optional[RibbonPanel]=None) -> None
Event used to indicate various actions relating to a RibbonPanel.
.. method:: __init__(self, command_type: EventType=wxEVT_NULL, win_id: int=0, panel: Optional[RibbonPanel]=None)
Constructor.
:param `command_type`:
:type `command_type`: wx.EventType
:param `win_id`:
:type `win_id`: int
:param `panel`:
:type `panel`: wx.ribbon.RibbonPanel
:rtype: `None`
.. method:: GetPanel(self)
Returns the panel relating to this event.
:rtype: :ref:`wx.ribbon.RibbonPanel`
.. method:: SetPanel(self, page : RibbonPanel)
Sets the page relating to this event.
:param `page`:
:type `page`: wx.ribbon.RibbonPanel
:rtype: `None`
.. attribute:: Panel
See :meth:`~wx.ribbon.RibbonPanelEvent.GetPanel` and :meth:`~wx.ribbon.RibbonPanelEvent.SetPanel`