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

NAME

6       wxToolBar - See external documentation: wxToolBar.
7

DESCRIPTION

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

DATA TYPES

17         wxToolBar():
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       addControl(This, Control) -> wx:wx_object()
26
27              Types:
28
29                 This = wxToolBar()
30                 Control = wxControl:wxControl()
31
32              See external documentation.
33
34       addSeparator(This) -> wx:wx_object()
35
36              Types:
37
38                 This = wxToolBar()
39
40              See external documentation.
41
42       addTool(This, Tool) -> wx:wx_object()
43
44              Types:
45
46                 This = wxToolBar()
47                 Tool = wx:wx_object()
48
49              See external documentation.
50
51       addTool(This, Toolid, Bitmap) -> wx:wx_object()
52
53              Types:
54
55                 This = wxToolBar()
56                 Toolid = integer()
57                 Bitmap = wxBitmap:wxBitmap()
58
59              Equivalent to addTool(This, Toolid, Bitmap, []).
60
61       addTool(This, Toolid, Label, Bitmap) -> wx:wx_object()
62
63              Types:
64
65                 This = wxToolBar()
66                 Toolid = integer()
67                 Label = unicode:chardata()
68                 Bitmap = wxBitmap:wxBitmap()
69
70              See external documentation.
71              Also:
72              addTool(This,  Toolid,  Bitmap,  BmpDisabled)  -> wx:wx_object()
73              when
74              This::wxToolBar(),            Toolid::integer(),            Bit‐
75              map::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap();
76              (This, Toolid, Bitmap, [Option]) -> wx:wx_object() when
77              This::wxToolBar(),            Toolid::integer(),            Bit‐
78              map::wxBitmap:wxBitmap(),
79              Option :: {'shortHelpString', unicode:chardata()}
80              | {'longHelpString', unicode:chardata()}.
81
82
83              Kind = ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  |  ?wxITEM_CHECK  |
84              ?wxITEM_RADIO | ?wxITEM_MAX
85
86       addTool(This, Toolid, Label, Bitmap, BmpDisabled) -> wx:wx_object()
87
88              Types:
89
90                 This = wxToolBar()
91                 Toolid = integer()
92                 Label = unicode:chardata()
93                 Bitmap = wxBitmap:wxBitmap()
94                 BmpDisabled = wxBitmap:wxBitmap()
95
96              See external documentation.
97              Also:
98              addTool(This, Toolid, Label, Bitmap, [Option]) -> wx:wx_object()
99              when
100              This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(),
101              Bitmap::wxBitmap:wxBitmap(),
102              Option :: {'shortHelp', unicode:chardata()}
103              | {'kind', wx:wx_enum()};
104              (This,  Toolid, Bitmap, BmpDisabled, [Option]) -> wx:wx_object()
105              when
106              This::wxToolBar(),            Toolid::integer(),            Bit‐
107              map::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
108              Option :: {'toggle', boolean()}
109              | {'clientData', wx:wx_object()}
110              | {'shortHelpString', unicode:chardata()}
111              | {'longHelpString', unicode:chardata()}.
112
113
114              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
115              ?wxITEM_RADIO | ?wxITEM_MAX
116
117       addTool(This,   Toolid,   Bitmap,   BmpDisabled,   Toggle,   XPos)   ->
118       wx:wx_object()
119
120              Types:
121
122                 This = wxToolBar()
123                 Toolid = integer()
124                 Bitmap = wxBitmap:wxBitmap()
125                 BmpDisabled = wxBitmap:wxBitmap()
126                 Toggle = boolean()
127                 XPos = integer()
128
129              See external documentation.
130              Also:
131              addTool(This,  Toolid,  Label, Bitmap, BmpDisabled, [Option]) ->
132              wx:wx_object() when
133              This::wxToolBar(), Toolid::integer(), Label::unicode:chardata(),
134              Bitmap::wxBitmap:wxBitmap(), BmpDisabled::wxBitmap:wxBitmap(),
135              Option :: {'kind', wx:wx_enum()}
136              | {'shortHelp', unicode:chardata()}
137              | {'longHelp', unicode:chardata()}
138              | {'data', wx:wx_object()}.
139
140
141              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
142              ?wxITEM_RADIO | ?wxITEM_MAX
143
144       addTool(This,    Toolid,    Bitmap,    BmpDisabled,    Toggle,    XPos,
145       Options::[Option]) -> wx:wx_object()
146
147              Types:
148
149                 This = wxToolBar()
150                 Toolid = integer()
151                 Bitmap = wxBitmap:wxBitmap()
152                 BmpDisabled = wxBitmap:wxBitmap()
153                 Toggle = boolean()
154                 XPos = integer()
155                 Option  =  {yPos, integer()} | {clientData, wx:wx_object()} |
156                 {shortHelp, unicode:chardata()}  |  {longHelp,  unicode:char‐
157                 data()}
158
159              See external documentation.
160
161       addCheckTool(This, Toolid, Label, Bitmap) -> wx:wx_object()
162
163              Types:
164
165                 This = wxToolBar()
166                 Toolid = integer()
167                 Label = unicode:chardata()
168                 Bitmap = wxBitmap:wxBitmap()
169
170              Equivalent to addCheckTool(This, Toolid, Label, Bitmap, []).
171
172       addCheckTool(This,   Toolid,   Label,   Bitmap,  Options::[Option])  ->
173       wx:wx_object()
174
175              Types:
176
177                 This = wxToolBar()
178                 Toolid = integer()
179                 Label = unicode:chardata()
180                 Bitmap = wxBitmap:wxBitmap()
181                 Option =  {bmpDisabled,  wxBitmap:wxBitmap()}  |  {shortHelp,
182                 unicode:chardata()} | {longHelp, unicode:chardata()} | {data,
183                 wx:wx_object()}
184
185              See external documentation.
186
187       addRadioTool(This, Toolid, Label, Bitmap) -> wx:wx_object()
188
189              Types:
190
191                 This = wxToolBar()
192                 Toolid = integer()
193                 Label = unicode:chardata()
194                 Bitmap = wxBitmap:wxBitmap()
195
196              Equivalent to addRadioTool(This, Toolid, Label, Bitmap, []).
197
198       addRadioTool(This,  Toolid,  Label,   Bitmap,   Options::[Option])   ->
199       wx:wx_object()
200
201              Types:
202
203                 This = wxToolBar()
204                 Toolid = integer()
205                 Label = unicode:chardata()
206                 Bitmap = wxBitmap:wxBitmap()
207                 Option  =  {bmpDisabled,  wxBitmap:wxBitmap()}  | {shortHelp,
208                 unicode:chardata()} | {longHelp, unicode:chardata()} | {data,
209                 wx:wx_object()}
210
211              See external documentation.
212
213       addStretchableSpace(This) -> wx:wx_object()
214
215              Types:
216
217                 This = wxToolBar()
218
219              See external documentation.
220
221       insertStretchableSpace(This, Pos) -> wx:wx_object()
222
223              Types:
224
225                 This = wxToolBar()
226                 Pos = integer()
227
228              See external documentation.
229
230       deleteTool(This, Toolid) -> boolean()
231
232              Types:
233
234                 This = wxToolBar()
235                 Toolid = integer()
236
237              See external documentation.
238
239       deleteToolByPos(This, Pos) -> boolean()
240
241              Types:
242
243                 This = wxToolBar()
244                 Pos = integer()
245
246              See external documentation.
247
248       enableTool(This, Toolid, Enable) -> ok
249
250              Types:
251
252                 This = wxToolBar()
253                 Toolid = integer()
254                 Enable = boolean()
255
256              See external documentation.
257
258       findById(This, Toolid) -> wx:wx_object()
259
260              Types:
261
262                 This = wxToolBar()
263                 Toolid = integer()
264
265              See external documentation.
266
267       findControl(This, Toolid) -> wxControl:wxControl()
268
269              Types:
270
271                 This = wxToolBar()
272                 Toolid = integer()
273
274              See external documentation.
275
276       findToolForPosition(This, X, Y) -> wx:wx_object()
277
278              Types:
279
280                 This = wxToolBar()
281                 X = integer()
282                 Y = integer()
283
284              See external documentation.
285
286       getToolSize(This) -> {W::integer(), H::integer()}
287
288              Types:
289
290                 This = wxToolBar()
291
292              See external documentation.
293
294       getToolBitmapSize(This) -> {W::integer(), H::integer()}
295
296              Types:
297
298                 This = wxToolBar()
299
300              See external documentation.
301
302       getMargins(This) -> {W::integer(), H::integer()}
303
304              Types:
305
306                 This = wxToolBar()
307
308              See external documentation.
309
310       getToolEnabled(This, Toolid) -> boolean()
311
312              Types:
313
314                 This = wxToolBar()
315                 Toolid = integer()
316
317              See external documentation.
318
319       getToolLongHelp(This, Toolid) -> unicode:charlist()
320
321              Types:
322
323                 This = wxToolBar()
324                 Toolid = integer()
325
326              See external documentation.
327
328       getToolPacking(This) -> integer()
329
330              Types:
331
332                 This = wxToolBar()
333
334              See external documentation.
335
336       getToolPos(This, Id) -> integer()
337
338              Types:
339
340                 This = wxToolBar()
341                 Id = integer()
342
343              See external documentation.
344
345       getToolSeparation(This) -> integer()
346
347              Types:
348
349                 This = wxToolBar()
350
351              See external documentation.
352
353       getToolShortHelp(This, Toolid) -> unicode:charlist()
354
355              Types:
356
357                 This = wxToolBar()
358                 Toolid = integer()
359
360              See external documentation.
361
362       getToolState(This, Toolid) -> boolean()
363
364              Types:
365
366                 This = wxToolBar()
367                 Toolid = integer()
368
369              See external documentation.
370
371       insertControl(This, Pos, Control) -> wx:wx_object()
372
373              Types:
374
375                 This = wxToolBar()
376                 Pos = integer()
377                 Control = wxControl:wxControl()
378
379              See external documentation.
380
381       insertSeparator(This, Pos) -> wx:wx_object()
382
383              Types:
384
385                 This = wxToolBar()
386                 Pos = integer()
387
388              See external documentation.
389
390       insertTool(This, Pos, Tool) -> wx:wx_object()
391
392              Types:
393
394                 This = wxToolBar()
395                 Pos = integer()
396                 Tool = wx:wx_object()
397
398              See external documentation.
399
400       insertTool(This, Pos, Toolid, Bitmap) -> wx:wx_object()
401
402              Types:
403
404                 This = wxToolBar()
405                 Pos = integer()
406                 Toolid = integer()
407                 Bitmap = wxBitmap:wxBitmap()
408
409              Equivalent to insertTool(This, Pos, Toolid, Bitmap, []).
410
411       insertTool(This, Pos, Toolid, Label, Bitmap) -> wx:wx_object()
412
413              Types:
414
415                 This = wxToolBar()
416                 Pos = integer()
417                 Toolid = integer()
418                 Label = unicode:chardata()
419                 Bitmap = wxBitmap:wxBitmap()
420
421              See external documentation.
422              Also:
423              insertTool(This,    Pos,    Toolid,    Bitmap,    [Option])   ->
424              wx:wx_object() when
425              This::wxToolBar(),   Pos::integer(),   Toolid::integer(),   Bit‐
426              map::wxBitmap:wxBitmap(),
427              Option :: {'bmpDisabled', wxBitmap:wxBitmap()}
428              | {'toggle', boolean()}
429              | {'clientData', wx:wx_object()}
430              | {'shortHelp', unicode:chardata()}
431              | {'longHelp', unicode:chardata()}.
432
433
434              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
435              ?wxITEM_RADIO | ?wxITEM_MAX
436
437       insertTool(This, Pos,  Toolid,  Label,  Bitmap,  Options::[Option])  ->
438       wx:wx_object()
439
440              Types:
441
442                 This = wxToolBar()
443                 Pos = integer()
444                 Toolid = integer()
445                 Label = unicode:chardata()
446                 Bitmap = wxBitmap:wxBitmap()
447                 Option   =   {bmpDisabled,   wxBitmap:wxBitmap()}   |  {kind,
448                 wx:wx_enum()} | {shortHelp, unicode:chardata()} |  {longHelp,
449                 unicode:chardata()} | {clientData, wx:wx_object()}
450
451              See external documentation.
452              Kind  =  ?wxITEM_SEPARATOR  |  ?wxITEM_NORMAL  | ?wxITEM_CHECK |
453              ?wxITEM_RADIO | ?wxITEM_MAX
454
455       realize(This) -> boolean()
456
457              Types:
458
459                 This = wxToolBar()
460
461              See external documentation.
462
463       removeTool(This, Toolid) -> wx:wx_object()
464
465              Types:
466
467                 This = wxToolBar()
468                 Toolid = integer()
469
470              See external documentation.
471
472       setMargins(This, X, Y) -> ok
473
474              Types:
475
476                 This = wxToolBar()
477                 X = integer()
478                 Y = integer()
479
480              See external documentation.
481
482       setToolBitmapSize(This, Size) -> ok
483
484              Types:
485
486                 This = wxToolBar()
487                 Size = {W::integer(), H::integer()}
488
489              See external documentation.
490
491       setToolLongHelp(This, Toolid, HelpString) -> ok
492
493              Types:
494
495                 This = wxToolBar()
496                 Toolid = integer()
497                 HelpString = unicode:chardata()
498
499              See external documentation.
500
501       setToolPacking(This, Packing) -> ok
502
503              Types:
504
505                 This = wxToolBar()
506                 Packing = integer()
507
508              See external documentation.
509
510       setToolShortHelp(This, Id, HelpString) -> ok
511
512              Types:
513
514                 This = wxToolBar()
515                 Id = integer()
516                 HelpString = unicode:chardata()
517
518              See external documentation.
519
520       setToolSeparation(This, Separation) -> ok
521
522              Types:
523
524                 This = wxToolBar()
525                 Separation = integer()
526
527              See external documentation.
528
529       toggleTool(This, Toolid, Toggle) -> ok
530
531              Types:
532
533                 This = wxToolBar()
534                 Toolid = integer()
535                 Toggle = boolean()
536
537              See external documentation.
538

AUTHORS

540       <>
541
542
543
544                                   wx 1.8.7                       wxToolBar(3)