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

.. currentmodule:: wx.lib.floatcanvas.Utilities.GUI

.. highlight:: python



.. _wx.lib.floatcanvas.Utilities.GUI.RubberBandBox:

==========================================================================================================================================
|phoenix_title|  **wx.lib.floatcanvas.Utilities.GUI.RubberBandBox**
==========================================================================================================================================

Class to provide a GUI Mode that makes a rubber band box that can be drawn on a Window



|

|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>RubberBandBox</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.floatcanvas.Utilities.GUI.RubberBandBox_inheritance.svg" alt="Inheritance diagram of RubberBandBox" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.floatcanvas.Utilities.GUI.RubberBandBox.html" title="Class to provide a GUI Mode that makes a rubber band box that can be drawn on a Window" alt="" coords="5,82,372,111"/> <area shape="rect" id="node2" href="wx.lib.floatcanvas.GUIMode.GUIBase.html" title="Basic Mouse mode and baseclass for other GUImode." alt="" coords="41,5,337,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.lib.floatcanvas.GUIMode.GUIBase`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.floatcanvas.Utilities.GUI.RubberBandBox.__init__`                 Default class constructor.
:meth:`~wx.lib.floatcanvas.Utilities.GUI.RubberBandBox.OnLeftDown`               
:meth:`~wx.lib.floatcanvas.Utilities.GUI.RubberBandBox.OnLeftUp`                 
:meth:`~wx.lib.floatcanvas.Utilities.GUI.RubberBandBox.OnMove`                   
================================================================================ ================================================================================


|


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


.. class:: RubberBandBox(GUIMode.GUIBase)

   Class to provide a GUI Mode that makes a rubber band box that can be drawn on a Window

   .. method:: __init__(self, CallBack, Tol=5)

      Default class constructor.
      
      :param `CallBack`: is the method you want called when the mouse is
                released. That method will be called, passing in a rect
                parameter, where rect is: (Point, WH) of the rect in
                world coords.
      :param `Tol`: The tolerance for the smallest rectangle allowed. defaults
                to 5. In pixels


   .. method:: OnLeftDown(self, event)


   .. method:: OnLeftUp(self, event)


   .. method:: OnMove(self, event)