Package wx :: Class ColourData
[frames | no frames]

Type ColourData

object --+    
         |    
    Object --+
             |
            ColourData


This class holds a variety of information related to the colour chooser dialog, used to transfer settings and results to and from the wx.ColourDialog.


Method Summary
ColourData __init__(self)
Constructor, sets default values.
  __del__(self)
  __repr__(self)
bool GetChooseFull(self)
Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
Colour GetColour(self)
Gets the colour (pre)selected by the dialog.
Colour GetCustomColour(self, i)
Gets the i'th custom colour associated with the colour dialog.
  SetChooseFull(self, flag)
Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
  SetColour(self, colour)
Sets the default colour for the colour dialog.
  SetCustomColour(self, i, colour)
Sets the i'th custom colour for the colour dialog.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self)
(Constructor)

Constructor, sets default values.

Returns:
ColourData
Overrides:
wx.Object.__init__

GetChooseFull(self)

Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. Has no meaning under other platforms. The default value is true.

Returns:
bool

GetColour(self)

Gets the colour (pre)selected by the dialog.

Returns:
Colour

GetCustomColour(self, i)

Gets the i'th custom colour associated with the colour dialog. i should be an integer between 0 and 15. The default custom colours are all invalid colours.

Parameters:
i
           (type=int)

Returns:
Colour

SetChooseFull(self, flag)

Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. Under other platforms, has no effect. The default value is true.

Parameters:
flag
           (type=int)

SetColour(self, colour)

Sets the default colour for the colour dialog. The default colour is black.

Parameters:
colour
           (type=Colour)

SetCustomColour(self, i, colour)

Sets the i'th custom colour for the colour dialog. i should be an integer between 0 and 15. The default custom colours are all invalid colours.

Parameters:
i
           (type=int)

colour
           (type=Colour)


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:48:47 2007 http://epydoc.sf.net