View Source wxGraphicsGradientStops (wx v2.4.2)
Represents a collection of wxGraphicGradientStop 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.
Since: 2.9.1
wxWidgets docs: wxGraphicsGradientStops
Summary
Functions
Add a new stop.
Destroys the object.
Returns the number of stops.
Returns the end colour.
Returns the start colour.
Returns the stop at the given index.
Initializes the gradient stops with the given boundary colours.
Set the end colour to col.
Set the start colour to col.
Types
-type wxGraphicsGradientStops() :: wx:wx_object().
Functions
-spec add(This, Col, Pos) -> ok when This :: wxGraphicsGradientStops(), Col :: wx:wx_colour(), Pos :: number().
Add a new stop.
-spec destroy(This :: wxGraphicsGradientStops()) -> ok.
Destroys the object.
-spec getCount(This) -> integer() when This :: wxGraphicsGradientStops().
Returns the number of stops.
-spec getEndColour(This) -> wx:wx_colour4() when This :: wxGraphicsGradientStops().
Returns the end colour.
-spec getStartColour(This) -> wx:wx_colour4() when This :: wxGraphicsGradientStops().
Returns the start colour.
-spec item(This, N) -> {wx:wx_colour4(), float()} when This :: wxGraphicsGradientStops(), N :: integer().
Returns the stop at the given index.
-spec new() -> wxGraphicsGradientStops().
-spec new([Option]) -> wxGraphicsGradientStops() when Option :: {startCol, wx:wx_colour()} | {endCol, wx:wx_colour()}.
Initializes the gradient stops with the given boundary colours.
Creates a wxGraphicsGradientStops instance with start colour given by
startCol and end colour given by endCol.
-spec setEndColour(This, Col) -> ok when This :: wxGraphicsGradientStops(), Col :: wx:wx_colour().
Set the end colour to col.
-spec setStartColour(This, Col) -> ok when This :: wxGraphicsGradientStops(), Col :: wx:wx_colour().
Set the start colour to col.