File: wx.lib.agw.cubecolourdialog.ColourPanel.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (145 lines) | stat: -rw-r--r-- 5,747 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 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.png" alt="Inheritance diagram of ColourPanel" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Panel.html" title="wx.Panel" alt="" coords="105,315,180,344"/> <area shape="rect" id="node7" href="wx.lib.agw.cubecolourdialog.ColourPanel.html" title="wx.lib.agw.cubecolourdialog.ColourPanel" alt="" coords="5,392,280,421"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="98,237,187,267"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="35,5,136,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="87,83,197,112"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="82,160,203,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="160,5,241,35"/> </map> 
   </p>

|


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