.. 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.agw.cubecolourdialog
.. highlight:: python
.. _wx.lib.agw.cubecolourdialog.BasePyControl:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.cubecolourdialog.BasePyControl**
==========================================================================================================================================
Base class used to hold common code for the HSB colour wheel and the RGB
colour cube.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
BasePyControl:
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.cubecolourdialog.HSVWheel`, :class:`wx.lib.agw.cubecolourdialog.RGBCube`
|
|super_classes| Known Superclasses
==================================
:class:`wx.Control`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.__init__` Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.AcceptsFocus` Can this window be given focus by mouse click?
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.AcceptsFocusFromKeyboard` Can this window be given focus by keyboard navigation? If not, the
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DoGetBestSize` Overridden base class virtual. Determines the best size of the
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DrawLines` Draws the lines connecting the markers on top of the background bitmap.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.DrawMarkers` Draws the markers on top of the background bitmap.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnEraseBackground` Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnLeftDown` Handles the ``wx.EVT_LEFT_DOWN`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnLeftUp` Handles the ``wx.EVT_LEFT_UP`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnMotion` Handles the ``wx.EVT_MOTION`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnPaint` Handles the ``wx.EVT_PAINT`` for :class:`BasePyControl`.
:meth:`~wx.lib.agw.cubecolourdialog.BasePyControl.OnSize` Handles the ``wx.EVT_SIZE`` for :class:`BasePyControl`.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: BasePyControl(wx.Control)
Base class used to hold common code for the HSB colour wheel and the RGB
colour cube.
.. method:: __init__(self, parent, bitmap=None)
Default class constructor.
Used internally. Do not call it in your code!
:param `parent`: the control parent;
:param `bitmap`: the background bitmap for this custom control.
.. method:: AcceptsFocus(self)
Can this window be given focus by mouse click?
.. note:: This method always returns ``False`` as we do not accept focus from
mouse click.
.. note:: Overridden from :class:`wx.Control`.
.. method:: AcceptsFocusFromKeyboard(self)
Can this window be given focus by keyboard navigation? If not, the
only way to give it focus (provided it accepts it at all) is to click
it.
.. note:: This method always returns ``False`` as we do not accept focus from
the keyboard.
.. note:: Overridden from :class:`wx.Control`.
.. method:: DoGetBestSize(self)
Overridden base class virtual. Determines the best size of the
control based on the bitmap size.
.. note:: Overridden from :class:`wx.Control`.
.. method:: DrawLines(self, dc)
Draws the lines connecting the markers on top of the background bitmap.
:param `dc`: an instance of :class:`wx.DC`.
.. note:: This method must be overridden in derived classes.
.. method:: DrawMarkers(self, dc=None)
Draws the markers on top of the background bitmap.
:param `dc`: an instance of :class:`wx.DC`.
.. note:: This method must be overridden in derived classes.
.. method:: OnEraseBackground(self, event)
Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`BasePyControl`.
:param `event`: a :class:`EraseEvent` event to be processed.
.. note:: This is intentionally empty to reduce flicker.
.. method:: OnLeftDown(self, event)
Handles the ``wx.EVT_LEFT_DOWN`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. note:: This method must be overridden in derived classes.
.. method:: OnLeftUp(self, event)
Handles the ``wx.EVT_LEFT_UP`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. note:: This method must be overridden in derived classes.
.. method:: OnMotion(self, event)
Handles the ``wx.EVT_MOTION`` for :class:`BasePyControl`.
:param `event`: a :class:`MouseEvent` event to be processed.
.. note:: This method must be overridden in derived classes.
.. method:: OnPaint(self, event)
Handles the ``wx.EVT_PAINT`` for :class:`BasePyControl`.
:param `event`: a :class:`PaintEvent` event to be processed.
.. method:: OnSize(self, event)
Handles the ``wx.EVT_SIZE`` for :class:`BasePyControl`.
:param `event`: a :class:`wx.SizeEvent` event to be processed.