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

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

Implements the drawing, mouse handling and sizing routines for the alpha
channel control.



|

|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>AlphaCtrl</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.AlphaCtrl_inheritance.svg" alt="Inheritance diagram of AlphaCtrl" 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.AlphaCtrl.html" title="Implements the drawing, mouse handling and sizing routines for the alpha" alt="" coords="18,466,319,495"/> <area shape="rect" id="node2" href="wx.lib.agw.cubecolourdialog.BaseLineCtrl.html" title="Base class used to hold common code for the Alpha channel control and the" alt="" coords="5,389,332,418"/> <area shape="rect" id="node3" href="wx.Control.html" title="This is the base class for a control or 'widget'." alt="" coords="116,313,221,341"/> <area shape="rect" id="node4" href="wx.Window.html" title="wx.Window  is the base class for all windows and represents any visible object on screen." alt="" coords="113,236,224,265"/> <area shape="rect" id="node5" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="95,159,243,188"/> <area shape="rect" id="node6" href="wx.EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="102,82,235,111"/> <area shape="rect" id="node7" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="53,5,151,34"/> <area shape="rect" id="node8" href="wx.Trackable.html" title="Add-on base class for a trackable object." alt="" coords="175,5,298,34"/> </map> 
   </p>
   </div>

|


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

:class:`wx.lib.agw.cubecolourdialog.BaseLineCtrl`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.AlphaCtrl.__init__`                          Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.AlphaCtrl.DrawAlphaShading`                  Draws the alpha shading on top of the checkerboard.
:meth:`~wx.lib.agw.cubecolourdialog.AlphaCtrl.DrawMarkers`                       Draws square markers used with mouse gestures.
:meth:`~wx.lib.agw.cubecolourdialog.AlphaCtrl.OnPaint`                           Handles the ``wx.EVT_PAINT`` for :class:`AlphaCtrl`.
:meth:`~wx.lib.agw.cubecolourdialog.AlphaCtrl.TrackPoint`                        Tracks a mouse action inside the Alpha channel control.
================================================================================ ================================================================================


|


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


.. class:: AlphaCtrl(BaseLineCtrl)

   Implements the drawing, mouse handling and sizing routines for the alpha
   channel control.

   .. method:: __init__(self, parent)

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


   .. method:: DrawAlphaShading(self, dc, rect)

      Draws the alpha shading on top of the checkerboard.
      
      :param `dc`: an instance of :class:`wx.DC`;
      :param `rect`: the :class:`AlphaCtrl` client rectangle.


   .. method:: DrawMarkers(self, dc=None)

      Draws square markers used with mouse gestures.
      
      :param `dc`: an instance of :class:`wx.DC`.


   .. method:: OnPaint(self, event)

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


   .. method:: TrackPoint(self, pt)

      Tracks a mouse action inside the Alpha channel control.
      
      :param `pt`: an instance of :class:`wx.Point`.