.. include:: headings.inc

.. currentmodule:: lib.floatbar

.. highlight:: python



.. _lib.floatbar.FloatBar:

==========================================================================================================================================
|phoenix_title|  **FloatBar**
==========================================================================================================================================

wxToolBar subclass which can be dragged off its frame and later
replaced there.  Drag on the toolbar to release it, close it like
a normal window to make it return to its original
position. Programmatically, call SetFloatable(True) and then
Float(True) to float, Float(False) to dock.



|

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

Inheritance diagram for class **FloatBar**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.floatbar.FloatBar_inheritance.png" alt="Inheritance diagram of FloatBar" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="Control.html" title="This is the base class for a control or 'widget'." alt="" coords="525,5,600,35"/> <area shape="rect" id="node2" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="396,5,476,35"/> <area shape="rect" id="node4" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="247,5,345,35"/> <area shape="rect" id="node6" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,5,197,35"/> <area shape="rect" id="node8" href="lib.floatbar.FloatBar.html" title="wxToolBar subclass which can be dragged off its frame and later" alt="" coords="940,5,1081,35"/> <area shape="rect" id="node9" href="ToolBar.html" title="A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a Frame." alt="" coords="812,5,889,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`ToolBar`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.floatbar.FloatBar.__init__`                                          In addition to the usual arguments, wxFloatBar accepts keyword
:meth:`~lib.floatbar.FloatBar.Float`                                             Floats or docks the toolbar programmatically.
:meth:`~lib.floatbar.FloatBar.GetTitle`                                          
:meth:`~lib.floatbar.FloatBar.IsFloatable`                                       
:meth:`~lib.floatbar.FloatBar.IsFloating`                                        
:meth:`~lib.floatbar.FloatBar.OnDock`                                            
:meth:`~lib.floatbar.FloatBar.OnMouse`                                           
:meth:`~lib.floatbar.FloatBar.OnMove`                                            
:meth:`~lib.floatbar.FloatBar.Realize`                                           
:meth:`~lib.floatbar.FloatBar.SetFloatable`                                      
:meth:`~lib.floatbar.FloatBar.SetTitle`                                          
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: FloatBar(ToolBar)

   wxToolBar subclass which can be dragged off its frame and later
   replaced there.  Drag on the toolbar to release it, close it like
   a normal window to make it return to its original
   position. Programmatically, call SetFloatable(True) and then
   Float(True) to float, Float(False) to dock.

   .. method:: __init__(self,\*_args,\*\*_kwargs)

      In addition to the usual arguments, wxFloatBar accepts keyword
      args of: title(string): the title that should appear on the
      toolbar's frame when it is floating.  floatable(bool): whether
      user actions (i.e., dragging) can float the toolbar or not.


   .. method:: Float(self, bool)

      Floats or docks the toolbar programmatically.


   .. method:: GetTitle(self)


   .. method:: IsFloatable(self)


   .. method:: IsFloating(self)


   .. method:: OnDock(self, e)


   .. method:: OnMouse(self, e)


   .. method:: OnMove(self, e)


   .. method:: Realize(self)


   .. method:: SetFloatable(self, float)


   .. method:: SetTitle(self, title)