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

NAME

6       wxTreeCtrl - See external documentation: wxTreeCtrl.
7

DESCRIPTION

9       See external documentation: wxTreeCtrl.
10
11       Note: The representation of treeItemId() have changed from the original
12       class implementation to be an semi-opaque type,Equality between TreeIt‐
13       emId's can be tested and zero means that the TreeItem is invalid.
14

DATA TYPES

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

EXPORTS

24       new() -> wxTreeCtrl()
25
26              See external documentation.
27
28       new(Parent) -> wxTreeCtrl()
29
30              Types:
31
32                 Parent = wxWindow:wxWindow()
33
34              Equivalent to new(Parent, []).
35
36       new(Parent, Options::[Option]) -> wxTreeCtrl()
37
38              Types:
39
40                 Parent = wxWindow:wxWindow()
41                 Option  =  {id,  integer()}  |  {pos, {X::integer(), Y::inte‐
42                 ger()}} |  {size,  {W::integer(),  H::integer()}}  |  {style,
43                 integer()} | {validator, wx:wx_object()}
44
45              See external documentation.
46
47       addRoot(This, Text) -> integer()
48
49              Types:
50
51                 This = wxTreeCtrl()
52                 Text = unicode:chardata()
53
54              Equivalent to addRoot(This, Text, []).
55
56       addRoot(This, Text, Options::[Option]) -> integer()
57
58              Types:
59
60                 This = wxTreeCtrl()
61                 Text = unicode:chardata()
62                 Option  =  {image,  integer()} | {selectedImage, integer()} |
63                 {data, term()}
64
65              See external documentation.
66
67       appendItem(This, Parent, Text) -> integer()
68
69              Types:
70
71                 This = wxTreeCtrl()
72                 Parent = integer()
73                 Text = unicode:chardata()
74
75              Equivalent to appendItem(This, Parent, Text, []).
76
77       appendItem(This, Parent, Text, Options::[Option]) -> integer()
78
79              Types:
80
81                 This = wxTreeCtrl()
82                 Parent = integer()
83                 Text = unicode:chardata()
84                 Option = {image, integer()} |  {selectedImage,  integer()}  |
85                 {data, term()}
86
87              See external documentation.
88
89       assignImageList(This, ImageList) -> ok
90
91              Types:
92
93                 This = wxTreeCtrl()
94                 ImageList = wxImageList:wxImageList()
95
96              See external documentation.
97
98       assignStateImageList(This, ImageList) -> ok
99
100              Types:
101
102                 This = wxTreeCtrl()
103                 ImageList = wxImageList:wxImageList()
104
105              See external documentation.
106
107       collapse(This, Item) -> ok
108
109              Types:
110
111                 This = wxTreeCtrl()
112                 Item = integer()
113
114              See external documentation.
115
116       collapseAndReset(This, Item) -> ok
117
118              Types:
119
120                 This = wxTreeCtrl()
121                 Item = integer()
122
123              See external documentation.
124
125       create(This, Parent) -> boolean()
126
127              Types:
128
129                 This = wxTreeCtrl()
130                 Parent = wxWindow:wxWindow()
131
132              Equivalent to create(This, Parent, []).
133
134       create(This, Parent, Options::[Option]) -> boolean()
135
136              Types:
137
138                 This = wxTreeCtrl()
139                 Parent = wxWindow:wxWindow()
140                 Option  =  {id,  integer()}  |  {pos, {X::integer(), Y::inte‐
141                 ger()}} |  {size,  {W::integer(),  H::integer()}}  |  {style,
142                 integer()} | {validator, wx:wx_object()}
143
144              See external documentation.
145
146       delete(This, Item) -> ok
147
148              Types:
149
150                 This = wxTreeCtrl()
151                 Item = integer()
152
153              See external documentation.
154
155       deleteAllItems(This) -> ok
156
157              Types:
158
159                 This = wxTreeCtrl()
160
161              See external documentation.
162
163       deleteChildren(This, Item) -> ok
164
165              Types:
166
167                 This = wxTreeCtrl()
168                 Item = integer()
169
170              See external documentation.
171
172       editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()
173
174              Types:
175
176                 This = wxTreeCtrl()
177                 Item = integer()
178
179              See external documentation.
180
181       ensureVisible(This, Item) -> ok
182
183              Types:
184
185                 This = wxTreeCtrl()
186                 Item = integer()
187
188              See external documentation.
189
190       expand(This, Item) -> ok
191
192              Types:
193
194                 This = wxTreeCtrl()
195                 Item = integer()
196
197              See external documentation.
198
199       getBoundingRect(This, Item) -> Result
200
201              Types:
202
203                 Result  = {Res::boolean(), Rect::{X::integer(), Y::integer(),
204                 W::integer(), H::integer()}}
205                 This = wxTreeCtrl()
206                 Item = integer()
207
208              Equivalent to getBoundingRect(This, Item, []).
209
210       getBoundingRect(This, Item, Options::[Option]) -> Result
211
212              Types:
213
214                 Result = {Res::boolean(), Rect::{X::integer(),  Y::integer(),
215                 W::integer(), H::integer()}}
216                 This = wxTreeCtrl()
217                 Item = integer()
218                 Option = {textOnly, boolean()}
219
220              See external documentation.
221
222       getChildrenCount(This, Item) -> integer()
223
224              Types:
225
226                 This = wxTreeCtrl()
227                 Item = integer()
228
229              Equivalent to getChildrenCount(This, Item, []).
230
231       getChildrenCount(This, Item, Options::[Option]) -> integer()
232
233              Types:
234
235                 This = wxTreeCtrl()
236                 Item = integer()
237                 Option = {recursively, boolean()}
238
239              See external documentation.
240
241       getCount(This) -> integer()
242
243              Types:
244
245                 This = wxTreeCtrl()
246
247              See external documentation.
248
249       getEditControl(This) -> wxTextCtrl:wxTextCtrl()
250
251              Types:
252
253                 This = wxTreeCtrl()
254
255              See external documentation.
256
257       getFirstChild(This, Item) -> Result
258
259              Types:
260
261                 Result = {Res::integer(), Cookie::integer()}
262                 This = wxTreeCtrl()
263                 Item = integer()
264
265              See external documentation.
266
267       getNextChild(This, Item, Cookie) -> Result
268
269              Types:
270
271                 Result = {Res::integer(), Cookie::integer()}
272                 This = wxTreeCtrl()
273                 Item = integer()
274                 Cookie = integer()
275
276              See external documentation.
277
278       getFirstVisibleItem(This) -> integer()
279
280              Types:
281
282                 This = wxTreeCtrl()
283
284              See external documentation.
285
286       getImageList(This) -> wxImageList:wxImageList()
287
288              Types:
289
290                 This = wxTreeCtrl()
291
292              See external documentation.
293
294       getIndent(This) -> integer()
295
296              Types:
297
298                 This = wxTreeCtrl()
299
300              See external documentation.
301
302       getItemBackgroundColour(This, Item) -> wx:wx_colour4()
303
304              Types:
305
306                 This = wxTreeCtrl()
307                 Item = integer()
308
309              See external documentation.
310
311       getItemData(This, Item) -> term()
312
313              Types:
314
315                 This = wxTreeCtrl()
316                 Item = integer()
317
318              See external documentation.
319
320       getItemFont(This, Item) -> wxFont:wxFont()
321
322              Types:
323
324                 This = wxTreeCtrl()
325                 Item = integer()
326
327              See external documentation.
328
329       getItemImage(This, Item) -> integer()
330
331              Types:
332
333                 This = wxTreeCtrl()
334                 Item = integer()
335
336              See external documentation.
337
338       getItemImage(This, Item, Options::[Option]) -> integer()
339
340              Types:
341
342                 This = wxTreeCtrl()
343                 Item = integer()
344                 Option = {which, wx:wx_enum()}
345
346              See external documentation.
347              Which  =  ?wxTreeItemIcon_Normal  |  ?wxTreeItemIcon_Selected  |
348              ?wxTreeItemIcon_Expanded  |  ?wxTreeItemIcon_SelectedExpanded  |
349              ?wxTreeItemIcon_Max
350
351       getItemText(This, Item) -> unicode:charlist()
352
353              Types:
354
355                 This = wxTreeCtrl()
356                 Item = integer()
357
358              See external documentation.
359
360       getItemTextColour(This, Item) -> wx:wx_colour4()
361
362              Types:
363
364                 This = wxTreeCtrl()
365                 Item = integer()
366
367              See external documentation.
368
369       getLastChild(This, Item) -> integer()
370
371              Types:
372
373                 This = wxTreeCtrl()
374                 Item = integer()
375
376              See external documentation.
377
378       getNextSibling(This, Item) -> integer()
379
380              Types:
381
382                 This = wxTreeCtrl()
383                 Item = integer()
384
385              See external documentation.
386
387       getNextVisible(This, Item) -> integer()
388
389              Types:
390
391                 This = wxTreeCtrl()
392                 Item = integer()
393
394              See external documentation.
395
396       getItemParent(This, Item) -> integer()
397
398              Types:
399
400                 This = wxTreeCtrl()
401                 Item = integer()
402
403              See external documentation.
404
405       getPrevSibling(This, Item) -> integer()
406
407              Types:
408
409                 This = wxTreeCtrl()
410                 Item = integer()
411
412              See external documentation.
413
414       getPrevVisible(This, Item) -> integer()
415
416              Types:
417
418                 This = wxTreeCtrl()
419                 Item = integer()
420
421              See external documentation.
422
423       getRootItem(This) -> integer()
424
425              Types:
426
427                 This = wxTreeCtrl()
428
429              See external documentation.
430
431       getSelection(This) -> integer()
432
433              Types:
434
435                 This = wxTreeCtrl()
436
437              See external documentation.
438
439       getSelections(This) -> Result
440
441              Types:
442
443                 Result = {Res::integer(), Val::[integer()]}
444                 This = wxTreeCtrl()
445
446              See external documentation.
447
448       getStateImageList(This) -> wxImageList:wxImageList()
449
450              Types:
451
452                 This = wxTreeCtrl()
453
454              See external documentation.
455
456       hitTest(This, Point) -> Result
457
458              Types:
459
460                 Result = {Res::integer(), Flags::integer()}
461                 This = wxTreeCtrl()
462                 Point = {X::integer(), Y::integer()}
463
464              See external documentation.
465
466       insertItem(This, Parent, Pos, Text) -> integer()
467
468              Types:
469
470                 This = wxTreeCtrl()
471                 Parent = integer()
472                 Pos = integer()
473                 Text = unicode:chardata()
474
475              Equivalent to insertItem(This, Parent, Pos, Text, []).
476
477       insertItem(This, Parent, Pos, Text, Options::[Option]) -> integer()
478
479              Types:
480
481                 This = wxTreeCtrl()
482                 Parent = integer()
483                 Pos = integer()
484                 Text = unicode:chardata()
485                 Option  = {image, integer()} | {selImage, integer()} | {data,
486                 term()}
487
488              See external documentation.
489
490       isBold(This, Item) -> boolean()
491
492              Types:
493
494                 This = wxTreeCtrl()
495                 Item = integer()
496
497              See external documentation.
498
499       isExpanded(This, Item) -> boolean()
500
501              Types:
502
503                 This = wxTreeCtrl()
504                 Item = integer()
505
506              See external documentation.
507
508       isSelected(This, Item) -> boolean()
509
510              Types:
511
512                 This = wxTreeCtrl()
513                 Item = integer()
514
515              See external documentation.
516
517       isVisible(This, Item) -> boolean()
518
519              Types:
520
521                 This = wxTreeCtrl()
522                 Item = integer()
523
524              See external documentation.
525
526       itemHasChildren(This, Item) -> boolean()
527
528              Types:
529
530                 This = wxTreeCtrl()
531                 Item = integer()
532
533              See external documentation.
534
535       isTreeItemIdOk(Id) -> boolean()
536
537              Types:
538
539                 Id = integer()
540
541              See external documentation.
542
543       prependItem(This, Parent, Text) -> integer()
544
545              Types:
546
547                 This = wxTreeCtrl()
548                 Parent = integer()
549                 Text = unicode:chardata()
550
551              Equivalent to prependItem(This, Parent, Text, []).
552
553       prependItem(This, Parent, Text, Options::[Option]) -> integer()
554
555              Types:
556
557                 This = wxTreeCtrl()
558                 Parent = integer()
559                 Text = unicode:chardata()
560                 Option = {image, integer()} |  {selectedImage,  integer()}  |
561                 {data, term()}
562
563              See external documentation.
564
565       scrollTo(This, Item) -> ok
566
567              Types:
568
569                 This = wxTreeCtrl()
570                 Item = integer()
571
572              See external documentation.
573
574       selectItem(This, Item) -> ok
575
576              Types:
577
578                 This = wxTreeCtrl()
579                 Item = integer()
580
581              See external documentation.
582
583       selectItem(This, Item, Options::[Option]) -> ok
584
585              Types:
586
587                 This = wxTreeCtrl()
588                 Item = integer()
589                 Option = {select, boolean()}
590
591              See external documentation.
592
593       setIndent(This, Indent) -> ok
594
595              Types:
596
597                 This = wxTreeCtrl()
598                 Indent = integer()
599
600              See external documentation.
601
602       setImageList(This, ImageList) -> ok
603
604              Types:
605
606                 This = wxTreeCtrl()
607                 ImageList = wxImageList:wxImageList()
608
609              See external documentation.
610
611       setItemBackgroundColour(This, Item, Col) -> ok
612
613              Types:
614
615                 This = wxTreeCtrl()
616                 Item = integer()
617                 Col = wx:wx_colour()
618
619              See external documentation.
620
621       setItemBold(This, Item) -> ok
622
623              Types:
624
625                 This = wxTreeCtrl()
626                 Item = integer()
627
628              Equivalent to setItemBold(This, Item, []).
629
630       setItemBold(This, Item, Options::[Option]) -> ok
631
632              Types:
633
634                 This = wxTreeCtrl()
635                 Item = integer()
636                 Option = {bold, boolean()}
637
638              See external documentation.
639
640       setItemData(This, Item, Data) -> ok
641
642              Types:
643
644                 This = wxTreeCtrl()
645                 Item = integer()
646                 Data = term()
647
648              See external documentation.
649
650       setItemDropHighlight(This, Item) -> ok
651
652              Types:
653
654                 This = wxTreeCtrl()
655                 Item = integer()
656
657              Equivalent to setItemDropHighlight(This, Item, []).
658
659       setItemDropHighlight(This, Item, Options::[Option]) -> ok
660
661              Types:
662
663                 This = wxTreeCtrl()
664                 Item = integer()
665                 Option = {highlight, boolean()}
666
667              See external documentation.
668
669       setItemFont(This, Item, Font) -> ok
670
671              Types:
672
673                 This = wxTreeCtrl()
674                 Item = integer()
675                 Font = wxFont:wxFont()
676
677              See external documentation.
678
679       setItemHasChildren(This, Item) -> ok
680
681              Types:
682
683                 This = wxTreeCtrl()
684                 Item = integer()
685
686              Equivalent to setItemHasChildren(This, Item, []).
687
688       setItemHasChildren(This, Item, Options::[Option]) -> ok
689
690              Types:
691
692                 This = wxTreeCtrl()
693                 Item = integer()
694                 Option = {has, boolean()}
695
696              See external documentation.
697
698       setItemImage(This, Item, Image) -> ok
699
700              Types:
701
702                 This = wxTreeCtrl()
703                 Item = integer()
704                 Image = integer()
705
706              See external documentation.
707
708       setItemImage(This, Item, Image, Options::[Option]) -> ok
709
710              Types:
711
712                 This = wxTreeCtrl()
713                 Item = integer()
714                 Image = integer()
715                 Option = {which, wx:wx_enum()}
716
717              See external documentation.
718              Which  =  ?wxTreeItemIcon_Normal  |  ?wxTreeItemIcon_Selected  |
719              ?wxTreeItemIcon_Expanded  |  ?wxTreeItemIcon_SelectedExpanded  |
720              ?wxTreeItemIcon_Max
721
722       setItemText(This, Item, Text) -> ok
723
724              Types:
725
726                 This = wxTreeCtrl()
727                 Item = integer()
728                 Text = unicode:chardata()
729
730              See external documentation.
731
732       setItemTextColour(This, Item, Col) -> ok
733
734              Types:
735
736                 This = wxTreeCtrl()
737                 Item = integer()
738                 Col = wx:wx_colour()
739
740              See external documentation.
741
742       setStateImageList(This, ImageList) -> ok
743
744              Types:
745
746                 This = wxTreeCtrl()
747                 ImageList = wxImageList:wxImageList()
748
749              See external documentation.
750
751       setWindowStyle(This, Styles) -> ok
752
753              Types:
754
755                 This = wxTreeCtrl()
756                 Styles = integer()
757
758              See external documentation.
759
760       sortChildren(This, Item) -> ok
761
762              Types:
763
764                 This = wxTreeCtrl()
765                 Item = integer()
766
767              See external documentation.
768
769       toggle(This, Item) -> ok
770
771              Types:
772
773                 This = wxTreeCtrl()
774                 Item = integer()
775
776              See external documentation.
777
778       toggleItemSelection(This, Item) -> ok
779
780              Types:
781
782                 This = wxTreeCtrl()
783                 Item = integer()
784
785              See external documentation.
786
787       unselect(This) -> ok
788
789              Types:
790
791                 This = wxTreeCtrl()
792
793              See external documentation.
794
795       unselectAll(This) -> ok
796
797              Types:
798
799                 This = wxTreeCtrl()
800
801              See external documentation.
802
803       unselectItem(This, Item) -> ok
804
805              Types:
806
807                 This = wxTreeCtrl()
808                 Item = integer()
809
810              See external documentation.
811
812       destroy(This::wxTreeCtrl()) -> ok
813
814              Destroys this object, do not use object again
815

AUTHORS

817       <>
818
819
820
821                                   wx 1.8.3                      wxTreeCtrl(3)
Impressum