1%%
2%% %CopyrightBegin%
3%%
4%% Copyright Ericsson AB 2008-2016. All Rights Reserved.
5%%
6%% Licensed under the Apache License, Version 2.0 (the "License");
7%% you may not use this file except in compliance with the License.
8%% You may obtain a copy of the License at
9%%
10%%     http://www.apache.org/licenses/LICENSE-2.0
11%%
12%% Unless required by applicable law or agreed to in writing, software
13%% distributed under the License is distributed on an "AS IS" BASIS,
14%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15%% See the License for the specific language governing permissions and
16%% limitations under the License.
17%%
18%% %CopyrightEnd%
19%% This file is generated DO NOT EDIT
20
21%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html">wxEvent</a>.
22%% @type wxEvent().  An object reference, The representation is internal
23%% and can be changed without notice. It can't be used for comparsion
24%% stored on disc or distributed for use on other nodes.
25
26-module(wxEvent).
27-include("wxe.hrl").
28-export([getId/1,getSkipped/1,getTimestamp/1,isCommandEvent/1,resumePropagation/2,
29  shouldPropagate/1,skip/1,skip/2,stopPropagation/1]).
30
31%% inherited exports
32-export([parent_class/1]).
33
34-export_type([wxEvent/0]).
35%% @hidden
36parent_class(_Class) -> erlang:error({badtype, ?MODULE}).
37
38-type wxEvent() :: wx:wx_object().
39%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventgetid">external documentation</a>.
40-spec getId(This) -> integer() when
41	This::wxEvent().
42getId(#wx_ref{type=ThisT,ref=ThisRef}) ->
43  ?CLASS(ThisT,wxEvent),
44  wxe_util:call(?wxEvent_GetId,
45  <<ThisRef:32/?UI>>).
46
47%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventgetskipped">external documentation</a>.
48-spec getSkipped(This) -> boolean() when
49	This::wxEvent().
50getSkipped(#wx_ref{type=ThisT,ref=ThisRef}) ->
51  ?CLASS(ThisT,wxEvent),
52  wxe_util:call(?wxEvent_GetSkipped,
53  <<ThisRef:32/?UI>>).
54
55%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventgettimestamp">external documentation</a>.
56-spec getTimestamp(This) -> integer() when
57	This::wxEvent().
58getTimestamp(#wx_ref{type=ThisT,ref=ThisRef}) ->
59  ?CLASS(ThisT,wxEvent),
60  wxe_util:call(?wxEvent_GetTimestamp,
61  <<ThisRef:32/?UI>>).
62
63%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventiscommandevent">external documentation</a>.
64-spec isCommandEvent(This) -> boolean() when
65	This::wxEvent().
66isCommandEvent(#wx_ref{type=ThisT,ref=ThisRef}) ->
67  ?CLASS(ThisT,wxEvent),
68  wxe_util:call(?wxEvent_IsCommandEvent,
69  <<ThisRef:32/?UI>>).
70
71%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventresumepropagation">external documentation</a>.
72-spec resumePropagation(This, PropagationLevel) -> 'ok' when
73	This::wxEvent(), PropagationLevel::integer().
74resumePropagation(#wx_ref{type=ThisT,ref=ThisRef},PropagationLevel)
75 when is_integer(PropagationLevel) ->
76  ?CLASS(ThisT,wxEvent),
77  wxe_util:cast(?wxEvent_ResumePropagation,
78  <<ThisRef:32/?UI,PropagationLevel:32/?UI>>).
79
80%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventshouldpropagate">external documentation</a>.
81-spec shouldPropagate(This) -> boolean() when
82	This::wxEvent().
83shouldPropagate(#wx_ref{type=ThisT,ref=ThisRef}) ->
84  ?CLASS(ThisT,wxEvent),
85  wxe_util:call(?wxEvent_ShouldPropagate,
86  <<ThisRef:32/?UI>>).
87
88%% @equiv skip(This, [])
89-spec skip(This) -> 'ok' when
90	This::wxEvent().
91
92skip(This)
93 when is_record(This, wx_ref) ->
94  skip(This, []).
95
96%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventskip">external documentation</a>.
97-spec skip(This, [Option]) -> 'ok' when
98	This::wxEvent(),
99	Option :: {'skip', boolean()}.
100skip(#wx_ref{type=ThisT,ref=ThisRef}, Options)
101 when is_list(Options) ->
102  ?CLASS(ThisT,wxEvent),
103  MOpts = fun({skip, Skip}, Acc) -> [<<1:32/?UI,(wxe_util:from_bool(Skip)):32/?UI>>|Acc];
104          (BadOpt, _) -> erlang:error({badoption, BadOpt}) end,
105  BinOpt = list_to_binary(lists:foldl(MOpts, [<<0:32>>], Options)),
106  wxe_util:cast(?wxEvent_Skip,
107  <<ThisRef:32/?UI, 0:32,BinOpt/binary>>).
108
109%% @doc See <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxevent.html#wxeventstoppropagation">external documentation</a>.
110-spec stopPropagation(This) -> integer() when
111	This::wxEvent().
112stopPropagation(#wx_ref{type=ThisT,ref=ThisRef}) ->
113  ?CLASS(ThisT,wxEvent),
114  wxe_util:call(?wxEvent_StopPropagation,
115  <<ThisRef:32/?UI>>).
116
117