%
%        |\ | /¯\ ¯|¯  | |¯¯ \ / |_¯ \ / |_¯ |\ | ¯|¯                 
%\  W  X | \| \_/  |   | |¯   |  |__  V  |__ | \|  |   .   E  R  L                                    
%%——————————————————————————————————————————————
%%
%%   Copyright Ericsson AB 2008-2013. All Rights Reserved.
%%
%%——————————————————————————————————————————————
%% Whitespace Beautified by ScriptCulture © 2018
%% Sit Back · Feet Up · Learn wxErlang
%% For use as a reference only.
%% www.scriptculture.com
%% Not check-summed 
%% unknown vsn —————————————————————————————————————— 
%%
%% Licensed under the Apache License, 
%% Version 2.0 (the "License"); you may 
%% not use this file except in compliance 
%% with the License. You may obtain a copy 
%% of the License at:
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by 
%% applicable law or agreed to in writing, software
%% distributed under the License is distributed 
%% on an "AS IS" BASIS, WITHOUT WARRANTIES 
%% OR CONDITIONS OF ANY KIND, either 
%% express or implied. See the 
%% License for the specific 
%% language governing 
%% permissions and
%% limitations 
%% under the 
%% License.
%%%%%%%
%%%%
%%
%   
%%
%% @doc See external documentation: <a href="http://www.wxwidgets.org/manuals/2.8.12/wx_wxnotifyevent.html">wxNotifyEvent</a>.
%% <p>This class is derived (and can use functions) from:
%% <br />{@link wxCommandEvent}
%% <br />{@link wxEvent}
%% </p>
%% @type wxNotifyEvent().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   This class is not used by the event handlers by itself, 
%%   but is a base class for other event classes (such as wxNotebookEvent).
%%   
%%   It (or an object of a derived class) is sent when the controls state 
%%   is being changed and allows the program to Veto() this change 
%%   if it wants to prevent it from happening.
%%   
%%   
%%   See Also:
%%   —————————
%%   
%%   
-module(wxNotifyEvent).
-include("wxe.hrl").
-export([allow/1,isAllowed/1,veto/1]).

%% inherited exports
-export([getClientData/1,getExtraLong/1,getId/1,getInt/1,getSelection/1,getSkipped/1,
  getString/1,getTimestamp/1,isChecked/1,isCommandEvent/1,isSelection/1,
  parent_class/1,resumePropagation/2,setInt/2,setString/2,shouldPropagate/1,
  skip/1,skip/2,stopPropagation/1]).

-export_type([wxNotifyEvent/0]).


%% @hidden
parent_class(wxCommandEvent) -> true;
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).


-type wxNotifyEvent()  ::  wx:wx_object().




           %·%% ALLOW %%·%

%%   
%%   This is the opposite of Veto(): it explicitly allows the event to be processed. 
%%   For most events it is not necessary to call this method 
%%   as the events are allowed anyhow but some are forbidden by 
%%   default (this will be mentioned in the corresponding event description).
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec allow(This) -> ok
           when
 	         This :: wxNotifyEvent().

allow(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                        ?CLASS(ThisT,wxNotifyEvent),
                          wxe_util:cast(?wxNotifyEvent_Allow,
                          <<ThisRef:32/?UI>>).





           %·%% IS ALLOWED %%·%

%%   
%%    Returns true if the change is allowed 
%%   (Veto() hasn't been called) or false otherwise (if it was).
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec isAllowed(This) -> boolean()
           when
 	         This :: wxNotifyEvent().

isAllowed(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                            ?CLASS(ThisT,wxNotifyEvent),
                              wxe_util:call(?wxNotifyEvent_IsAllowed,
                              <<ThisRef:32/?UI>>).





           %·%% VETO %%·%

%%   
%%   Prevents the change announced by this event from happening.
%%   
%%   It is in general a good idea to notify the user about the reasons 
%%   for vetoing the change because otherwise the applications behaviour 
%%   (which just refuses to do what the user wants) might be quite surprising.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec veto(This) -> ok
           when
 	         This :: wxNotifyEvent().

veto(#wx_ref{type=ThisT,ref=ThisRef}) ->
                                       ?CLASS(ThisT,wxNotifyEvent),
                         wxe_util:cast(?wxNotifyEvent_Veto,
                         <<ThisRef:32/?UI>>).

 



%% From wxCommandEvent




%% @hidden
setString(This,S) -> wxCommandEvent:setString(This,S).
%% @hidden
setInt(This,I) -> wxCommandEvent:setInt(This,I).
%% @hidden
isSelection(This) -> wxCommandEvent:isSelection(This).
%% @hidden
isChecked(This) -> wxCommandEvent:isChecked(This).
%% @hidden
getString(This) -> wxCommandEvent:getString(This).
%% @hidden
getSelection(This) -> wxCommandEvent:getSelection(This).
%% @hidden
getInt(This) -> wxCommandEvent:getInt(This).
%% @hidden
getExtraLong(This) -> wxCommandEvent:getExtraLong(This).
%% @hidden
getClientData(This) -> wxCommandEvent:getClientData(This).


%% From wxEvent

%% @hidden
stopPropagation(This) -> wxEvent:stopPropagation(This).
%% @hidden
skip(This, Options) -> wxEvent:skip(This, Options).
%% @hidden
skip(This) -> wxEvent:skip(This).
%% @hidden
shouldPropagate(This) -> wxEvent:shouldPropagate(This).
%% @hidden
resumePropagation(This,PropagationLevel) -> wxEvent:resumePropagation(This,PropagationLevel).
%% @hidden
isCommandEvent(This) -> wxEvent:isCommandEvent(This).
%% @hidden
getTimestamp(This) -> wxEvent:getTimestamp(This).
%% @hidden
getSkipped(This) -> wxEvent:getSkipped(This).
%% @hidden
getId(This) -> wxEvent:getId(This).