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

Inheritance diagram for class
RubberBandBox:
|
|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)