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

==========================================================================================================================================
|phoenix_title|  **wx.lib.agw.cubecolourdialog.ColourPanel**
==========================================================================================================================================

Simple custom class used to display "old" and "new" colour panels, with alpha
blending capabilities.



|

|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>ColourPanel</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.agw.cubecolourdialog.ColourPanel_inheritance.svg" alt="Inheritance diagram of ColourPanel" 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.agw.cubecolourdialog.ColourPanel.html" title="Simple custom class used to display 'old' and 'new' colour panels, with alpha" alt="" coords="5,389,329,418"/> <area shape="rect" id="node2" href="wx.Panel.html" title="A panel is a window on which controls are placed." alt="" coords="120,313,215,341"/> <area shape="rect" id="node3" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="112,236,223,265"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="93,159,241,188"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="101,82,234,111"/> <area shape="rect" id="node6" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="51,5,150,34"/> <area shape="rect" id="node7" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="174,5,297,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.Panel`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.__init__`                        Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.AcceptsFocus`                    Can this window be given focus by mouse click?
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.AcceptsFocusFromKeyboard`        Can this window be given focus by keyboard navigation? If not, the
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.OnEraseBackground`               Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`wx.ColourPanel`.
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.OnPaint`                         Handles the ``wx.EVT_PAINT`` for :class:`wx.ColourPanel`.
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.OnSize`                          Handles the ``wx.EVT_SIZE`` for :class:`wx.ColourPanel`.
:meth:`~wx.lib.agw.cubecolourdialog.ColourPanel.RefreshColour`                   Refresh the panel after a colour/alpha change.
================================================================================ ================================================================================


|


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


.. class:: ColourPanel(wx.Panel)

   Simple custom class used to display "old" and "new" colour panels, with alpha
   blending capabilities.

   .. method:: __init__(self, parent, style=wx.SIMPLE_BORDER)

      Default class constructor.
      Used internally. Do not call it in your code!
      
      :param `parent`: the control parent window;
      :param `style`: the :class:`wx.ColourPanel` window style.


   .. 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:`Panel`.


   .. 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:`Panel`.


   .. method:: OnEraseBackground(self, event)

      Handles the ``wx.EVT_ERASE_BACKGROUND`` for :class:`wx.ColourPanel`.
      
      :param `event`: a :class:`EraseEvent` event to be processed.
      
      .. note:: This is intentionally empty to reduce flicker.


   .. method:: OnPaint(self, event)

      Handles the ``wx.EVT_PAINT`` for :class:`wx.ColourPanel`.
      
      :param `event`: a :class:`PaintEvent` event to be processed.


   .. method:: OnSize(self, event)

      Handles the ``wx.EVT_SIZE`` for :class:`wx.ColourPanel`.
      
      :param `event`: a :class:`wx.SizeEvent` event to be processed.


   .. method:: RefreshColour(self, colour)

      Refresh the panel after a colour/alpha change.
      
      :param `colour`: the new background colour of :class:`wx.ColourPanel`.