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

.. module:: wx.lib.agw.ribbon.buttonbar

.. currentmodule:: wx.lib.agw.ribbon.buttonbar

.. highlight:: python



.. _wx.lib.agw.ribbon.buttonbar:

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.ribbon.buttonbar**
==========================================================================================================================================

A ribbon button bar is similar to a traditional toolbar.


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

It contains one or more buttons (button bar buttons, not :class:`Button`), each of which
has a label and an icon. It differs from a :class:`toolbar` in several ways:

- Individual buttons can grow and contract.
- Buttons have labels as well as bitmaps.
- Bitmaps are typically larger (at least 32x32 pixels) on a button bar compared to
  a tool bar (which typically has 16x15).
- There is no grouping of buttons on a button bar
- A button bar typically has a border around each individual button, whereas a tool
  bar typically has a border around each group of buttons.


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

This class processes the following events:

======================================== ========================================
Event Name                               Description
======================================== ========================================
``EVT_RIBBONBUTTONBAR_CLICKED``          Triggered when the normal (non-dropdown) region of a button on the button bar is clicked.
``EVT_RIBBONBUTTONBAR_DROPDOWN_CLICKED`` Triggered when the dropdown region of a button on the button bar is clicked. :meth:`RibbonButtonBarEvent.PopupMenu() <RibbonButtonBarEvent.PopupMenu>` should be called by the event handler if it wants to display a popup menu (which is what most dropdown buttons should be doing).
======================================== ========================================


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

================================================================================ ================================================================================
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBar`                                   A ribbon button bar is similar to a traditional toolbar.
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonBase`                         
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonInstance`                     
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonSizeInfo`                     
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBarEvent`                              Event used to indicate various actions relating to a button on a :class:`RibbonButtonBar`.
`~wx.lib.agw.ribbon.buttonbar.RibbonButtonBarLayout`                             
================================================================================ ================================================================================


|


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

   wx.lib.agw.ribbon.buttonbar.RibbonButtonBar
   wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonBase
   wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonInstance
   wx.lib.agw.ribbon.buttonbar.RibbonButtonBarButtonSizeInfo
   wx.lib.agw.ribbon.buttonbar.RibbonButtonBarEvent
   wx.lib.agw.ribbon.buttonbar.RibbonButtonBarLayout