wx(3erl) Erlang Module Definition wx(3erl)
NAME
wx - A port of wxWidgets.
DESCRIPTION
A port of wxWidgets.
This is the base api of wxWidgets. This module contains functions for
starting and stopping the wx-server, as well as other utility func-
tions.
wxWidgets is object oriented, and not functional. Thus, in wxErlang a
module represents a class, and the object created by this class has an
own type, wxCLASS(). This module represents the base class, and all
other wxMODULE's are sub-classes of this class.
Objects of a class are created with wxCLASS:new(...) and destroyed with
wxCLASS:destroy(). Member functions are called with wxCLASS:member(Ob-
ject, ...) instead of as in C++ Object.member(...).
Sub class modules inherit (non static) functions from their parents.
The inherited functions are not documented in the sub-classes.
This erlang port of wxWidgets tries to be a one-to-one mapping with the
original wxWidgets library. Some things are different though, as the
optional arguments use property lists and can be in any order. The main
difference is the event handling which is different from the original
library. See wxEvtHandler.
The following classes are implemented directly as erlang types:
wxPoint={x,y},wxSize={w,h},wxRect={x,y,w,h},wxColour={r,g,b [,a]},
wxString=unicode:chardata(), wxGBPosition={r,c},wxGBSpan={rs,cs},wx-
GridCellCoords={r,c}.
wxWidgets uses a process specific environment, which is created by
wx:new/0. To be able to use the environment from other processes, call
get_env/0 to retrieve the environment and set_env/1 to assign the envi-
ronment in the other process.
Global (classless) functions are located in the wx_misc module.
DATA TYPES
wx_colour() = {R::byte(), G::byte(), B::byte()} | wx_colour4():
wx_colour4() = {R::byte(), G::byte(), B::byte(), A::byte()}:
wx_datetime() = {{Year::integer(), Month::integer(), Day::integer()},
{Hour::integer(), Minute::integer(), Second::integer()}}:
In Local Timezone
wx_enum() = integer():
Constant defined in wx.hrl
wx_env() = #wx_env{}:
Opaque process environment
wx_memory() = binary() | #wx_mem{}:
Opaque memory reference
wx_object() = #wx_ref{}:
Opaque object reference
wx_wxHtmlLinkInfo() = #wxHtmlLinkInfo{href=unicode:chardata(), tar-
get=unicode:chardata()}:
wx_wxMouseState() = #wxMouseState{x=integer(), y=integer(), left-
Down=boolean(), middleDown=boolean(), rightDown=boolean(), con-
trolDown=boolean(), shiftDown=boolean(), altDown=boolean(), metaD-
own=boolean(), cmdDown=boolean()}:
See #wxMouseState{} defined in wx.hrl
EXPORTS
parent_class(X1) -> term()
new() -> wx_object()
Starts a wx server.
new(Options::[Option]) -> wx_object()
Types:
Option = {debug, list() | atom()} | {silent_start, boolean()}
Starts a wx server. Option may be {debug, Level}, see debug/1.
Or {silent_start, Bool}, which causes error messages at startup
to be suppressed. The latter can be used as a silent test of
whether wx is properly installed or not.
destroy() -> ok
Stops a wx server.
get_env() -> wx_env()
Gets this process's current wx environment. Can be sent to other
processes to allow them use this process wx environment.
See also: set_env/1.
set_env(Wx_env::wx_env()) -> ok
Sets the process wx environment, allows this process to use an-
other process wx environment.
null() -> wx_object()
Returns the null object
is_null(Wx_ref::wx_object()) -> boolean()
Returns true if object is null, false otherwise
equal(Wx_ref::wx_object(), X2::wx_object()) -> boolean()
Returns true if both arguments references the same object, false
otherwise
getObjectType(Wx_ref::wx_object()) -> atom()
Returns the object type
typeCast(Old::wx_object(), NewType::atom()) -> wx_object()
Casts the object to class NewType. It is needed when using func-
tions like wxWindow:findWindow/2, which returns a generic wxOb-
ject type.
batch(Fun::function()) -> term()
Batches all wx commands used in the fun. Improves performance of
the command processing by grabbing the wxWidgets thread so that
no event processing will be done before the complete batch of
commands is invoked.
See also: foldl/3, foldr/3, foreach/2, map/2.
foreach(Fun::function(), List::list()) -> ok
Behaves like lists:foreach/2 but batches wx commands. See
batch/1.
map(Fun::function(), List::list()) -> list()
Behaves like lists:map/2 but batches wx commands. See batch/1.
foldl(Fun::function(), Acc::term(), List::list()) -> term()
Behaves like lists:foldl/3 but batches wx commands. See batch/1.
foldr(Fun::function(), Acc::term(), List::list()) -> term()
Behaves like lists:foldr/3 but batches wx commands. See batch/1.
create_memory(Size::integer()) -> wx_memory()
Creates a memory area (of Size in bytes) which can be used by an
external library (i.e. opengl). It is up to the client to keep a
reference to this object so it does not get garbage collected by
erlang while still in use by the external library.
This is far from erlang's intentional usage and can crash the
erlang emulator. Use it carefully.
get_memory_bin(Wx_mem::wx_memory()) -> binary()
Returns the memory area as a binary.
retain_memory(Wx_mem::wx_memory()) -> ok
Saves the memory from deletion until release_memory/1 is called.
If release_memory/1 is not called the memory will not be garbage
collected.
release_memory(Wx_mem::wx_memory()) -> ok
debug(Debug::Level | [Level]) -> ok
Types:
Level = none | verbose | trace | driver | integer()
Sets debug level. If debug level is 'verbose' or 'trace' each
call is printed on console. If Level is 'driver' each allocated
object and deletion is printed on the console.
demo() -> ok | {error, atom()}
Starts a wxErlang demo if examples directory exists and is com-
piled
AUTHORS
<>
wx 1.9.1 wx(3erl)