.. wxPython Phoenix documentation

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

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

.. include:: headings.inc

.. currentmodule:: wx.lib.floatbar

.. highlight:: python



.. _wx.lib.floatbar.FloatBar:

==========================================================================================================================================
|phoenix_title|  **wx.lib.floatbar.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| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>FloatBar</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.floatbar.FloatBar_inheritance.png" alt="Inheritance diagram of FloatBar" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="71,237,160,267"/> <area shape="rect" id="node6" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="71,315,159,344"/> <area shape="rect" id="node2" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="55,160,176,189"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="59,83,171,112"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="5,5,108,35"/> <area shape="rect" id="node5" href="wx.ToolBar.html" title="A toolbar is a bar of buttons and/or other controls usually placed below the menu bar in a wx.Frame." alt="" coords="70,392,161,421"/> <area shape="rect" id="node8" href="wx.lib.floatbar.FloatBar.html" title="wxToolBar subclass which can be dragged off its frame and later" alt="" coords="32,469,199,499"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="133,5,215,35"/> </map> 
   </p>

|


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

:class:`wx.ToolBar`

|


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

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


|


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


.. class:: FloatBar(wx.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)