wx

wx

A port of wxWidgets.

A port of wxWidgets.

This is the base api of wxWidgets. This module contains functions for starting and stopping the wx-server, and other utility functions.

wxWidgets is object oriented, and not functional. Where an erlang module represents a class, and the object created by this class have 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 inherits (non static) functions from it's 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, optional arguments uses 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:charlist(), wxGBPosition={r,c},wxGBSpan={rs,cs},wxGridCellCoords={r,c}.

Where all strings are decoded/encoded as UTF32 in native format.

wxWidgets uses a process specific environment, which is created by wx:new/0, to allow usage from other procesess use get_env/1 and set_env/0.

Global (classless) functions are located in the wx_misc module.

colour()

A 3 or 4 tuple: {R,G,B,A} or as argument {R,G,B} is also accepted where each colour channal is a an integer between 0-255.

datetime()

{{Year,Month,Day}, {Hour,Minute,Second}} in local timezone.

mouseState()

See #wxMouseState{} defined in wx.hrl

wxObject()

Opaque object

wx_env()

Wx process enviroment

wx_mem()

Wx memory area

Starts a wx server.

Stops a wx server.

Get this process current wx environment. Can be sent to other processes be allow them use wx functionality.

See also: set_env/1.

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

returns the null object

Returns true if object is null, false otherwise

Returns the object type

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

Batches all wx commands used in the fun. Improves perfomance of the command processing, grabs the wxWidgets thread so GUI may not be updated directly (and no event processing will be done)

See also: foldl/3, foldr/3, foreach/2, map/2.

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

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

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

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

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

Returns the memory area as a binary.

Types:

Sets debug level, if debug is verbose or trace each call is printed on console

- support@erlang.ericsson.se