Scroll to navigation

wxRegion(3erl) Erlang Module Definition wxRegion(3erl)

NAME

wxRegion - See external documentation: wxRegion.

DESCRIPTION

See external documentation: wxRegion.

DATA TYPES

wxRegion():

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxRegion()

See external documentation.

new(Bmp) -> wxRegion()

Types:

Bmp = wxBitmap:wxBitmap()

See external documentation.
Also:
new(Rect) -> wxRegion() when
Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

new(TopLeft, BottomRight) -> wxRegion()

Types:

TopLeft = {X::integer(), Y::integer()}
BottomRight = {X::integer(), Y::integer()}

See external documentation.

new(X, Y, W, H) -> wxRegion()

Types:

X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.

clear(This) -> ok

Types:

This = wxRegion()

See external documentation.

contains(This, Pt) -> wx:wx_enum()

Types:

This = wxRegion()
Pt = {X::integer(), Y::integer()}

See external documentation.
Also:
contains(This, Rect) -> wx:wx_enum() when
This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion

contains(This, X, Y) -> wx:wx_enum()

Types:

This = wxRegion()
X = integer()
Y = integer()

See external documentation.
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion

contains(This, X, Y, W, H) -> wx:wx_enum()

Types:

This = wxRegion()
X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.
Res = ?wxOutRegion | ?wxPartRegion | ?wxInRegion

convertToBitmap(This) -> wxBitmap:wxBitmap()

Types:

This = wxRegion()

See external documentation.

getBox(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()}

Types:

This = wxRegion()

See external documentation.

intersect(This, Region) -> boolean()

Types:

This = wxRegion()
Region = wxRegion()

See external documentation.
Also:
intersect(This, Rect) -> boolean() when
This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

intersect(This, X, Y, W, H) -> boolean()

Types:

This = wxRegion()
X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.

isEmpty(This) -> boolean()

Types:

This = wxRegion()

See external documentation.

subtract(This, Region) -> boolean()

Types:

This = wxRegion()
Region = wxRegion()

See external documentation.
Also:
subtract(This, Rect) -> boolean() when
This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

subtract(This, X, Y, W, H) -> boolean()

Types:

This = wxRegion()
X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.

offset(This, Pt) -> boolean()

Types:

This = wxRegion()
Pt = {X::integer(), Y::integer()}

See external documentation.

offset(This, X, Y) -> boolean()

Types:

This = wxRegion()
X = integer()
Y = integer()

See external documentation.

union(This, Region) -> boolean()

Types:

This = wxRegion()
Region = wxRegion() | wxBitmap:wxBitmap()

See external documentation.
Also:
union(This, Rect) -> boolean() when
This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

union(This, Bmp, Transp) -> boolean()

Types:

This = wxRegion()
Bmp = wxBitmap:wxBitmap()
Transp = wx:wx_colour()

Equivalent to union(This, Bmp, Transp, []).

union(This, Bmp, Transp, Options::[Option]) -> boolean()

Types:

This = wxRegion()
Bmp = wxBitmap:wxBitmap()
Transp = wx:wx_colour()
Option = {tolerance, integer()}

See external documentation.

union(This, X, Y, W, H) -> boolean()

Types:

This = wxRegion()
X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.

Xor(This, Region) -> boolean()

Types:

This = wxRegion()
Region = wxRegion()

See external documentation.
Also:
'Xor'(This, Rect) -> boolean() when
This::wxRegion(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

Xor(This, X, Y, W, H) -> boolean()

Types:

This = wxRegion()
X = integer()
Y = integer()
W = integer()
H = integer()

See external documentation.

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

Destroys this object, do not use object again

AUTHORS

<>
wx 1.8