File: wx.lib.agw.cubecolourdialog.Colour.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 (105 lines) | stat: -rw-r--r-- 3,759 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
.. 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.Colour:

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

This is a subclass of :class:`wx.Colour`, which adds Hue, Saturation and Brightness
capability to the base class. It contains also methods to convert RGB triplets
into HSB triplets and vice-versa.



|

|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>Colour</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.Colour_inheritance.png" alt="Inheritance diagram of Colour" 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.lib.agw.cubecolourdialog.Colour.html" title="wx.lib.agw.cubecolourdialog.Colour" alt="" coords="5,160,245,189"/> <area shape="rect" id="node2" href="wx.Colour.html" title="wx.Colour" alt="" coords="84,83,165,112"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="84,5,165,35"/> </map> 
   </p>

|


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

:class:`wx.Colour`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.agw.cubecolourdialog.Colour.__init__`                             Default class constructor.
:meth:`~wx.lib.agw.cubecolourdialog.Colour.GetPyColour`                          Returns the wxPython :class:`wx.Colour` associated with this instance.
:meth:`~wx.lib.agw.cubecolourdialog.Colour.ToHSV`                                Converts a RGB triplet into a HSV triplet.
:meth:`~wx.lib.agw.cubecolourdialog.Colour.ToRGB`                                Converts a HSV triplet into a RGB triplet.
================================================================================ ================================================================================


|


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


.. class:: Colour(wx.Colour)

   This is a subclass of :class:`wx.Colour`, which adds Hue, Saturation and Brightness
   capability to the base class. It contains also methods to convert RGB triplets
   into HSB triplets and vice-versa.

   .. method:: __init__(self, colour)

      Default class constructor.
      
      :param `colour`: a standard :class:`wx.Colour`.


   .. method:: GetPyColour(self)

      Returns the wxPython :class:`wx.Colour` associated with this instance. 


   .. method:: ToHSV(self)

      Converts a RGB triplet into a HSV triplet. 


   .. method:: ToRGB(self)

      Converts a HSV triplet into a RGB triplet.