<?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>wxToolTip</title>
</header>
<module>wxToolTip</module>
<modulesummary>Functions for wxToolTip class</modulesummary>
<description><p>This class holds information about a tooltip associated with a window (see <seemfa marker="wxWindow#setToolTip/2"><c>wxWindow:setToolTip/2</c></seemfa>).
      </p><p>The four static methods, <seemfa marker="#enable/1"><c>enable/1</c></seemfa>, <seemfa marker="#setDelay/1"><c>setDelay/1</c></seemfa> <c>wxToolTip::SetAutoPop()</c> (not implemented in wx) and <c>wxToolTip::SetReshow()</c> (not implemented in wx) can be used to globally alter tooltips behaviour.
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_tool_tip.html">wxToolTip</url></p>
  </description>
<datatypes><datatype><name name="wxToolTip"/></datatype></datatypes>

<funcs>
  <func>
    <name name="enable" arity="1" clause_i="1" since=""/>
    <fsummary>Enable or disable tooltips globally. </fsummary>
    <desc><p>Enable or disable tooltips globally. 
      </p><p>Note: May not be supported on all platforms (eg. wxCocoa). 
      </p></desc>
  </func>
  
  <func>
    <name name="setDelay" arity="1" clause_i="1" since=""/>
    <fsummary>Set the delay after which the tooltip appears. </fsummary>
    <desc><p>Set the delay after which the tooltip appears. 
      </p><p>Note: May not be supported on all platforms. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="setTip" arity="2" clause_i="1" since=""/>
    <fsummary>Set the tooltip text. </fsummary>
    <desc><p>Set the tooltip text. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTip" arity="1" clause_i="1" since=""/>
    <fsummary>Get the tooltip text. </fsummary>
    <desc><p>Get the tooltip text. 
      </p></desc>
  </func>
  
  <func>
    <name name="getWindow" arity="1" clause_i="1" since=""/>
    <fsummary>Get the associated window. </fsummary>
    <desc><p>Get the associated window. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
