1wxGraphicsGradientStops(3) Erlang Module Definition wxGraphicsGradientStops(3)
2
3
4

NAME

6       wxGraphicsGradientStops  -  Represents  a collection of wxGraphicGradi‐
7       entStop values for use with CreateLinearGradientBrush and CreateRadial‐
8       GradientBrush.
9

DESCRIPTION

11       The stops are maintained in order of position. If two or more stops are
12       added with the same position then the one(s) added  later  come  later.
13       This  can  be useful for producing discontinuities in the colour gradi‐
14       ent.
15
16       Notice that this class is write-once, you can't modify the  stops  once
17       they had been added.
18
19       Since: 2.9.1
20
21       wxWidgets docs: wxGraphicsGradientStops
22

DATA TYPES

24       wxGraphicsGradientStops() = wx:wx_object()
25

EXPORTS

27       new() -> wxGraphicsGradientStops()
28
29       new(Options :: [Option]) -> wxGraphicsGradientStops()
30
31              Types:
32
33                 Option    =    {startCol,    wx:wx_colour()}    |    {endCol,
34                 wx:wx_colour()}
35
36              Initializes the gradient stops with the given boundary colours.
37
38              Creates a wxGraphicsGradientStops  instance  with  start  colour
39              given by startCol and end colour given by endCol.
40
41       item(This, N) -> {wx:wx_colour4(), float()}
42
43              Types:
44
45                 This = wxGraphicsGradientStops()
46                 N = integer()
47
48              Returns the stop at the given index.
49
50       getCount(This) -> integer()
51
52              Types:
53
54                 This = wxGraphicsGradientStops()
55
56              Returns the number of stops.
57
58       setStartColour(This, Col) -> ok
59
60              Types:
61
62                 This = wxGraphicsGradientStops()
63                 Col = wx:wx_colour()
64
65              Set the start colour to col.
66
67       getStartColour(This) -> wx:wx_colour4()
68
69              Types:
70
71                 This = wxGraphicsGradientStops()
72
73              Returns the start colour.
74
75       setEndColour(This, Col) -> ok
76
77              Types:
78
79                 This = wxGraphicsGradientStops()
80                 Col = wx:wx_colour()
81
82              Set the end colour to col.
83
84       getEndColour(This) -> wx:wx_colour4()
85
86              Types:
87
88                 This = wxGraphicsGradientStops()
89
90              Returns the end colour.
91
92       add(This, Col, Pos) -> ok
93
94              Types:
95
96                 This = wxGraphicsGradientStops()
97                 Col = wx:wx_colour()
98                 Pos = number()
99
100              Add a new stop.
101
102       destroy(This :: wxGraphicsGradientStops()) -> ok
103
104              Destroys the object.
105
106
107
108wxWidgets team.                     wx 2.1          wxGraphicsGradientStops(3)