User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.99

Expand All
Contract All

Table of Contents

# wxRegion

### MODULE

wxRegion

### MODULE SUMMARY

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(X::term()) -> wxRegion()

See external documentation.
Alternatives:

new(Bmp::wxBitmap:wxBitmap()) -> wxRegion()

new(Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxRegion()

new(TopLeft::{X::integer(), Y::integer()}, BottomRight::{X::integer(), Y::integer()}) -> wxRegion()

See external documentation.

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

See external documentation.

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

See external documentation.

contains(This::wxRegion(), X::term()) -> WxRegionContain

See external documentation.
Alternatives:

contains(This::wxRegion(), Pt::{X::integer(),Y::integer()}) -> WxRegionContain
WxRegionContain = integer()
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion

contains(This::wxRegion(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> WxRegionContain
WxRegionContain = integer()
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion

contains(This::wxRegion(), X::integer(), Y::integer()) -> WxRegionContain

Types:

WxRegionContain = integer()

See external documentation.
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion

contains(This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> WxRegionContain

Types:

WxRegionContain = integer()

See external documentation.
WxRegionContain is one of ?wxOutRegion | ?wxPartRegion | ?wxInRegion

convertToBitmap(This::wxRegion()) -> wxBitmap() (see module wxBitmap)

See external documentation.

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

See external documentation.

intersect(This::wxRegion(), X::wxRegion() | term()) -> bool()

See external documentation.
Alternatives:

intersect(This::wxRegion(), Region::wxRegion()) -> bool()

intersect(This::wxRegion(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> bool()

intersect(This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool()

See external documentation.

isEmpty(This::wxRegion()) -> bool()

See external documentation.

subtract(This::wxRegion(), X::wxRegion() | term()) -> bool()

See external documentation.
Alternatives:

subtract(This::wxRegion(), Region::wxRegion()) -> bool()

subtract(This::wxRegion(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> bool()

subtract(This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool()

See external documentation.

offset(This::wxRegion(), Pt::{X::integer(), Y::integer()}) -> bool()

See external documentation.

offset(This::wxRegion(), X::integer(), Y::integer()) -> bool()

See external documentation.

union(This::wxRegion(), X::term()) -> bool()

See external documentation.
Alternatives:

union(This::wxRegion(), Region::wxRegion() | wxBitmap:wxBitmap()) -> bool()

union(This::wxRegion(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> bool()

union(This::wxRegion(), Bmp::wxBitmap() (see module wxBitmap), Transp::colour() (see module wx)) -> bool()

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

union(This::wxRegion(), Bmp::wxBitmap() (see module wxBitmap), Transp::colour() (see module wx), Options::[Option]) -> bool()

Types:

Option = {tolerance, integer()}

See external documentation.

union(This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool()

See external documentation.

Xor(This::wxRegion(), X::wxRegion() | term()) -> bool()

See external documentation.
Alternatives:

'Xor'(This::wxRegion(), Region::wxRegion()) -> bool()

'Xor'(This::wxRegion(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> bool()

Xor(This::wxRegion(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool()

See external documentation.

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

Destroys this object, do not use object again