Phoenix Logo

phoenix_title wx.GraphicsGradientStops

Represents a collection of GraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush.

The stops are maintained in order of position. If two or more stops are added with the same position then the one(s) added later come later. This can be useful for producing discontinuities in the colour gradient.

Notice that this class is write-once, you can’t modify the stops once they had been added.

New in version 2.9.1.


class_hierarchy Class Hierarchy

Inheritance diagram for class GraphicsGradientStops:


method_summary Methods Summary

__init__ Initializes the gradient stops with the given boundary colours.
Add Add a new stop.
GetCount Returns the number of stops.
GetEndColour Returns the end colour.
GetStartColour Returns the start colour.
Item Returns the stop at the given index.
SetEndColour Set the end colour to col.
SetStartColour Set the start colour to col.
__getitem__  
__len__  

api Class API



class wx.GraphicsGradientStops(object)

Possible constructors:

GraphicsGradientStops(startCol=TransparentColour,
                      endCol=TransparentColour)

Represents a collection of GraphicGradientStop values for use with CreateLinearGradientBrush and CreateRadialGradientBrush.


Methods



__init__(self, startCol=TransparentColour, endCol=TransparentColour)

Initializes the gradient stops with the given boundary colours.

Creates a wx.GraphicsGradientStops instance with start colour given by startCol and end colour given by endCol.

Parameters:


Add(self, *args, **kw)

Add a new stop.

overload Overloaded Implementations:



Add (self, stop)

Parameters:stop (wx.GraphicsGradientStop) –



Add (self, col, pos)

Parameters:





GetCount(self)

Returns the number of stops.

Return type:int


GetEndColour(self)

Returns the end colour.

Return type: wx.Colour


GetStartColour(self)

Returns the start colour.

Return type: wx.Colour


Item(self, n)

Returns the stop at the given index.

Parameters:n – The index, must be in [0, GetCount ) range.
Return type: wx.GraphicsGradientStop


SetEndColour(self, col)

Set the end colour to col.

Parameters:col (wx.Colour) –


SetStartColour(self, col)

Set the start colour to col.

Parameters:col (wx.Colour) –


__getitem__(self, n)


__len__(self)
Return type:SIP_SSIZE_T

Properties



Count

See GetCount



EndColour

See GetEndColour and SetEndColour



StartColour

See GetStartColour and SetStartColour