<?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>wxStaticBox</title>
</header>
<module>wxStaticBox</module>
<modulesummary>Functions for wxStaticBox class</modulesummary>
<description><p>A static box is a rectangle drawn around other windows to denote a logical grouping of items.
      </p><p>Note that while the previous versions required that windows appearing inside a static box be created as its siblings (i.e. use the same parent as the static box itself), since wxWidgets 2.9.1 it is also possible to create them as children of <seeerl marker="wxStaticBox"><c>wxStaticBox</c></seeerl> itself and you are actually encouraged to do it like this if compatibility with the previous versions is not important.
      </p><p>So the new recommended way to create static box is: 
      </p><p>While the compatible - and now deprecated - way is 
      </p><p>Also note that there is a specialized <seeerl marker="wxSizer"><c>wxSizer</c></seeerl> class (<seeerl marker="wxStaticBoxSizer"><c>wxStaticBoxSizer</c></seeerl>) which can be used as an easier way to pack items into a static box.
      </p><p>See: <seeerl marker="wxStaticText"><c>wxStaticText</c></seeerl>, <seeerl marker="wxStaticBoxSizer"><c>wxStaticBoxSizer</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxControl"><c>wxControl</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_static_box.html">wxStaticBox</url></p>
  </description>
<datatypes><datatype><name name="wxStaticBox"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>new/4</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="4" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a static box. </fsummary>
    <desc><p>Constructor, creating and showing a static box. 
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Constructor for a static box using the given window as label. </fsummary>
    <desc><p>Constructor for a static box using the given window as label. 
      </p><p>This constructor takes a pointer to an arbitrary window (although usually a <seeerl marker="wxCheckBox"><c>wxCheckBox</c></seeerl> or a <seeerl marker="wxRadioButton"><c>wxRadioButton</c></seeerl>) instead of just the usual text label and puts this window at the top of the box at the place where the label would be shown.
      </p><p>The <c>label</c> window must be a non-null, fully created window and will become a child of this <seeerl marker="wxStaticBox"><c>wxStaticBox</c></seeerl>, i.e. it will be owned by this control and will be deleted when the <seeerl marker="wxStaticBox"><c>wxStaticBox</c></seeerl> itself is deleted.
      </p><p>An example of creating a <seeerl marker="wxStaticBox"><c>wxStaticBox</c></seeerl> with window as a label: 
      </p><p>Currently this constructor is only available in wxGTK and wxMSW, use <c>wxHAS_WINDOW_LABEL_IN_STATIC_BOX</c> to check whether it can be used at compile-time.
      </p><p>Since: 3.1.1 Destructor, destroying the group box. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>See: <c>create/5</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="5" clause_i="1" since=""/>
    <fsummary>Creates the static box for two-step construction. </fsummary>
    <desc><p>Creates the static box for two-step construction. 
      </p><p>See <seemfa marker="#new/4"><c>new/4</c></seemfa> for further details. 
      </p></desc>
  </func>
  </funcs>
</erlref>
