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

NAME

6       wxRegion - See external documentation: wxRegion.
7

DESCRIPTION

9       See external documentation: wxRegion.
10

DATA TYPES

12         wxRegion():
13
14
15           An  object  reference,  The  representation  is internal and can be
16           changed without notice. It can't be used for comparsion  stored  on
17           disc or distributed for use on other nodes.
18

EXPORTS

20       new() -> wxRegion()
21
22              See external documentation.
23
24       new(Bmp) -> wxRegion()
25       new(Rect) -> wxRegion()
26
27              Types:
28
29                 Bmp = wxBitmap:wxBitmap()
30                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
31                 ger()}
32
33              See external documentation.
34              Also:
35              new(Rect) -> wxRegion() when
36              Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.
37
38
39       new(TopLeft, BottomRight) -> wxRegion()
40
41              Types:
42
43                 TopLeft = {X::integer(), Y::integer()}
44                 BottomRight = {X::integer(), Y::integer()}
45
46              See external documentation.
47
48       new(X, Y, W, H) -> wxRegion()
49
50              Types:
51
52                 X = integer()
53                 Y = integer()
54                 W = integer()
55                 H = integer()
56
57              See external documentation.
58
59       clear(This) -> ok
60
61              Types:
62
63                 This = wxRegion()
64
65              See external documentation.
66
67       contains(This, Pt) -> wx:wx_enum()
68       contains(This, Rect) -> wx:wx_enum()
69
70              Types:
71
72                 This = wxRegion()
73                 Pt = {X::integer(), Y::integer()}
74                 This = wxRegion()
75                 Rect = {X::integer(),  Y::integer(),  W::integer(),  H::inte‐
76                 ger()}
77
78              See external documentation.
79              Also:
80              contains(This, Rect) -> wx:wx_enum() when
81              This::wxRegion(),  Rect::{X::integer(),  Y::integer(),  W::inte‐
82              ger(), H::integer()}.
83
84
85              Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion
86
87       contains(This, X, Y) -> wx:wx_enum()
88
89              Types:
90
91                 This = wxRegion()
92                 X = integer()
93                 Y = integer()
94
95              See external documentation.
96              Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion
97
98       contains(This, X, Y, W, H) -> wx:wx_enum()
99
100              Types:
101
102                 This = wxRegion()
103                 X = integer()
104                 Y = integer()
105                 W = integer()
106                 H = integer()
107
108              See external documentation.
109              Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion
110
111       convertToBitmap(This) -> wxBitmap:wxBitmap()
112
113              Types:
114
115                 This = wxRegion()
116
117              See external documentation.
118
119       getBox(This) ->  {X::integer(),  Y::integer(),  W::integer(),  H::inte‐
120       ger()}
121
122              Types:
123
124                 This = wxRegion()
125
126              See external documentation.
127
128       intersect(This, Region) -> boolean()
129       intersect(This, Rect) -> boolean()
130
131              Types:
132
133                 This = wxRegion()
134                 Region = wxRegion()
135                 This = wxRegion()
136                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
137                 ger()}
138
139              See external documentation.
140              Also:
141              intersect(This, Rect) -> boolean() when
142              This::wxRegion(),  Rect::{X::integer(),  Y::integer(),  W::inte‐
143              ger(), H::integer()}.
144
145
146       intersect(This, X, Y, W, H) -> boolean()
147
148              Types:
149
150                 This = wxRegion()
151                 X = integer()
152                 Y = integer()
153                 W = integer()
154                 H = integer()
155
156              See external documentation.
157
158       isEmpty(This) -> boolean()
159
160              Types:
161
162                 This = wxRegion()
163
164              See external documentation.
165
166       subtract(This, Region) -> boolean()
167       subtract(This, Rect) -> boolean()
168
169              Types:
170
171                 This = wxRegion()
172                 Region = wxRegion()
173                 This = wxRegion()
174                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
175                 ger()}
176
177              See external documentation.
178              Also:
179              subtract(This, Rect) -> boolean() when
180              This::wxRegion(),  Rect::{X::integer(),  Y::integer(),  W::inte‐
181              ger(), H::integer()}.
182
183
184       subtract(This, X, Y, W, H) -> boolean()
185
186              Types:
187
188                 This = wxRegion()
189                 X = integer()
190                 Y = integer()
191                 W = integer()
192                 H = integer()
193
194              See external documentation.
195
196       offset(This, Pt) -> boolean()
197
198              Types:
199
200                 This = wxRegion()
201                 Pt = {X::integer(), Y::integer()}
202
203              See external documentation.
204
205       offset(This, X, Y) -> boolean()
206
207              Types:
208
209                 This = wxRegion()
210                 X = integer()
211                 Y = integer()
212
213              See external documentation.
214
215       union(This, Region) -> boolean()
216       union(This, Rect) -> boolean()
217
218              Types:
219
220                 This = wxRegion()
221                 Region = wxRegion() | wxBitmap:wxBitmap()
222                 This = wxRegion()
223                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
224                 ger()}
225
226              See external documentation.
227              Also:
228              union(This, Rect) -> boolean() when
229              This::wxRegion(),  Rect::{X::integer(),  Y::integer(),  W::inte‐
230              ger(), H::integer()}.
231
232
233       union(This, Bmp, Transp) -> boolean()
234
235              Types:
236
237                 This = wxRegion()
238                 Bmp = wxBitmap:wxBitmap()
239                 Transp = wx:wx_colour()
240
241              Equivalent to union(This, Bmp, Transp, []).
242
243       union(This, Bmp, Transp, Options::[Option]) -> boolean()
244
245              Types:
246
247                 This = wxRegion()
248                 Bmp = wxBitmap:wxBitmap()
249                 Transp = wx:wx_colour()
250                 Option = {tolerance, integer()}
251
252              See external documentation.
253
254       union(This, X, Y, W, H) -> boolean()
255
256              Types:
257
258                 This = wxRegion()
259                 X = integer()
260                 Y = integer()
261                 W = integer()
262                 H = integer()
263
264              See external documentation.
265
266       Xor(This, Region) -> boolean()
267       Xor(This, Rect) -> boolean()
268
269              Types:
270
271                 This = wxRegion()
272                 Region = wxRegion()
273                 This = wxRegion()
274                 Rect  =  {X::integer(),  Y::integer(), W::integer(), H::inte‐
275                 ger()}
276
277              See external documentation.
278              Also:
279              'Xor'(This, Rect) -> boolean() when
280              This::wxRegion(),  Rect::{X::integer(),  Y::integer(),  W::inte‐
281              ger(), H::integer()}.
282
283
284       Xor(This, X, Y, W, H) -> boolean()
285
286              Types:
287
288                 This = wxRegion()
289                 X = integer()
290                 Y = integer()
291                 W = integer()
292                 H = integer()
293
294              See external documentation.
295
296       destroy(This::wxRegion()) -> ok
297
298              Destroys this object, do not use object again
299

AUTHORS

301       <>
302
303
304
305                                   wx 1.9.3                        wxRegion(3)