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

AUTHORS

587       <>
588
589
590
591                                   wx 1.9.3                       wxToolBar(3)