.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. module:: wx.lib.agw.ribbon.toolbar

.. currentmodule:: wx.lib.agw.ribbon.toolbar

.. highlight:: python



.. _wx.lib.agw.ribbon.toolbar:

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

A ribbon tool bar is similar to a traditional toolbar which has no labels.


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

It contains one or more tool groups, each of which contains one or more tools.
Each tool is represented by a (generally small, i.e. 16x15) bitmap.


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

This class processes the following events:

====================================== ======================================
Event Name                             Description
====================================== ======================================
``EVT_RIBBONTOOLBAR_CLICKED``          Triggered when the normal (non-dropdown) region of a tool on the tool bar is clicked.
``EVT_RIBBONTOOLBAR_DROPDOWN_CLICKED`` Triggered when the dropdown region of a tool on the tool bar is clicked. LRibbonToolBarEvent.PopupMenu should be called by the event handler if it wants to display a popup menu (which is what most dropdown tools should be doing).
====================================== ======================================


|function_summary| Functions Summary
====================================

================================================================================ ================================================================================
:func:`~wx.lib.agw.ribbon.toolbar.GetSizeInOrientation`                          
================================================================================ ================================================================================


|


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

================================================================================ ================================================================================
`~wx.lib.agw.ribbon.toolbar.RibbonToolBar`                                       Base class for all the Ribbon stuff.
`~wx.lib.agw.ribbon.toolbar.RibbonToolBarEvent`                                  Handles events related to :class:`RibbonToolBar`.
`~wx.lib.agw.ribbon.toolbar.RibbonToolBarToolBase`                               
`~wx.lib.agw.ribbon.toolbar.RibbonToolBarToolGroup`                              
================================================================================ ================================================================================


|


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

   wx.lib.agw.ribbon.toolbar.RibbonToolBar
   wx.lib.agw.ribbon.toolbar.RibbonToolBarEvent
   wx.lib.agw.ribbon.toolbar.RibbonToolBarToolBase
   wx.lib.agw.ribbon.toolbar.RibbonToolBarToolGroup





Functions
------------

.. function:: GetSizeInOrientation(size, orientation)