1wx(3) Erlang Module Definition wx(3)
2
6 wx - A port of wxWidgets.
7
9 A port of wxWidgets.
10 This is the base api of wxWidgets. This module contains functions for
12 starting and stopping the wx-server, as well as other utility func‐
13 tions.
14 wxWidgets is object oriented, and not functional. Thus, in wxErlang a
16 module represents a class, and the object created by this class has an
17 own type, wxCLASS(). This module represents the base class, and all
18 other wxMODULE's are sub-classes of this class.
19 Objects of a class are created with wxCLASS:new(...) and destroyed with
21 wxCLASS:destroy(). Member functions are called with wxCLASS:mem‐
22 ber(Object, ...) instead of as in C++ Object.member(...).
23 Sub class modules inherit (non static) functions from their parents.
25 The inherited functions are not documented in the sub-classes.
26 This erlang port of wxWidgets tries to be a one-to-one mapping with the
28 original wxWidgets library. Some things are different though, as the
29 optional arguments use property lists and can be in any order. The main
30 difference is the event handling which is different from the original
31 library. See wxEvtHandler.
32 The following classes are implemented directly as erlang types:
34 wxPoint={x,y},wxSize={w,h},wxRect={x,y,w,h},wxColour={r,g,b [,a]},
35 wxString=unicode:chardata(), wxGBPosition={r,c},wxGB‐
36 Span={rs,cs},wxGridCellCoords={r,c}.
37 wxWidgets uses a process specific environment, which is created by
39 wx:new/0. To be able to use the environment from other processes, call
40 get_env/0 to retrieve the environment and set_env/1 to assign the envi‐
41 ronment in the other process.
42 Global (classless) functions are located in the wx_misc module.
44
46 wx_colour() = {R::byte(), G::byte(), B::byte()} | wx_colour4():
47 wx_colour4() = {R::byte(), G::byte(), B::byte(), A::byte()}:
50 wx_datetime() = {{Year::integer(), Month::integer(), Day::integer()},
53 {Hour::integer(), Minute::integer(), Second::integer()}}:
54 In Local Timezone
57 wx_enum() = integer():
59 Constant defined in wx.hrl
62 wx_env() = #wx_env{}:
64 Opaque process environment
67 wx_memory() = binary() | #wx_mem{}:
69 Opaque memory reference
72 wx_object() = #wx_ref{}:
74 Opaque object reference
77 wx_wxHtmlLinkInfo() = #wxHtmlLinkInfo{href=unicode:chardata(), tar‐
79 get=unicode:chardata()}:
80 wx_wxMouseState() = #wxMouseState{x=integer(), y=integer(), left‐
83 Down=boolean(), middleDown=boolean(), rightDown=boolean(), con‐
84 trolDown=boolean(), shiftDown=boolean(), altDown=boolean(), metaD‐
85 own=boolean(), cmdDown=boolean()}:
86 See #wxMouseState{} defined in wx.hrl
89
91 parent_class(X1) -> term()
92 new() -> wx_object()
94 Starts a wx server.
96 new(Options::[Option]) -> wx_object()
98 Types:
100 Option = {debug, list() | atom()} | {silent_start, boolean()}
102 Starts a wx server. Option may be {debug, Level}, see debug/1.
104 Or {silent_start, Bool}, which causes error messages at startup
105 to be suppressed. The latter can be used as a silent test of
106 whether wx is properly installed or not.
107 destroy() -> ok
109 Stops a wx server.
111 get_env() -> wx_env()
113 Gets this process's current wx environment. Can be sent to other
115 processes to allow them use this process wx environment.
116 See also: set_env/1.
118 set_env(Wx_env::wx_env()) -> ok
120 Sets the process wx environment, allows this process to use
122 another process wx environment.
123 null() -> wx_object()
125 Returns the null object
127 is_null(Wx_ref::wx_object()) -> boolean()
129 Returns true if object is null, false otherwise
131 equal(Wx_ref::wx_object(), X2::wx_object()) -> boolean()
133 Returns true if both arguments references the same object, false
135 otherwise
136 getObjectType(Wx_ref::wx_object()) -> atom()
138 Returns the object type
140 typeCast(Old::wx_object(), NewType::atom()) -> wx_object()
142 Casts the object to class NewType. It is needed when using func‐
144 tions like wxWindow:findWindow/2, which returns a generic wxOb‐
145 ject type.
146 batch(Fun::function()) -> term()
148 Batches all wx commands used in the fun. Improves performance of
150 the command processing by grabbing the wxWidgets thread so that
151 no event processing will be done before the complete batch of
152 commands is invoked.
153 See also: foldl/3, foldr/3, foreach/2, map/2.
155 foreach(Fun::function(), List::list()) -> ok
157 Behaves like lists:foreach/2 but batches wx commands. See
159 batch/1.
160 map(Fun::function(), List::list()) -> list()
162 Behaves like lists:map/2 but batches wx commands. See batch/1.
164 foldl(Fun::function(), Acc::term(), List::list()) -> term()
166 Behaves like lists:foldl/3 but batches wx commands. See batch/1.
168 foldr(Fun::function(), Acc::term(), List::list()) -> term()
170 Behaves like lists:foldr/3 but batches wx commands. See batch/1.
172 create_memory(Size::integer()) -> wx_memory()
174 Creates a memory area (of Size in bytes) which can be used by an
176 external library (i.e. opengl). It is up to the client to keep a
177 reference to this object so it does not get garbage collected by
178 erlang while still in use by the external library.
179 This is far from erlang's intentional usage and can crash the
181 erlang emulator. Use it carefully.
182 get_memory_bin(Wx_mem::wx_memory()) -> binary()
184 Returns the memory area as a binary.
186 retain_memory(Wx_mem::wx_memory()) -> ok
188 Saves the memory from deletion until release_memory/1 is called.
190 If release_memory/1 is not called the memory will not be garbage
191 collected.
192 release_memory(Wx_mem::wx_memory()) -> ok
194 debug(Debug::Level | [Level]) -> ok
196 Types:
198 Level = none | verbose | trace | driver | integer()
200 Sets debug level. If debug level is 'verbose' or 'trace' each
202 call is printed on console. If Level is 'driver' each allocated
203 object and deletion is printed on the console.
204 demo() -> ok | {error, atom()}
206 Starts a wxErlang demo if examples directory exists and is com‐
208 piled
209
211 <>
212 wx 1.9 wx(3)