View Source WxObject behaviour (wx_ex v0.4.0)

An Elixir wrapper for Erlang’s :wx_object behaviour, inspired by GenServer etc.

Does not yet support 100% of :wx_object’s API. Specifically, handle_sync_event/2 is not yet implemented.

Unlike GenServer, WxObject returns a wxWindow reference rather than a pid. If you want to include your top level object in your supervision tree, you will need to return the pid from start_link. For example:

def start_link(_arg) do
  ref = WxObject.start_link(__MODULE__, nil, name: __MODULE__)
  {:ok, WxObject.get_pid(ref)}
end

Summary

Callbacks

handle_call(request, from, state)

handle_cast(request, state)

handle_event(request, state)

handle_info(msg, state)

init(args)

Functions

call(obj, request, timeout \\ 5000)

Make a synchronous call to the server and wait for its reply.

cast(obj, request)

Cast a request to the server without waiting for a response.

get_pid(obj)

See :wx_object.get_pid/1.

start_link(module, args, options \\ [])

Callbacks

handle_call(request, from, state)

(optional)

@callback handle_call(request :: term(), from :: GenServer.server(), state :: term()) ::
  {:reply, reply, new_state}
  | {:reply, reply, new_state,
     timeout() | :hibernate | {:continue, continue_arg :: term()}}
  | {:noreply, new_state}
  | {:noreply, new_state,
     timeout() | :hibernate | {:continue, continue_arg :: term()}}
  | {:stop, reason, reply, new_state}
  | {:stop, reason, new_state}
when reply: term(), new_state: term(), reason: term()

handle_cast(request, state)

(optional)

@callback handle_cast(request :: term(), state :: term()) ::
  {:noreply, new_state}
  | {:noreply, new_state,
     timeout() | :hibernate | {:continue, continue_arg :: term()}}
  | {:stop, reason :: term(), new_state}
when new_state: term()

handle_event(request, state)

@callback handle_event(
  request ::
    {:wx, id :: integer(), obj :: :wx.wx_object(), userData :: term(),
     event :: tuple()},
  state :: term()
) ::
  {:noreply, new_state :: term()}
  | {:noreply, new_state :: term(), timeout() | :hibernate}
  | {:stop, reason :: term(), new_state :: term()}

handle_info(msg, state)

(optional)

@callback handle_info(msg :: :timeout | term(), state :: term()) ::
  {:noreply, new_state}
  | {:noreply, new_state,
     timeout() | :hibernate | {:continue, continue_arg :: term()}}
  | {:stop, reason :: term(), new_state}
when new_state: term()

init(args)

@callback init(args :: term()) ::
  {{:wx_ref, ref :: term(), type :: term(), state :: term()},
   [{:state, term()}]}
  | {{:wx_ref, ref :: term(), type :: term(), state :: term()}, state :: term(),
     timeout() | :hibernate}
  | {:stop, reason :: term()}
  | :ignore

Functions

call(obj, request, timeout \\ 5000)

@spec call(:wx.wx_object(), term(), timeout()) :: term()

Make a synchronous call to the server and wait for its reply.

cast(obj, request)

@spec cast(:wx.wx_object(), term()) :: term()

Cast a request to the server without waiting for a response.

get_pid(obj)

@spec get_pid(:wx.wx_object() | atom() | pid()) :: pid()

See :wx_object.get_pid/1.

start_link(module, args, options \\ [])