oracular (3) wxGraphicsGradientStops.3erl.gz

NAME

       wxGraphicsGradientStops   -  Represents  a  collection  of  wxGraphicGradientStop  values  for  use  with
       CreateLinearGradientBrush and CreateRadialGradientBrush.

DESCRIPTION

       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

DATA TYPES

       wxGraphicsGradientStops() = wx:wx_object()

EXPORTS

       new() -> wxGraphicsGradientStops()

       new(Options :: [Option]) -> wxGraphicsGradientStops()

              Types:

                 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.

       item(This, N) -> {wx:wx_colour4(), float()}

              Types:

                 This = wxGraphicsGradientStops()
                 N = integer()

              Returns the stop at the given index.

       getCount(This) -> integer()

              Types:

                 This = wxGraphicsGradientStops()

              Returns the number of stops.

       setStartColour(This, Col) -> ok

              Types:

                 This = wxGraphicsGradientStops()
                 Col = wx:wx_colour()

              Set the start colour to col.

       getStartColour(This) -> wx:wx_colour4()

              Types:

                 This = wxGraphicsGradientStops()

              Returns the start colour.

       setEndColour(This, Col) -> ok

              Types:

                 This = wxGraphicsGradientStops()
                 Col = wx:wx_colour()

              Set the end colour to col.

       getEndColour(This) -> wx:wx_colour4()

              Types:

                 This = wxGraphicsGradientStops()

              Returns the end colour.

       add(This, Col, Pos) -> ok

              Types:

                 This = wxGraphicsGradientStops()
                 Col = wx:wx_colour()
                 Pos = number()

              Add a new stop.

       destroy(This :: wxGraphicsGradientStops()) -> ok

              Destroys the object.