<?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><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxRadioBox</title>
</header>
<module>wxRadioBox</module>
<modulesummary>Functions for wxRadioBox class</modulesummary>
<description><p>A radio box item is used to select one of number of mutually exclusive choices. It is displayed as a vertical column or horizontal row of labelled buttons.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_events.html#overview_events">Overview events</url>, <seeerl marker="wxRadioButton"><c>wxRadioButton</c></seeerl>, <seeerl marker="wxCheckBox"><c>wxCheckBox</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_radio_box.html">wxRadioBox</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_radiobox_selected</c></seeerl></p></section>
<datatypes><datatype><name name="wxRadioBox"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="6" clause_i="1" since=""/>
    <fsummary>See: <c>new/7</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="7" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a radiobox. </fsummary>
    <desc><p>Constructor, creating and showing a radiobox. 
      </p><p>See: <seemfa marker="#create/8"><c>create/8</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 radiobox item. </fsummary>
    <desc><p>Destructor, destroying the radiobox item. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="7" clause_i="1" since=""/>
    <fsummary>See: <c>create/8</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="8" clause_i="1" since=""/>
    <fsummary>Creates the radiobox for two-step construction. </fsummary>
    <desc><p>Creates the radiobox for two-step construction. 
      </p><p>See <seemfa marker="#new/7"><c>new/7</c></seemfa> for further details. 
      </p></desc>
  </func>
  
  <func>
    <name name="enable" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>enable/2</c></fsummary>
  </func>
  
  <func>
    <name name="enable" arity="2" clause_i="1" since=""/>
  
    <name name="enable" arity="2" clause_i="2" since=""/>
    <fsummary>Enables or disables the radiobox. </fsummary>
    <desc><p>Enables or disables the radiobox. 
      </p><p>See: <seemfa marker="wxWindow#enable/2"><c>wxWindow:enable/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="enable" arity="3" clause_i="1" since=""/>
    <fsummary>Enables or disables an individual button in the radiobox. </fsummary>
    <desc><p>Enables or disables an individual button in the radiobox. 
      </p><p>See: <seemfa marker="wxWindow#enable/2"><c>wxWindow:enable/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getSelection" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the index of the selected item or <c>wxNOT_FOUND</c> if no item is selected. </fsummary>
    <desc><p>Returns the index of the selected item or <c>wxNOT_FOUND</c> if no item is selected. 
      </p><p>Return: The position of the current selection.
      </p><p>Remark: This method can be used with single selection list boxes only, you should use <seemfa marker="wxListBox#getSelections/1"><c>wxListBox:getSelections/1</c></seemfa> for the list boxes with wxLB_MULTIPLE style.
      </p><p>See: <seemfa marker="#setSelection/2"><c>setSelection/2</c></seemfa>, <seemfa marker="wxControlWithItems#getStringSelection/1"><c>wxControlWithItems:getStringSelection/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getString" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the label of the item with the given index. </fsummary>
    <desc><p>Returns the label of the item with the given index. 
      </p><p>Return: The label of the item or an empty string if the position was invalid. 
      </p></desc>
  </func>
  
  <func>
    <name name="setSelection" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the selection to the given item. </fsummary>
    <desc><p>Sets the selection to the given item. 
      </p><p>Notice that a radio box always has selection, so <c>n</c> must be valid here and passing <c>wxNOT_FOUND</c> is not allowed. 
      </p></desc>
  </func>
  
  <func>
    <name name="show" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>show/3</c></fsummary>
  </func>
  
  <func>
    <name name="show" arity="3" clause_i="1" since=""/>
    <fsummary>Shows or hides individual buttons. </fsummary>
    <desc><p>Shows or hides individual buttons. 
      </p><p>Return: true if the item has been shown or hidden or false if nothing was done because it already was in the requested state.
      </p><p>See: <seemfa marker="#show/3"><c>show/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getColumnCount" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of columns in the radiobox. </fsummary>
    <desc><p>Returns the number of columns in the radiobox. 
      </p></desc>
  </func>
  
  <func>
    <name name="getItemHelpText" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the helptext associated with the specified <c>item</c> if any or <c>wxEmptyString</c>. </fsummary>
    <desc><p>Returns the helptext associated with the specified <c>item</c> if any or <c>wxEmptyString</c>. 
      </p><p>See: <seemfa marker="#setItemHelpText/3"><c>setItemHelpText/3</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getItemToolTip" arity="2" clause_i="1" since=""/>
    <fsummary>Returns the tooltip associated with the specified <c>item</c> if any or NULL. </fsummary>
    <desc><p>Returns the tooltip associated with the specified <c>item</c> if any or NULL. 
      </p><p>See: <seemfa marker="#setItemToolTip/3"><c>setItemToolTip/3</c></seemfa>, <seemfa marker="wxWindow#getToolTip/1"><c>wxWindow:getToolTip/1</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="getItemFromPoint" arity="2" clause_i="1" since=""/>
    <fsummary>Returns a radio box item under the point, a zero-based item index, or <c>wxNOT_FOUND</c> if no item is under the point. </fsummary>
    <desc><p>Returns a radio box item under the point, a zero-based item index, or <c>wxNOT_FOUND</c> if no item is under the point. 
      </p></desc>
  </func>
  
  <func>
    <name name="getRowCount" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the number of rows in the radiobox. </fsummary>
    <desc><p>Returns the number of rows in the radiobox. 
      </p></desc>
  </func>
  
  <func>
    <name name="isItemEnabled" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the item is enabled or false if it was disabled using <c>enable/3</c>. </fsummary>
    <desc><p>Returns true if the item is enabled or false if it was disabled using <seemfa marker="#enable/3"><c>enable/3</c></seemfa>. 
      </p><p>This function is currently only implemented in wxMSW, wxGTK, wxQT and wxUniversal and always returns true in the other ports.
      </p></desc>
  </func>
  
  <func>
    <name name="isItemShown" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the item is currently shown or false if it was hidden using <c>show/3</c>. </fsummary>
    <desc><p>Returns true if the item is currently shown or false if it was hidden using <seemfa marker="#show/3"><c>show/3</c></seemfa>. 
      </p><p>Note that this function returns true for an item which hadn't been hidden even if the entire radiobox is not currently shown.
      </p><p>This function is currently only implemented in wxMSW, wxGTK, wxQT and wxUniversal and always returns true in the other ports.
      </p></desc>
  </func>
  
  <func>
    <name name="setItemHelpText" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the helptext for an item. </fsummary>
    <desc><p>Sets the helptext for an item. 
      </p><p>Empty string erases any existing helptext.
      </p><p>See: <seemfa marker="#getItemHelpText/2"><c>getItemHelpText/2</c></seemfa>
      </p></desc>
  </func>
  
  <func>
    <name name="setItemToolTip" arity="3" clause_i="1" since=""/>
    <fsummary>Sets the tooltip text for the specified item in the radio group. </fsummary>
    <desc><p>Sets the tooltip text for the specified item in the radio group. 
      </p><p>This function is currently only implemented in wxMSW and wxGTK2 and does nothing in the other ports.
      </p><p>See: <seemfa marker="#getItemToolTip/2"><c>getItemToolTip/2</c></seemfa>, <seemfa marker="wxWindow#setToolTip/2"><c>wxWindow:setToolTip/2</c></seemfa>
      </p></desc>
  </func>
  </funcs>
</erlref>
