.. 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.colourchooser.pycolourbox
.. highlight:: python
.. _wx.lib.colourchooser.pycolourbox.PyColourBox:
==========================================================================================================================================
|phoenix_title| **wx.lib.colourchooser.pycolourbox.PyColourBox**
==========================================================================================================================================
A Colour Selection Box
The Colour selection box implements button like behavior but contains
a solid-filled, coloured sub-box. Placing the colour in a sub-box allows
for filling in the main panel's background for a high-lighting effect.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
PyColourBox:
|
|super_classes| Known Superclasses
==================================
:class:`wx.Panel`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.__init__` Creates a new colour box instance and initializes the colour
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.GetColour` Returns a wxColour object indicating the box's current colour.
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.GetColourBox` Returns a reference to the internal box object containing the
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.SetColour` Accepts a wxColour object and sets the box's current color.
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.SetColourTuple` Sets the box's current couple to the given tuple.
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.SetHighlight` Accepts a boolean 'val' toggling the box's highlighting.
:meth:`~wx.lib.colourchooser.pycolourbox.PyColourBox.Update` Update() -> None
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: PyColourBox(wx.Panel)
A Colour Selection Box
The Colour selection box implements button like behavior but contains
a solid-filled, coloured sub-box. Placing the colour in a sub-box allows
for filling in the main panel's background for a high-lighting effect.
.. method:: __init__(self, parent, id, colour=(0, 0, 0), size=(25, 20))
Creates a new colour box instance and initializes the colour
content.
.. method:: GetColour(self)
Returns a wxColour object indicating the box's current colour.
.. method:: GetColourBox(self)
Returns a reference to the internal box object containing the
color. This function is useful for setting up event handlers for
the box.
.. method:: SetColour(self, colour)
Accepts a wxColour object and sets the box's current color.
.. method:: SetColourTuple(self, colour)
Sets the box's current couple to the given tuple.
.. method:: SetHighlight(self, val)
Accepts a boolean 'val' toggling the box's highlighting.
.. method:: Update(self)
Update() -> None
Calling this method immediately repaints the invalidated area of the
window and all of its children recursively (this normally only happens
when the flow of control returns to the event loop).