1wxNotebook(3)              Erlang Module Definition              wxNotebook(3)
2
3
4

NAME

6       wxNotebook - See external documentation: wxNotebook.
7

DESCRIPTION

9       See external documentation: wxNotebook.
10
11       This class is derived (and can use functions) from:
12       wxControl
13       wxWindow
14       wxEvtHandler
15

DATA TYPES

17         wxNotebook():
18
19
20           An  object  reference,  The  representation  is internal and can be
21           changed without notice. It can't be used for comparsion  stored  on
22           disc or distributed for use on other nodes.
23

EXPORTS

25       new() -> wxNotebook()
26
27              See external documentation.
28
29       new(Parent, Winid) -> wxNotebook()
30
31              Types:
32
33                 Parent = wxWindow:wxWindow()
34                 Winid = integer()
35
36              Equivalent to new(Parent, Winid, []).
37
38       new(Parent, Winid, Options::[Option]) -> wxNotebook()
39
40              Types:
41
42                 Parent = wxWindow:wxWindow()
43                 Winid = integer()
44                 Option   =   {pos,  {X::integer(),  Y::integer()}}  |  {size,
45                 {W::integer(), H::integer()}} | {style, integer()}
46
47              See external documentation.
48
49       addPage(This, Page, Text) -> boolean()
50
51              Types:
52
53                 This = wxNotebook()
54                 Page = wxWindow:wxWindow()
55                 Text = unicode:chardata()
56
57              Equivalent to addPage(This, Page, Text, []).
58
59       addPage(This, Page, Text, Options::[Option]) -> boolean()
60
61              Types:
62
63                 This = wxNotebook()
64                 Page = wxWindow:wxWindow()
65                 Text = unicode:chardata()
66                 Option = {bSelect, boolean()} | {imageId, integer()}
67
68              See external documentation.
69
70       advanceSelection(This) -> ok
71
72              Types:
73
74                 This = wxNotebook()
75
76              Equivalent to advanceSelection(This, []).
77
78       advanceSelection(This, Options::[Option]) -> ok
79
80              Types:
81
82                 This = wxNotebook()
83                 Option = {forward, boolean()}
84
85              See external documentation.
86
87       assignImageList(This, ImageList) -> ok
88
89              Types:
90
91                 This = wxNotebook()
92                 ImageList = wxImageList:wxImageList()
93
94              See external documentation.
95
96       create(This, Parent, Id) -> boolean()
97
98              Types:
99
100                 This = wxNotebook()
101                 Parent = wxWindow:wxWindow()
102                 Id = integer()
103
104              Equivalent to create(This, Parent, Id, []).
105
106       create(This, Parent, Id, Options::[Option]) -> boolean()
107
108              Types:
109
110                 This = wxNotebook()
111                 Parent = wxWindow:wxWindow()
112                 Id = integer()
113                 Option  =  {pos,  {X::integer(),  Y::integer()}}   |   {size,
114                 {W::integer(), H::integer()}} | {style, integer()}
115
116              See external documentation.
117
118       deleteAllPages(This) -> boolean()
119
120              Types:
121
122                 This = wxNotebook()
123
124              See external documentation.
125
126       deletePage(This, NPage) -> boolean()
127
128              Types:
129
130                 This = wxNotebook()
131                 NPage = integer()
132
133              See external documentation.
134
135       removePage(This, NPage) -> boolean()
136
137              Types:
138
139                 This = wxNotebook()
140                 NPage = integer()
141
142              See external documentation.
143
144       getCurrentPage(This) -> wxWindow:wxWindow()
145
146              Types:
147
148                 This = wxNotebook()
149
150              See external documentation.
151
152       getImageList(This) -> wxImageList:wxImageList()
153
154              Types:
155
156                 This = wxNotebook()
157
158              See external documentation.
159
160       getPage(This, N) -> wxWindow:wxWindow()
161
162              Types:
163
164                 This = wxNotebook()
165                 N = integer()
166
167              See external documentation.
168
169       getPageCount(This) -> integer()
170
171              Types:
172
173                 This = wxNotebook()
174
175              See external documentation.
176
177       getPageImage(This, NPage) -> integer()
178
179              Types:
180
181                 This = wxNotebook()
182                 NPage = integer()
183
184              See external documentation.
185
186       getPageText(This, NPage) -> unicode:charlist()
187
188              Types:
189
190                 This = wxNotebook()
191                 NPage = integer()
192
193              See external documentation.
194
195       getRowCount(This) -> integer()
196
197              Types:
198
199                 This = wxNotebook()
200
201              See external documentation.
202
203       getSelection(This) -> integer()
204
205              Types:
206
207                 This = wxNotebook()
208
209              See external documentation.
210
211       getThemeBackgroundColour(This) -> wx:wx_colour4()
212
213              Types:
214
215                 This = wxNotebook()
216
217              See external documentation.
218
219       hitTest(This, Pt) -> Result
220
221              Types:
222
223                 Result = {Res::integer(), Flags::integer()}
224                 This = wxNotebook()
225                 Pt = {X::integer(), Y::integer()}
226
227              See external documentation.
228
229       insertPage(This, Position, Win, StrText) -> boolean()
230
231              Types:
232
233                 This = wxNotebook()
234                 Position = integer()
235                 Win = wxWindow:wxWindow()
236                 StrText = unicode:chardata()
237
238              Equivalent to insertPage(This, Position, Win, StrText, []).
239
240       insertPage(This,  Position,  Win,  StrText, Options::[Option]) -> bool‐
241       ean()
242
243              Types:
244
245                 This = wxNotebook()
246                 Position = integer()
247                 Win = wxWindow:wxWindow()
248                 StrText = unicode:chardata()
249                 Option = {bSelect, boolean()} | {imageId, integer()}
250
251              See external documentation.
252
253       setImageList(This, ImageList) -> ok
254
255              Types:
256
257                 This = wxNotebook()
258                 ImageList = wxImageList:wxImageList()
259
260              See external documentation.
261
262       setPadding(This, Padding) -> ok
263
264              Types:
265
266                 This = wxNotebook()
267                 Padding = {W::integer(), H::integer()}
268
269              See external documentation.
270
271       setPageSize(This, Size) -> ok
272
273              Types:
274
275                 This = wxNotebook()
276                 Size = {W::integer(), H::integer()}
277
278              See external documentation.
279
280       setPageImage(This, NPage, NImage) -> boolean()
281
282              Types:
283
284                 This = wxNotebook()
285                 NPage = integer()
286                 NImage = integer()
287
288              See external documentation.
289
290       setPageText(This, NPage, StrText) -> boolean()
291
292              Types:
293
294                 This = wxNotebook()
295                 NPage = integer()
296                 StrText = unicode:chardata()
297
298              See external documentation.
299
300       setSelection(This, NPage) -> integer()
301
302              Types:
303
304                 This = wxNotebook()
305                 NPage = integer()
306
307              See external documentation.
308
309       changeSelection(This, NPage) -> integer()
310
311              Types:
312
313                 This = wxNotebook()
314                 NPage = integer()
315
316              See external documentation.
317
318       destroy(This::wxNotebook()) -> ok
319
320              Destroys this object, do not use object again
321

AUTHORS

323       <>
324
325
326
327                                   wx 1.8.7                      wxNotebook(3)
Impressum