<?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>wxCheckBox</title>
</header>
<module>wxCheckBox</module>
<modulesummary>Functions for wxCheckBox class</modulesummary>
<description><p>A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark). Optionally (when the wxCHK_3STATE style flag is set) it can have a third state, called the mixed or undetermined state. Often this is used as a "Does Not Apply" state.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxRadioButton"><c>wxRadioButton</c></seeerl>, <seeerl marker="wxCommandEvent"><c>wxCommandEvent</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_check_box.html">wxCheckBox</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_checkbox_clicked</c></seeerl></p></section>
<datatypes><datatype><name name="wxCheckBox"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
      </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 checkbox. </fsummary>
    <desc><p>Constructor, creating and showing a checkbox. 
      </p><p>See: <seemfa marker="#create/5"><c>create/5</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor, destroying the checkbox. </fsummary>
    <desc><p>Destructor, destroying the checkbox. 
      </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 checkbox for two-step construction. </fsummary>
    <desc><p>Creates the checkbox for two-step construction. 
      </p><p>See <seemfa marker="#new/4"><c>new/4</c></seemfa> for details. 
      </p></desc>
  </func>
  
  <func>
    <name name="getValue" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the state of a 2-state checkbox. </fsummary>
    <desc><p>Gets the state of a 2-state checkbox. 
      </p><p>Return: Returns true if it is checked, false otherwise. 
      </p></desc>
  </func>
  
  <func>
    <name name="get3StateValue" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the state of a 3-state checkbox. </fsummary>
    <desc><p>Gets the state of a 3-state checkbox. 
      </p><p>Asserts when the function is used with a 2-state checkbox. 
      </p></desc>
  </func>
  
  <func>
    <name name="is3rdStateAllowedForUser" arity="1" clause_i="1" since=""/>
    <fsummary>Returns whether or not the user can set the checkbox to the third state. </fsummary>
    <desc><p>Returns whether or not the user can set the checkbox to the third state. 
      </p><p>Return: true if the user can set the third state of this checkbox, false if it can only be set programmatically or if it's a 2-state checkbox. 
      </p></desc>
  </func>
  
  <func>
    <name name="is3State" arity="1" clause_i="1" since=""/>
    <fsummary>Returns whether or not the checkbox is a 3-state checkbox. </fsummary>
    <desc><p>Returns whether or not the checkbox is a 3-state checkbox. 
      </p><p>Return: true if this checkbox is a 3-state checkbox, false if it's a 2-state checkbox. 
      </p></desc>
  </func>
  
  <func>
    <name name="isChecked" arity="1" clause_i="1" since=""/>
    <fsummary>This is just a maybe more readable synonym for <c>getValue/1</c>: just as the latter, it returns true if the checkbox is checked and false otherwise. </fsummary>
    <desc><p>This is just a maybe more readable synonym for <seemfa marker="#getValue/1"><c>getValue/1</c></seemfa>: just as the latter, it returns true if the checkbox is checked and false otherwise. 
      </p></desc>
  </func>
  
  <func>
    <name name="setValue" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the checkbox to the given state. </fsummary>
    <desc><p>Sets the checkbox to the given state. 
      </p><p>This does not cause a <c>wxEVT_CHECKBOX</c> event to get emitted.
      </p></desc>
  </func>
  
  <func>
    <name name="set3StateValue" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the checkbox to the given state. </fsummary>
    <desc><p>Sets the checkbox to the given state. 
      </p><p>This does not cause a <c>wxEVT_CHECKBOX</c> event to get emitted.
      </p><p>Asserts when the checkbox is a 2-state checkbox and setting the state to wxCHK_UNDETERMINED. 
      </p></desc>
  </func>
  </funcs>
</erlref>
