summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxToolTip.xml
blob: cce351d3245808996c3ce8f4110dac227879bdc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?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>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>