Search documentation of wx

# wx (wx v2.6)

Copy Markdown View Source

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 functions.

wxWidgets is object oriented, and not functional. Thus, in Wx 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(Object, ...) 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},wxGridCellCoords={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 environment 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(), target=unicode:chardata()}

- wx_wxMouseState() = #wxMouseState{x=integer(), y=integer(), leftDown=boolean(), middleDown=boolean(), rightDown=boolean(), controlDown=boolean(), shiftDown=boolean(), altDown=boolean(), metaDown=boolean(), cmdDown=boolean()}

  See #wxMouseState{} defined in wx.hrl

## Summary

### Types

wx_colour4()
wx_colour()
wx_datetime()
wx_enum()
wx_env()
wx_memory()
wx_object()
wx_wxHtmlLinkInfo()
wx_wxMouseState()

### Functions

batch(Fun)

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.

create_memory(Size)

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.

debug(Level)

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()

Starts a Wx demo if examples directory exists and is compiled

destroy()

Stops a wx server.

equal(Ref1, Ref2)

Returns true if both arguments references the same object, false otherwise

foldl(Fun, Acc, List)

Behaves like `lists:foldl/3` but batches wx commands. See `batch/1`.

foldr(Fun, Acc, List)

Behaves like `lists:foldr/3` but batches wx commands. See `batch/1`.

foreach(Fun, List)

Behaves like `lists:foreach/2` but batches wx commands. See `batch/1`.

get_env()

Gets this process's current wx environment. Can be sent to other processes to allow them use this process wx environment.

get_memory_bin(Wx_mem)

Returns the memory area as a binary.

getObjectType(Wx_ref)

Returns the object type

is_null(Wx_ref)

Returns true if object is null, false otherwise

map(Fun, List)

Behaves like `lists:map/2` but batches wx commands. See `batch/1`.

new()

Starts a wx server.

new(Options)

Starts a wx server.

null()

Returns the null object

parent_class(Wx_ref)
release_memory(Wx_mem)

Releases the memory retained by `retain_memory/1`

retain_memory(Wx_mem)

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.

set_env(Wx_env)

Sets the process wx environment, allows this process to use another process wx environment.

subscribe_events()

Adds the calling process to the list of of processes that are listening to wx application events.

typeCast/2

Casts the object to class NewType. It is needed when using functions like wxWindow:findWindow/2, which returns a generic wxObject type.

## Types

# wx_colour4()

    -type wx_colour4() :: {R :: byte(), G :: byte(), B :: byte(), A :: byte()}.

# wx_colour()

    -type wx_colour() :: {R :: byte(), G :: byte(), B :: byte()} | wx_colour4().

# wx_datetime()

    -type wx_datetime() ::
              {{Year :: integer(), Month :: integer(), Day :: integer()},
               {Hour :: integer(), Minute :: integer(), Second :: integer()}}.

# wx_enum()

    -type wx_enum() :: integer().

# wx_env()

    -type wx_env() :: #wx_env{ref :: term(), sv :: term(), debug :: term()}.

# wx_memory()

    -type wx_memory() :: binary() | #wx_mem{bin :: term(), size :: term()}.

# wx_object()

    -type wx_object() :: #wx_ref{ref :: term(), type :: term(), state :: term()}.

# wx_wxHtmlLinkInfo()

    -type wx_wxHtmlLinkInfo() :: #wxHtmlLinkInfo{href :: unicode:chardata(), target :: unicode:chardata()}.

# wx_wxMouseState()

    -type wx_wxMouseState() ::
              #wxMouseState{x :: integer(),
                            y :: integer(),
                            leftDown :: boolean(),
                            middleDown :: boolean(),
                            rightDown :: boolean(),
                            controlDown :: boolean(),
                            shiftDown :: boolean(),
                            altDown :: boolean(),
                            metaDown :: boolean(),
                            cmdDown :: boolean(),
                            aux1Down :: boolean(),
                            aux2Down :: boolean()}.

## Functions

# batch(Fun)

    -spec batch(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`.

# create_memory(Size)

    -spec 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.

# debug(Level)

    -spec debug(Level | [Level]) -> ok when 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()

    -spec demo() -> ok | {error, atom()}.

Starts a Wx demo if examples directory exists and is compiled

# destroy()

    -spec destroy() -> ok.

Stops a wx server.

# equal(Ref1, Ref2)

    -spec equal(Ref1 :: wx_object(), Ref2 :: wx_object()) -> boolean().

Returns true if both arguments references the same object, false otherwise

# foldl(Fun, Acc, List)

    -spec foldl(function(), term(), list()) -> term().

Behaves like `lists:foldl/3` but batches wx commands. See `batch/1`.

# foldr(Fun, Acc, List)

    -spec foldr(function(), term(), list()) -> term().

Behaves like `lists:foldr/3` but batches wx commands. See `batch/1`.

# foreach(Fun, List)

    -spec foreach(function(), list()) -> ok.

Behaves like `lists:foreach/2` but batches wx commands. See `batch/1`.

# get_env()

    -spec 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`.

# get_memory_bin(Wx_mem)

    -spec get_memory_bin(Wx_mem :: wx_memory()) -> binary().

Returns the memory area as a binary.

# getObjectType(Wx_ref)

    -spec getObjectType(Wx_ref :: wx_object()) -> atom().

Returns the object type

# is_null(Wx_ref)

    -spec is_null(Wx_ref :: wx_object()) -> boolean().

Returns true if object is null, false otherwise

# map(Fun, List)

    -spec map(function(), list()) -> list().

Behaves like `lists:map/2` but batches wx commands. See `batch/1`.

# new()

    -spec new() -> wx_object().

Starts a wx server.

# new(Options)

    -spec new([Option]) -> wx_object() when 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.

# null()

    -spec null() -> wx_object().

Returns the null object

# parent_class(Wx_ref)

    -spec parent_class(Wx_ref :: wx_object()) -> boolean().

# release_memory(Wx_mem)

    -spec release_memory(Wx_mem :: wx_memory()) -> ok.

Releases the memory retained by `retain_memory/1`

# retain_memory(Wx_mem)

    -spec 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.

# set_env(Wx_env)

    -spec set_env(Wx_env :: wx_env()) -> ok.

Sets the process wx environment, allows this process to use another process wx environment.

# subscribe_events()

    -spec subscribe_events() -> ok.

Adds the calling process to the list of of processes that are listening to wx application events.

At the moment these are all MacOSX specific events corresponding to `MacNewFile()` and friends from wxWidgets wxApp:

- `{new_file, ""}`
- `{open_file, Filename}`
- `{print_file, Filename}`
- `{open_url, Url}`
- `{reopen_app, ""}`

The call always returns ok but will have sent any already received events to the calling process.

# typeCast/2

    -spec typeCast(wx_object(), atom()) -> wx_object().

Casts the object to class NewType. It is needed when using functions like wxWindow:findWindow/2, which returns a generic wxObject type.