<?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>wxSashEvent</title>
</header>
<module>wxSashEvent</module>
<modulesummary>Functions for wxSashEvent class</modulesummary>
<description><p>A sash event is sent when the sash of a <seeerl marker="wxSashWindow"><c>wxSashWindow</c></seeerl> has been dragged by the user.
      </p><p>Remark: When a sash belonging to a sash window is dragged by the user, and then released, this event is sent to the window, where it may be processed by an event table entry in a derived class, a plug-in event handler or an ancestor class. Note that the <seeerl marker="wxSashWindow"><c>wxSashWindow</c></seeerl> doesn't change the window's size itself. It relies on the application's event handler to do that. This is because the application may have to handle other consequences of the resize, or it may wish to veto it altogether. The event handler should look at the drag rectangle: see <seemfa marker="#getDragRect/1"><c>getDragRect/1</c></seemfa> to see what the new size of the window would be if the resize were to be applied. It should also call <seemfa marker="#getDragStatus/1"><c>getDragStatus/1</c></seemfa> to see whether the drag was OK or out of the current allowed range.
      </p><p>See: <seeerl marker="wxSashWindow"><c>wxSashWindow</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="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_sash_event.html">wxSashEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxSashEventType"><c>wxSashEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxSashEvent"/></datatype>
    <datatype><name name="wxSash"/></datatype>
    <datatype><name name="wxSashEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getEdge" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the dragged edge. </fsummary>
    <desc><p>Returns the dragged edge. 
      </p><p>The return value is one of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDragRect" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the rectangle representing the new size the window would be if the resize was applied. </fsummary>
    <desc><p>Returns the rectangle representing the new size the window would be if the resize was applied. 
      </p><p>It is up to the application to set the window size if required. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDragStatus" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the status of the sash: one of wxSASH_STATUS_OK, wxSASH_STATUS_OUT_OF_RANGE. </fsummary>
    <desc><p>Returns the status of the sash: one of wxSASH_STATUS_OK, wxSASH_STATUS_OUT_OF_RANGE. 
      </p><p>If the drag caused the notional bounding box of the window to flip over, for example, the drag will be out of rage. 
      </p></desc>
  </func>
  </funcs>
</erlref>
