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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
|
<HTML>
<head><title>wxTabCtrl</title></head>
<BODY BGCOLOR=#FFFFFF>
<A NAME="wxtabctrl"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx232.htm#wxtabview"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx234.htm#wxtabevent"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>
<H2>wxTabCtrl</H2>
<P>
This class represents a tab control, which manages multiple tabs.<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx56.htm#wxcontrol">wxControl</A><BR>
<A HREF="wx260.htm#wxwindow">wxWindow</A><BR>
<A HREF="wx85.htm#wxevthandler">wxEvtHandler</A><BR>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
<wx/tabctrl.h><P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx234.htm#wxtabevent">wxTabEvent</A>, <A HREF="wx117.htm#wximagelist">wxImageList</A>,
<A HREF="wx156.htm#wxnotebook">wxNotebook</A><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#wxtabctrlconstr">wxTabCtrl::wxTabCtrl</A><BR>
<A HREF="#topic962">wxTabCtrl::~wxTabCtrl</A><BR>
<A HREF="#wxtabctrlcreate">wxTabCtrl::Create</A><BR>
<A HREF="#wxtabctrldeleteallitems">wxTabCtrl::DeleteAllItems</A><BR>
<A HREF="#wxtabctrldeleteitem">wxTabCtrl::DeleteItem</A><BR>
<A HREF="#wxtabctrlgetcurfocus">wxTabCtrl::GetCurFocus</A><BR>
<A HREF="#wxtabctrlgetimagelist">wxTabCtrl::GetImageList</A><BR>
<A HREF="#wxtabctrlgetitemcount">wxTabCtrl::GetItemCount</A><BR>
<A HREF="#wxtabctrlgetitemdata">wxTabCtrl::GetItemData</A><BR>
<A HREF="#wxtabctrlgetitemimage">wxTabCtrl::GetItemImage</A><BR>
<A HREF="#wxtabctrlgetitemrect">wxTabCtrl::GetItemRect</A><BR>
<A HREF="#wxtabctrlgetitemtext">wxTabCtrl::GetItemText</A><BR>
<A HREF="#wxtabctrlgetrowcount">wxTabCtrl::GetRowCount</A><BR>
<A HREF="#wxtabctrlgetselection">wxTabCtrl::GetSelection</A><BR>
<A HREF="#wxtabctrlhittest">wxTabCtrl::HitTest</A><BR>
<A HREF="#wxtabctrlinsertitem">wxTabCtrl::InsertItem</A><BR>
<A HREF="#wxtabctrlsetitemdata">wxTabCtrl::SetItemData</A><BR>
<A HREF="#wxtabctrlsetitemimage">wxTabCtrl::SetItemImage</A><BR>
<A HREF="#wxtabctrlsetimagelist">wxTabCtrl::SetImageList</A><BR>
<A HREF="#wxtabctrlsetitemsize">wxTabCtrl::SetItemSize</A><BR>
<A HREF="#wxtabctrlsetitemtext">wxTabCtrl::SetItemText</A><BR>
<A HREF="#wxtabctrlsetpadding">wxTabCtrl::SetPadding</A><BR>
<A HREF="#wxtabctrlsetselection">wxTabCtrl::SetSelection</A><BR>
<P>
<HR>
<A NAME="wxtabctrlconstr"></A>
<H3>wxTabCtrl::wxTabCtrl</H3>
<P>
<B></B> <B>wxTabCtrl</B>()<P>
Default constructor.<P>
<B></B> <B>wxTabCtrl</B>(<B>wxWindow*</B><I> parent</I>, <B>wxWindowID </B><I>id</I>, <B>const wxPoint&</B><I> pos = wxDefaultPosition</I>,
<B>const wxSize&</B><I> size</I>, <B>long</B><I> style = 0</I>, <B>const wxString& </B><I>name = "tabCtrl"</I>)<P>
Constructs a tab control.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>parent</I><UL><UL>
The parent window. Must be non-NULL.</UL></UL>
<P>
<I>id</I><UL><UL>
The window identifier.</UL></UL>
<P>
<I>pos</I><UL><UL>
The window position.</UL></UL>
<P>
<I>size</I><UL><UL>
The window size.</UL></UL>
<P>
<I>style</I><UL><UL>
The window style. Its value is a bit list of zero or more of <B>wxTC_MULTILINE</B>,
<B>wxTC_RIGHTJUSTIFY</B>, <B>wxTC_FIXEDWIDTH</B> and <B>wxTC_OWNERDRAW</B>.</UL></UL>
<P>
<HR>
<A NAME="topic962"></A>
<H3>wxTabCtrl::~wxTabCtrl</H3>
<P>
<B></B> <B>~wxTabCtrl</B>()<P>
Destroys the wxTabCtrl object.<P>
<HR>
<A NAME="wxtabctrlcreate"></A>
<H3>wxTabCtrl::Create</H3>
<P>
<B>bool</B> <B>Create</B>(<B>wxWindow*</B><I> parent</I>, <B>wxWindowID </B><I>id</I>, <B>const wxPoint&</B><I> pos = wxDefaultPosition</I>,
<B>const wxSize&</B><I> size</I>, <B>long</B><I> style = 0</I>, <B>const wxString& </B><I>name = "tabCtrl"</I>)<P>
Creates a tab control. See <A HREF="wx233.htm#wxtabctrlconstr">wxTabCtrl::wxTabCtrl</A> for a description
of the parameters.<P>
<HR>
<A NAME="wxtabctrldeleteallitems"></A>
<H3>wxTabCtrl::DeleteAllItems</H3>
<P>
<B>bool</B> <B>DeleteAllItems</B>()<P>
Deletes all tab items.<P>
<HR>
<A NAME="wxtabctrldeleteitem"></A>
<H3>wxTabCtrl::DeleteItem</H3>
<P>
<B>bool</B> <B>DeleteItem</B>(<B>int</B><I> item</I>)<P>
Deletes the specified tab item.<P>
<HR>
<A NAME="wxtabctrlgetcurfocus"></A>
<H3>wxTabCtrl::GetCurFocus</H3>
<P>
<B>int</B> <B>GetCurFocus</B>() <B>const</B><P>
Returns the index for the tab with the focus, or -1 if none has the focus.<P>
<HR>
<A NAME="wxtabctrlgetimagelist"></A>
<H3>wxTabCtrl::GetImageList</H3>
<P>
<B>wxImageList*</B> <B>GetImageList</B>() <B>const</B><P>
Returns the associated image list.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx117.htm#wximagelist">wxImageList</A>, <A HREF="wx233.htm#wxtabctrlsetimagelist">wxTabCtrl::SetImageList</A><P>
<HR>
<A NAME="wxtabctrlgetitemcount"></A>
<H3>wxTabCtrl::GetItemCount</H3>
<P>
<B>int</B> <B>GetItemCount</B>() <B>const</B><P>
Returns the number of tabs in the tab control.<P>
<HR>
<A NAME="wxtabctrlgetitemdata"></A>
<H3>wxTabCtrl::GetItemData</H3>
<P>
<B>void*</B> <B>GetItemData</B>() <B>const</B><P>
Returns the client data for the given tab.<P>
<HR>
<A NAME="wxtabctrlgetitemimage"></A>
<H3>wxTabCtrl::GetItemImage</H3>
<P>
<B>int</B> <B>GetItemImage</B>() <B>const</B><P>
Returns the image index for the given tab.<P>
<HR>
<A NAME="wxtabctrlgetitemrect"></A>
<H3>wxTabCtrl::GetItemRect</H3>
<P>
<B>bool</B> <B>GetItemRect</B>(<B>int </B><I>item</I>, <B>wxRect&</B><I> rect</I>) <B>const</B><P>
Returns the rectangle bounding the given tab.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx193.htm#wxrect">wxRect</A><P>
<HR>
<A NAME="wxtabctrlgetitemtext"></A>
<H3>wxTabCtrl::GetItemText</H3>
<P>
<B>wxString</B> <B>GetItemText</B>() <B>const</B><P>
Returns the string for the given tab.<P>
<HR>
<A NAME="wxtabctrlgetrowcount"></A>
<H3>wxTabCtrl::GetRowCount</H3>
<P>
<B>int</B> <B>GetRowCount</B>() <B>const</B><P>
Returns the number of rows in the tab control.<P>
<HR>
<A NAME="wxtabctrlgetselection"></A>
<H3>wxTabCtrl::GetSelection</H3>
<P>
<B>int</B> <B>GetSelection</B>() <B>const</B><P>
Returns the index for the currently selected tab.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx233.htm#wxtabctrlsetselection">wxTabCtrl::SetSelection</A><P>
<HR>
<A NAME="wxtabctrlhittest"></A>
<H3>wxTabCtrl::HitTest</H3>
<P>
<B>int</B> <B>HitTest</B>(<B>const wxPoint&</B><I> pt</I>, <B>long&</B><I> flags</I>)<P>
Tests whether a tab is at the specified position.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>pt</I><UL><UL>
Specifies the point for the hit test.</UL></UL>
<P>
<I>flags</I><UL><UL>
Return value for detailed information. One of the following values:<P>
<TABLE>
<TR><TD VALIGN=TOP>
<B>wxTAB_HITTEST_NOWHERE</B>
</TD>
<TD VALIGN=TOP>
There was no tab under this point.
</TD></TR>
<TR><TD VALIGN=TOP>
<B>wxTAB_HITTEST_ONICON</B>
</TD>
<TD VALIGN=TOP>
The point was over an icon.
</TD></TR>
<TR><TD VALIGN=TOP>
<B>wxTAB_HITTEST_ONLABEL</B>
</TD>
<TD VALIGN=TOP>
The point was over a label.
</TD></TR>
<TR><TD VALIGN=TOP>
<B>wxTAB_HITTEST_ONITEM</B>
</TD>
<TD VALIGN=TOP>
The point was over an item, but not on the label or icon.
</TD></TR>
</TABLE>
</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns the zero-based tab index or -1 if no tab is at the specified position.<P>
<HR>
<A NAME="wxtabctrlinsertitem"></A>
<H3>wxTabCtrl::InsertItem</H3>
<P>
<B>void</B> <B>InsertItem</B>(<B>int</B><I> item</I>, <B>const wxString&</B><I> text</I>, <B>int </B><I>imageId = -1</I>,
<B>void*</B><I> clientData = NULL</I>)<P>
Inserts a new tab.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>item</I><UL><UL>
Specifies the index for the new item.</UL></UL>
<P>
<I>text</I><UL><UL>
Specifies the text for the new item.</UL></UL>
<P>
<I>imageId</I><UL><UL>
Specifies the optional image index for the new item.</UL></UL>
<P>
<I>clientData</I><UL><UL>
Specifies the optional client data for the new item.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if successful, FALSE otherwise.<P>
<HR>
<A NAME="wxtabctrlsetitemdata"></A>
<H3>wxTabCtrl::SetItemData</H3>
<P>
<B>bool</B> <B>SetItemData</B>(<B>int</B><I> item</I>, <B>void*</B><I> data</I>)<P>
Sets the client data for a tab.<P>
<HR>
<A NAME="wxtabctrlsetitemimage"></A>
<H3>wxTabCtrl::SetItemImage</H3>
<P>
<B>bool</B> <B>SetItemImage</B>(<B>int</B><I> item</I>, <B>int </B><I>image</I>)<P>
Sets the image index for the given tab. <I>image</I> is an index into
the image list which was set with <A HREF="wx233.htm#wxtabctrlsetimagelist">wxTabCtrl::SetImageList</A>.<P>
<HR>
<A NAME="wxtabctrlsetimagelist"></A>
<H3>wxTabCtrl::SetImageList</H3>
<P>
<B>void</B> <B>SetImageList</B>(<B>wxImageList*</B><I> imageList</I>)<P>
Sets the image list for the tab control.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx117.htm#wximagelist">wxImageList</A><P>
<HR>
<A NAME="wxtabctrlsetitemsize"></A>
<H3>wxTabCtrl::SetItemSize</H3>
<P>
<B>void</B> <B>SetItemSize</B>(<B>const wxSize&</B><I> size</I>)<P>
Sets the width and height of the tabs.<P>
<HR>
<A NAME="wxtabctrlsetitemtext"></A>
<H3>wxTabCtrl::SetItemText</H3>
<P>
<B>bool</B> <B>SetItemText</B>(<B>int</B><I> item</I>, <B>const wxString& </B><I>text</I>)<P>
Sets the text for the given tab.<P>
<HR>
<A NAME="wxtabctrlsetpadding"></A>
<H3>wxTabCtrl::SetPadding</H3>
<P>
<B>void</B> <B>SetPadding</B>(<B>const wxSize&</B><I> padding</I>)<P>
Sets the amount of space around each tab's icon and label.<P>
<HR>
<A NAME="wxtabctrlsetselection"></A>
<H3>wxTabCtrl::SetSelection</H3>
<P>
<B>int</B> <B>SetSelection</B>(<B>int</B><I> item</I>)<P>
Sets the selection for the given tab, returning the index of the previously
selected tab. Returns -1 if the call was unsuccessful.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx233.htm#wxtabctrlgetselection">wxTabCtrl::GetSelection</A><P>
</BODY></HTML>
|
