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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxTipProvider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classwx_tip_provider-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxTipProvider Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__group__class__misc.html">Miscellaneous</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/tipdlg.h></code></p>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is the class used together with <a class="el" href="group__group__funcmacro__dialog.html#ga71723a35f5e98349f5a79d7a025dac07" title="This function shows a "startup tip" to the user.">wxShowTip()</a> function. </p>
<p>It must implement <a class="el" href="classwx_tip_provider.html#a82f7aea7a77b67707bc265bab365eb49" title="Return the text of the current tip and pass to the next one.">wxTipProvider::GetTip</a> function and return the current tip from it (different tip each time it is called).</p>
<p>You will never use this class yourself, but you need it to show startup tips with wxShowTip. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from <a class="el" href="classwx_tip_provider.html" title="This is the class used together with wxShowTip() function.">wxTipProvider</a> and use it instead of the one returned by <a class="el" href="group__group__funcmacro__dialog.html#ga9cc492bddff104d3afceca94ae945f38" title="This function creates a wxTipProvider which may be used with wxShowTip().">wxCreateFileTipProvider()</a>.</p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxadv">wxAdvanced</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__misc.html">Miscellaneous</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="overview_tips.html">wxTipProvider Overview</a>, <a class="el" href="group__group__funcmacro__dialog.html#ga71723a35f5e98349f5a79d7a025dac07" title="This function shows a "startup tip" to the user.">wxShowTip</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af2509a4e7eadc624198d06bf4e99717e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_tip_provider.html#af2509a4e7eadc624198d06bf4e99717e">wxTipProvider</a> (size_t currentTip)</td></tr>
<tr class="memdesc:af2509a4e7eadc624198d06bf4e99717e"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#af2509a4e7eadc624198d06bf4e99717e"></a><br/></td></tr>
<tr class="separator:af2509a4e7eadc624198d06bf4e99717e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af857c316bdea09ae6207fc8743e44cfb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_tip_provider.html#af857c316bdea09ae6207fc8743e44cfb">~wxTipProvider</a> ()</td></tr>
<tr class="separator:af857c316bdea09ae6207fc8743e44cfb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acff065db246be564d5e888210d99e0fc"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_tip_provider.html#acff065db246be564d5e888210d99e0fc">GetCurrentTip</a> () const </td></tr>
<tr class="memdesc:acff065db246be564d5e888210d99e0fc"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of the current tip (i.e. the one which would be returned by <a class="el" href="classwx_tip_provider.html#a82f7aea7a77b67707bc265bab365eb49" title="Return the text of the current tip and pass to the next one.">GetTip()</a>). <a href="#acff065db246be564d5e888210d99e0fc"></a><br/></td></tr>
<tr class="separator:acff065db246be564d5e888210d99e0fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82f7aea7a77b67707bc265bab365eb49"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_tip_provider.html#a82f7aea7a77b67707bc265bab365eb49">GetTip</a> ()=0</td></tr>
<tr class="memdesc:a82f7aea7a77b67707bc265bab365eb49"><td class="mdescLeft"> </td><td class="mdescRight">Return the text of the current tip and pass to the next one. <a href="#a82f7aea7a77b67707bc265bab365eb49"></a><br/></td></tr>
<tr class="separator:a82f7aea7a77b67707bc265bab365eb49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91c0e04e803102a917e83278d4b626ea"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_tip_provider.html#a91c0e04e803102a917e83278d4b626ea">PreprocessTip</a> (const <a class="el" href="classwx_string.html">wxString</a> &tip)</td></tr>
<tr class="memdesc:a91c0e04e803102a917e83278d4b626ea"><td class="mdescLeft"> </td><td class="mdescRight">Returns a modified tip. <a href="#a91c0e04e803102a917e83278d4b626ea"></a><br/></td></tr>
<tr class="separator:a91c0e04e803102a917e83278d4b626ea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="af2509a4e7eadc624198d06bf4e99717e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxTipProvider::wxTipProvider </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>currentTip</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">currentTip</td><td>The starting tip index. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="af857c316bdea09ae6207fc8743e44cfb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxTipProvider::~wxTipProvider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acff065db246be564d5e888210d99e0fc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t wxTipProvider::GetCurrentTip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the index of the current tip (i.e. the one which would be returned by <a class="el" href="classwx_tip_provider.html#a82f7aea7a77b67707bc265bab365eb49" title="Return the text of the current tip and pass to the next one.">GetTip()</a>). </p>
<p>The program usually remembers the value returned by this function after calling <a class="el" href="group__group__funcmacro__dialog.html#ga71723a35f5e98349f5a79d7a025dac07" title="This function shows a "startup tip" to the user.">wxShowTip()</a>. Note that it is not the same as the value which was passed to wxShowTip + 1 because the user might have pressed the "Next" button in the tip dialog. </p>
</div>
</div>
<a class="anchor" id="a82f7aea7a77b67707bc265bab365eb49"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_string.html">wxString</a> wxTipProvider::GetTip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the text of the current tip and pass to the next one. </p>
<p>This function is pure virtual, it should be implemented in the derived classes. </p>
</div>
</div>
<a class="anchor" id="a91c0e04e803102a917e83278d4b626ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_string.html">wxString</a> wxTipProvider::PreprocessTip </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>tip</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a modified tip. </p>
<p>This function will be called immediately after read, and before being check whether it is a comment, an empty string or a string to translate. You can optionally override this in your custom user-derived class to optionally to modify the tip as soon as it is read. You can return any modification to the string. If you return wxEmptyString, then this tip is skipped, and the next one is read. </p>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:47:01 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|
