<?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>wxSashLayoutWindow</title>
</header>
<module>wxSashLayoutWindow</module>
<modulesummary>Functions for wxSashLayoutWindow class</modulesummary>
<description><p><seeerl marker="wxSashLayoutWindow"><c>wxSashLayoutWindow</c></seeerl> responds to OnCalculateLayout events generated by <seeerl marker="wxLayoutAlgorithm"><c>wxLayoutAlgorithm</c></seeerl>. It allows the application to use simple accessors to specify how the window should be laid out, rather than having to respond to events.
      </p><p>The fact that the class derives from <seeerl marker="wxSashWindow"><c>wxSashWindow</c></seeerl> allows sashes to be used if required, to allow the windows to be user-resizable.
      </p><p>The documentation for <seeerl marker="wxLayoutAlgorithm"><c>wxLayoutAlgorithm</c></seeerl> explains the purpose of this class in more detail.
      </p><p>For the window styles see <seeerl marker="wxSashWindow"><c>wxSashWindow</c></seeerl>.
      </p><p>This class handles the EVT_QUERY_LAYOUT_INFO and EVT_CALCULATE_LAYOUT events for you. However, if you use sashes, see <seeerl marker="wxSashWindow"><c>wxSashWindow</c></seeerl> for relevant event information. See also <seeerl marker="wxLayoutAlgorithm"><c>wxLayoutAlgorithm</c></seeerl> for information about the layout events.
      </p><p>See: <seeerl marker="wxLayoutAlgorithm"><c>wxLayoutAlgorithm</c></seeerl>, <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="wxSashWindow"><c>wxSashWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_sash_layout_window.html">wxSashLayoutWindow</url></p>
  </description>
<datatypes><datatype><name name="wxSashLayoutWindow"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default ctor. </fsummary>
    <desc><p>Default ctor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window. </fsummary>
    <desc><p>Constructs a sash layout window, which can be a child of a frame, dialog or any other non-control window. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>create/3</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>Initializes a sash layout window, which can be a child of a frame, dialog or any other non-control window. </fsummary>
    <desc><p>Initializes a sash layout window, which can be a child of a frame, dialog or any other non-control window. 
      </p></desc>
  </func>
  
  <func>
    <name name="getAlignment" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM. </fsummary>
    <desc><p>Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM. 
      </p></desc>
  </func>
  
  <func>
    <name name="getOrientation" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL. </fsummary>
    <desc><p>Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL. 
      </p></desc>
  </func>
  
  <func>
    <name name="setAlignment" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the alignment of the window (which edge of the available parent client area the window is attached to). </fsummary>
    <desc><p>Sets the alignment of the window (which edge of the available parent client area the window is attached to). 
      </p><p><c>alignment</c> is one of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDefaultSize" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default dimensions of the window. </fsummary>
    <desc><p>Sets the default dimensions of the window. 
      </p><p>The dimension other than the orientation will be fixed to this value, and the orientation dimension will be ignored and the window stretched to fit the available space. 
      </p></desc>
  </func>
  
  <func>
    <name name="setOrientation" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area). </fsummary>
    <desc><p>Sets the orientation of the window (the direction the window will stretch in, to fill the available parent client area). 
      </p><p><c>orientation</c> is one of wxLAYOUT_HORIZONTAL, wxLAYOUT_VERTICAL. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
