%        (` |¯\ |    | ¯|¯ ¯|¯ |_¯ |¯\  |_¯ \ / |_¯ |\ | ¯|¯              
%\  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 
%% wx 1.8 —————————————————————————————————————— 
%%
%% 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_wxsplitterevent.html">wxSplitterEvent</a>.
%% <dl><dt>Use {@link wxEvtHandler:connect/3.} with EventType:</dt>
%% <dd><em>command_splitter_sash_pos_changed</em>, <em>command_splitter_sash_pos_changing</em>, <em>command_splitter_doubleclicked</em>, <em>command_splitter_unsplit</em></dd></dl>
%% See also the message variant {@link wxEvtHandler:wxSplitter(). #wxSplitter{}} event record type.
%%
%% <p>This class is derived (and can use functions) from:
%% <br />{@link wxNotifyEvent}
%% <br />{@link wxCommandEvent}
%% <br />{@link wxEvent}
%% </p>
%% @type wxSplitterEvent().  
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%   
%%   OVERVIEW
%%   ––––––––
%%   This class represents the events generated by a splitter control. 
%%   Also there is only one event class, the data associated to 
%%   the different events is not the same and so not 
%%   all accessor functions may be called for each event. 
%%   
%%   The documentation mentions the kind of event(s) for 
%%   which the given accessor function makes sense: calling 
%%   it for other types of events will result in assert 
%%   failure (in debug mode) and will return meaningless results.
%%   
%%   
%%   EVENT TABLE MACROS
%%   ——————————————————
%%   
%%   To process a splitter event, use these event handler macros 
%%   to direct input to member functions that take a wxSplitterEvent argument.
%%   
%%      EVT_SPLITTER_SASH_POS_CHANGING(id, func)  The sash position is in the process of being changed. 
%%                                                You may prevent this change from happening by calling 
%%                                                Veto or you may also modify the position of the 
%%                                                tracking bar to properly reflect the position 
%%                                                that would be set if the drag were to be 
%%                                                completed at this point. Processes a 
%%                                                wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
%%   
%%      EVT_SPLITTER_SASH_POS_CHANGED(id, func)   The sash position was changed. 
%%                                                This event is generated after the user releases 
%%                                                the mouse after dragging the splitter. Processes a 
%%                                                wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
%%   
%%      EVT_SPLITTER_UNSPLIT(id, func)            The splitter has been just unsplit. Processes a 
%%                                                wxEVT_COMMAND_SPLITTER_UNSPLIT event. 
%%                                                This event can't be vetoed.
%%   
%%      EVT_SPLITTER_DCLICK(id, func)             The sash was double clicked. 
%%                                                The default behaviour is to unsplit the window 
%%                                                when this happens (unless the minimum pane size 
%%                                                has been set to a value greater than zero). 
%%                                                This won't happen if you veto this event. Processes a 
%%                                                wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event. 
%%   
%%   
%%   See Also:
%%   —————————
%%   wxSplitterWindow
%%   
%%   
-module(wxSplitterEvent).
-include("wxe.hrl").
-export([getSashPosition/1,getWindowBeingRemoved/1,getX/1,getY/1,setSashPosition/2]).

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

-export_type([wxSplitterEvent/0]).
%% @hidden
parent_class(wxNotifyEvent) -> true;
parent_class(wxCommandEvent) -> true;
parent_class(wxEvent) -> true;
parent_class(_Class) -> erlang:error({badtype, ?MODULE}).

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




           %·%% GET SASH POSITION %%·%

%%   
%%    Returns the new sash position.
%%   
%%   May only be called while processing 
%%   wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and 
%%   wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getSashPosition(This) -> integer()
           when
           This :: wxSplitterEvent().

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





           %·%% GET X %%·%

%%   
%%    Returns the x coordinate of the double-click point.
%%   
%%   May only be called while processing 
%%   wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getX(This) -> integer()
           when
           This :: wxSplitterEvent().

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





           %·%% GET Y %%·%

%%   
%%   Returns the y coordinate of the double-click point.
%%   
%%   May only be called while processing 
%%   wxEVT_COMMAND_SPLITTER_DOUBLECLICKED events.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getY(This) -> integer()
           when
           This :: wxSplitterEvent().

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





           %·%% GET WINDOW BEING REMOVED %%·%

%%   
%%   Returns a pointer to the window being removed 
%%   when a splitter window is unsplit.
%%   
%%   May only be called while processing 
%%   wxEVT_COMMAND_SPLITTER_UNSPLIT events.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec getWindowBeingRemoved(This) -> wxWindow:wxWindow()
           when
           This :: wxSplitterEvent().

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





           %·%% SET SASH POSITION %%·%

%%   
%%   In the case of wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events, 
%%   sets the new sash position. 
%%   
%%   In the case of wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING events, 
%%   sets the new tracking bar position so visual 
%%   feedback during dragging will represent that 
%%   change that will actually take place. 
%%   Set to -1 from the event handler code to prevent repositioning.
%%   
%%   May only be called while processing 
%%   wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING and 
%%   wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED events.
%%   
%% Return Value:
%% See Also:
%%*%%*%%
          -spec setSashPosition(This, Pos) -> ok
           when
           This :: wxSplitterEvent(), 
           Pos  ::         integer().  %% New sash position.

setSashPosition(#wx_ref{type=ThisT,ref=ThisRef}, Pos)
           when 
           is_integer(Pos) ->
                            ?CLASS(ThisT,wxSplitterEvent),
              wxe_util:cast(?wxSplitterEvent_SetSashPosition,
              <<ThisRef:32/?UI,Pos:32/?UI>>).

 



%% From wxNotifyEvent




%% @hidden
veto(This) -> wxNotifyEvent:veto(This).
%% @hidden
isAllowed(This) -> wxNotifyEvent:isAllowed(This).
%% @hidden
allow(This) -> wxNotifyEvent:allow(This).
 %% 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).