<?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>wxControl</title>
</header>
<module>wxControl</module>
<modulesummary>Functions for wxControl class</modulesummary>
<description><p>This is the base class for a control or "widget".
      </p><p>A control is generally a small window which processes user input and/or displays one or more item of data.
      </p><p>See: <c>wxValidator</c> (not implemented in wx)
      </p>
  <p>This class is derived (and can use functions) from: 
    <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_control.html">wxControl</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxClipboardTextEvent"><c>command_text_copy</c></seeerl>, <seeerl marker="wxClipboardTextEvent"><c>command_text_cut</c></seeerl>, <seeerl marker="wxClipboardTextEvent"><c>command_text_paste</c></seeerl></p></section>
<datatypes><datatype><name name="wxControl"/></datatype></datatypes>

<funcs>
  <func>
    <name name="getLabel" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the control's label, as it was passed to <c>setLabel/2</c>. </fsummary>
    <desc><p>Returns the control's label, as it was passed to <seemfa marker="#setLabel/2"><c>setLabel/2</c></seemfa>. 
      </p><p>Note that the returned string may contains mnemonics ("&amp;" characters) if they were passed to the <seemfa marker="#setLabel/2"><c>setLabel/2</c></seemfa> function; use <c>GetLabelText()</c> (not implemented in wx) if they are undesired.
      </p><p>Also note that the returned string is always the string which was passed to <seemfa marker="#setLabel/2"><c>setLabel/2</c></seemfa> but may be different from the string passed to <c>SetLabelText()</c> (not implemented in wx) (since this last one escapes mnemonic characters). 
      </p></desc>
  </func>
  
  <func>
    <name name="setLabel" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the control's label. </fsummary>
    <desc><p>Sets the control's label. 
      </p><p>All "&amp;" characters in the <c>label</c> are special and indicate that the following character is a <c>mnemonic</c> for this control and can be used to activate it from the keyboard (typically by using <c>Alt</c> key in combination with it). To insert a literal ampersand character, you need to double it, i.e. use "&amp;&amp;". If this behaviour is undesirable, use <c>SetLabelText()</c> (not implemented in wx) instead. 
      </p></desc>
  </func>
  </funcs>
</erlref>
