<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      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.

  </legalnotice>
  <title>wxSplitterEvent</title>
</header>
<module>wxSplitterEvent</module>
<modulesummary>Functions for wxSplitterEvent class</modulesummary>
<description><p>This class represents the events generated by a splitter control.
      </p><p>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.
      </p><p>See: <seeerl marker="wxSplitterWindow"><c>wxSplitterWindow</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxNotifyEvent"><c>wxNotifyEvent</c></seeerl> <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl> <seeerl marker="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_splitter_event.html">wxSplitterEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxSplitterEventType"><c>wxSplitterEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxSplitterEvent"/></datatype>
    <datatype><name name="wxSplitter"/></datatype>
    <datatype><name name="wxSplitterEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getSashPosition" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the new sash position. </fsummary>
    <desc><p>Returns the new sash position. 
      </p><p>May only be called while processing <c>wxEVT_SPLITTER_SASH_POS_CHANGING</c> and <c>wxEVT_SPLITTER_SASH_POS_CHANGED</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getX" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the x coordinate of the double-click point. </fsummary>
    <desc><p>Returns the x coordinate of the double-click point. 
      </p><p>May only be called while processing <c>wxEVT_SPLITTER_DOUBLECLICKED</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getY" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the y coordinate of the double-click point. </fsummary>
    <desc><p>Returns the y coordinate of the double-click point. 
      </p><p>May only be called while processing <c>wxEVT_SPLITTER_DOUBLECLICKED</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="getWindowBeingRemoved" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a pointer to the window being removed when a splitter window is unsplit. </fsummary>
    <desc><p>Returns a pointer to the window being removed when a splitter window is unsplit. 
      </p><p>May only be called while processing <c>wxEVT_SPLITTER_UNSPLIT</c> events. 
      </p></desc>
  </func>
  
  <func>
    <name name="setSashPosition" arity="2" clause_i="1" since=""/>
    <fsummary>In the case of <c>wxEVT_SPLITTER_SASH_POS_CHANGED</c> events, sets the new sash position. </fsummary>
    <desc><p>In the case of <c>wxEVT_SPLITTER_SASH_POS_CHANGED</c> events, sets the new sash position. 
      </p><p>In the case of <c>wxEVT_SPLITTER_SASH_POS_CHANGING</c> 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.
      </p><p>May only be called while processing <c>wxEVT_SPLITTER_SASH_POS_CHANGING</c> and <c>wxEVT_SPLITTER_SASH_POS_CHANGED</c> events.
      </p></desc>
  </func>
  </funcs>
</erlref>
