.. include:: headings.inc

.. module:: lib.agw.ribbon.gallery

.. currentmodule:: lib.agw.ribbon.gallery

.. highlight:: python



.. _lib.agw.ribbon.gallery:

==========================================================================================================================================
|phoenix_title|  **gallery**
==========================================================================================================================================

A ribbon gallery is like a :class:`ListBox`, but for bitmaps rather than strings.


Description
===========

It displays a collection of bitmaps arranged in a grid and allows the user to
choose one. As there are typically more bitmaps in a gallery than can be displayed
in the space used for a ribbon, a gallery always has scroll buttons to allow the
user to navigate through the entire gallery.

It also has an "extension" button, the behaviour of which is outside the scope of
the gallery control itself, though it typically displays some kind of dialog related
to the gallery.


Events Processing
=================

This class processes the following events:

=================================== ===================================
Event Name                          Description
=================================== ===================================
``EVT_RIBBONGALLERY_SELECTED``      Triggered when the user selects an item from the gallery. Note that the ID is that of the gallery, not of the item.
``EVT_RIBBONGALLERY_HOVER_CHANGED`` Triggered when the item being hovered over by the user changes. The item in the event will be the new item being hovered, or ``None`` if there is no longer an item being hovered. Note that the ID is that of the gallery, not of the item.
``EVT_RIBBONGALLERY_CLICKED``       Triggered when the user clicks on an item in the gallery.
``EVT_BUTTON``                      Triggered when the "extension" button of the gallery is pressed.
=================================== ===================================



|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for module **gallery**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.agw.ribbon.gallery_inheritance.png" alt="Inheritance diagram of gallery" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node16" href="lib.agw.ribbon.control.RibbonControl.html" title="Base class for all the Ribbon stuff." alt="" coords="1187,5,1365,35"/> <area shape="rect" id="node2" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="756,5,831,35"/> <area shape="rect" id="node4" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="559,5,639,35"/> <area shape="rect" id="node6" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="383,5,481,35"/> <area shape="rect" id="node8" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="193,31,265,62"/> <area shape="rect" id="node23" href="Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="396,58,468,89"/> <area shape="rect" id="node10" href="lib.agw.ribbon.gallery.RibbonGalleryEvent.html" title="Handles events related to RibbonGallery." alt="" coords="921,58,1137,89"/> <area shape="rect" id="node13" href="CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="531,58,667,89"/> <area shape="rect" id="node15" href="lib.agw.ribbon.gallery.RibbonGallery.html" title="A ribbon gallery is like a ListBox, but for bitmaps rather than strings." alt="" coords="1415,5,1591,35"/> <area shape="rect" id="node21" href="lib.agw.ribbon.gallery.RibbonGalleryItem.html" title="gallery.RibbonGalleryItem" alt="" coords="125,85,333,115"/> </map> 
   </p>

|


|class_summary| Classes Summary
===============================

================================================================================ ================================================================================
:ref:`lib.agw.ribbon.gallery.RibbonGallery`                                      A ribbon gallery is like a :class:`ListBox`, but for bitmaps rather than strings.
:ref:`lib.agw.ribbon.gallery.RibbonGalleryEvent`                                 Handles events related to :class:`RibbonGallery`.
:ref:`lib.agw.ribbon.gallery.RibbonGalleryItem`                                  
================================================================================ ================================================================================


|


.. toctree::
   :maxdepth: 1
   :hidden:

   lib.agw.ribbon.gallery.RibbonGallery
   lib.agw.ribbon.gallery.RibbonGalleryEvent
   lib.agw.ribbon.gallery.RibbonGalleryItem