<?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>wxSizeEvent</title>
</header>
<module>wxSizeEvent</module>
<modulesummary>Functions for wxSizeEvent class</modulesummary>
<description><p>A size event holds information about size change events of <seeerl marker="wxWindow"><c>wxWindow</c></seeerl>.
      </p><p>The EVT_SIZE handler function will be called when the window has been resized.
      </p><p>You may wish to use this for frames to resize their child windows as appropriate.
      </p><p>Note that the size passed is of the whole window: call <seemfa marker="wxWindow#getClientSize/1"><c>wxWindow:getClientSize/1</c></seemfa> for the area which may be used by the application.
      </p><p>When a window is resized, usually only a small part of the window is damaged and you may only need to repaint that area. However, if your drawing depends on the size of the window, you may need to clear the DC explicitly and repaint the whole window. In which case, you may need to call <seemfa marker="wxWindow#refresh/2"><c>wxWindow:refresh/2</c></seemfa> to invalidate the entire window.
      </p><p><c>Important</c> : Sizers ( see overview_sizer ) rely on size events to function correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all size events you catch (and don't catch size events at all when you don't need to).
      </p><p>See: {Width,Height}, <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="wxEvent"><c>wxEvent</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_size_event.html">wxSizeEvent</url></p>
  </description><section><title>Events</title><p>Use <seemfa marker="wxEvtHandler#connect/3"><c>wxEvtHandler:connect/3</c></seemfa> with <seetype marker="#wxSizeEventType"><c>wxSizeEventType</c></seetype> to subscribe to events of this type.</p></section>
<datatypes>
    <datatype><name name="wxSizeEvent"/></datatype>
    <datatype><name name="wxSize"/></datatype>
    <datatype><name name="wxSizeEventType"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getSize" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the entire size of the window generating the size change event. </fsummary>
    <desc><p>Returns the entire size of the window generating the size change event. 
      </p><p>This is the new total size of the window, i.e. the same size as would be returned by <seemfa marker="wxWindow#getSize/1"><c>wxWindow:getSize/1</c></seemfa> if it were called now. Use <seemfa marker="wxWindow#getClientSize/1"><c>wxWindow:getClientSize/1</c></seemfa> if you catch this event in a top level window such as <seeerl marker="wxFrame"><c>wxFrame</c></seeerl> to find the size available for the window contents. 
      </p></desc>
  </func>
  
  <func>
    <name name="getRect" arity="1" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  </funcs>
</erlref>
