.. 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
.. currentmodule:: wx.lib.agw.ribbon.gallery
.. highlight:: python
.. _wx.lib.agw.ribbon.gallery.RibbonGalleryEvent:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.ribbon.gallery.RibbonGalleryEvent**
==========================================================================================================================================
Handles events related to :class:`RibbonGallery`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
RibbonGalleryEvent:
|
|super_classes| Known Superclasses
==================================
:class:`wx.PyCommandEvent`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.ribbon.gallery.RibbonGalleryEvent.__init__` Default class constructor.
:meth:`~wx.lib.agw.ribbon.gallery.RibbonGalleryEvent.GetGallery` Returns the gallery which the event relates to.
:meth:`~wx.lib.agw.ribbon.gallery.RibbonGalleryEvent.GetGalleryItem` Returns the gallery item which the event relates to, or ``None`` if it does not relate to an item.
:meth:`~wx.lib.agw.ribbon.gallery.RibbonGalleryEvent.SetGallery` Sets the gallery relating to this event.
:meth:`~wx.lib.agw.ribbon.gallery.RibbonGalleryEvent.SetGalleryItem` Sets the gallery item relating to this event.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: RibbonGalleryEvent(wx.PyCommandEvent)
Handles events related to :class:`RibbonGallery`.
.. method:: __init__(self, command_type=None, win_id=0, gallery=None, item=None)
Default class constructor.
:param integer `command_type`: the event type;
:param integer `win_id`: the event identifier;
:param `gallery`: an instance of :class:`RibbonGallery`;
:param `item`: an instance of :class:`RibbonGalleryItem`.
.. method:: GetGallery(self)
Returns the gallery which the event relates to.
.. method:: GetGalleryItem(self)
Returns the gallery item which the event relates to, or ``None`` if it does not relate to an item.
.. method:: SetGallery(self, gallery)
Sets the gallery relating to this event.
:param `gallery`: an instance of :class:`RibbonGallery`.
.. method:: SetGalleryItem(self, item)
Sets the gallery item relating to this event.
:param `item`: an instance of :class:`RibbonGalleryItem`.