<?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>wxChoice</title>
</header>
<module>wxChoice</module>
<modulesummary>Functions for wxChoice class</modulesummary>
<description><p>A choice item is used to select one of a list of strings. Unlike a <seeerl marker="wxListBox"><c>wxListBox</c></seeerl>, only the selection is visible until the user pulls down the menu of choices.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxListBox"><c>wxListBox</c></seeerl>, <seeerl marker="wxComboBox"><c>wxComboBox</c></seeerl>, <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxControlWithItems"><c>wxControlWithItems</c></seeerl> <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_choice.html">wxChoice</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_choice_selected</c></seeerl></p></section>
<datatypes><datatype><name name="wxChoice"/></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/7"><c>create/7</c></seemfa>, <c>wxValidator</c> (not implemented in wx)
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a choice. </fsummary>
    <desc><p>Constructor, creating and showing a choice. 
      </p><p>See: <seemfa marker="#create/7"><c>create/7</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 choice item. </fsummary>
    <desc><p>Destructor, destroying the choice item. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="6" clause_i="1" since=""/>
    <fsummary>See: <c>create/7</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="7" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="delete" arity="2" clause_i="1" since=""/>
    <fsummary>Deletes an item from the control. </fsummary>
    <desc><p>Deletes an item from the control. 
      </p><p>The client data associated with the item will be also deleted if it is owned by the control. Note that it is an error (signalled by an assert failure in debug builds) to remove an item with the index negative or greater or equal than the number of items in the control.
      </p><p>If there is a currently selected item below the item being deleted, i.e. if <seemfa marker="wxControlWithItems#getSelection/1"><c>wxControlWithItems:getSelection/1</c></seemfa> returns a valid index greater than or equal to <c>n</c>, the selection is invalidated when this function is called. However if the selected item appears before the item being deleted, the selection is preserved unchanged.
      </p><p>See: <seemfa marker="wxControlWithItems#clear/1"><c>wxControlWithItems:clear/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getColumns" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the number of columns in this choice item. </fsummary>
    <desc><p>Gets the number of columns in this choice item. 
      </p><p>Remark: This is implemented for GTK and Motif only and always returns 1 for the other platforms. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColumns" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>setColumns/2</c></fsummary>
  </func>
  
  <func>
    <name name="setColumns" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the number of columns in this choice item. </fsummary>
    <desc><p>Sets the number of columns in this choice item. 
      </p><p>Remark: This is implemented for GTK and Motif only and doesn’t do anything under other platforms. 
      </p></desc>
  </func>
  </funcs>
</erlref>
