1wxTreeCtrl(3) Erlang Module Definition wxTreeCtrl(3)
2
6 wxTreeCtrl - See external documentation: wxTreeCtrl.
7
9 See external documentation: wxTreeCtrl.
10 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
16 wxTreeCtrl():
17 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
24 new() -> wxTreeCtrl()
25 See external documentation.
27 new(Parent) -> wxTreeCtrl()
29 Types:
31 Parent = wxWindow:wxWindow()
33 Equivalent to new(Parent, []).
35 new(Parent, Options::[Option]) -> wxTreeCtrl()
37 Types:
39 Parent = wxWindow:wxWindow()
41 Option = {id, integer()} | {pos, {X::integer(), Y::inte‐
42 ger()}} | {size, {W::integer(), H::integer()}} | {style, in‐
43 teger()} | {validator, wx:wx_object()}
44 See external documentation.
46 addRoot(This, Text) -> integer()
48 Types:
50 This = wxTreeCtrl()
52 Text = unicode:chardata()
53 Equivalent to addRoot(This, Text, []).
55 addRoot(This, Text, Options::[Option]) -> integer()
57 Types:
59 This = wxTreeCtrl()
61 Text = unicode:chardata()
62 Option = {image, integer()} | {selectedImage, integer()} |
63 {data, term()}
64 See external documentation.
66 appendItem(This, Parent, Text) -> integer()
68 Types:
70 This = wxTreeCtrl()
72 Parent = integer()
73 Text = unicode:chardata()
74 Equivalent to appendItem(This, Parent, Text, []).
76 appendItem(This, Parent, Text, Options::[Option]) -> integer()
78 Types:
80 This = wxTreeCtrl()
82 Parent = integer()
83 Text = unicode:chardata()
84 Option = {image, integer()} | {selectedImage, integer()} |
85 {data, term()}
86 See external documentation.
88 assignImageList(This, ImageList) -> ok
90 Types:
92 This = wxTreeCtrl()
94 ImageList = wxImageList:wxImageList()
95 See external documentation.
97 assignStateImageList(This, ImageList) -> ok
99 Types:
101 This = wxTreeCtrl()
103 ImageList = wxImageList:wxImageList()
104 See external documentation.
106 collapse(This, Item) -> ok
108 Types:
110 This = wxTreeCtrl()
112 Item = integer()
113 See external documentation.
115 collapseAndReset(This, Item) -> ok
117 Types:
119 This = wxTreeCtrl()
121 Item = integer()
122 See external documentation.
124 create(This, Parent) -> boolean()
126 Types:
128 This = wxTreeCtrl()
130 Parent = wxWindow:wxWindow()
131 Equivalent to create(This, Parent, []).
133 create(This, Parent, Options::[Option]) -> boolean()
135 Types:
137 This = wxTreeCtrl()
139 Parent = wxWindow:wxWindow()
140 Option = {id, integer()} | {pos, {X::integer(), Y::inte‐
141 ger()}} | {size, {W::integer(), H::integer()}} | {style, in‐
142 teger()} | {validator, wx:wx_object()}
143 See external documentation.
145 delete(This, Item) -> ok
147 Types:
149 This = wxTreeCtrl()
151 Item = integer()
152 See external documentation.
154 deleteAllItems(This) -> ok
156 Types:
158 This = wxTreeCtrl()
160 See external documentation.
162 deleteChildren(This, Item) -> ok
164 Types:
166 This = wxTreeCtrl()
168 Item = integer()
169 See external documentation.
171 editLabel(This, Item) -> wxTextCtrl:wxTextCtrl()
173 Types:
175 This = wxTreeCtrl()
177 Item = integer()
178 See external documentation.
180 ensureVisible(This, Item) -> ok
182 Types:
184 This = wxTreeCtrl()
186 Item = integer()
187 See external documentation.
189 expand(This, Item) -> ok
191 Types:
193 This = wxTreeCtrl()
195 Item = integer()
196 See external documentation.
198 getBoundingRect(This, Item) -> Result
200 Types:
202 Result = {Res::boolean(), Rect::{X::integer(), Y::integer(),
204 W::integer(), H::integer()}}
205 This = wxTreeCtrl()
206 Item = integer()
207 Equivalent to getBoundingRect(This, Item, []).
209 getBoundingRect(This, Item, Options::[Option]) -> Result
211 Types:
213 Result = {Res::boolean(), Rect::{X::integer(), Y::integer(),
215 W::integer(), H::integer()}}
216 This = wxTreeCtrl()
217 Item = integer()
218 Option = {textOnly, boolean()}
219 See external documentation.
221 getChildrenCount(This, Item) -> integer()
223 Types:
225 This = wxTreeCtrl()
227 Item = integer()
228 Equivalent to getChildrenCount(This, Item, []).
230 getChildrenCount(This, Item, Options::[Option]) -> integer()
232 Types:
234 This = wxTreeCtrl()
236 Item = integer()
237 Option = {recursively, boolean()}
238 See external documentation.
240 getCount(This) -> integer()
242 Types:
244 This = wxTreeCtrl()
246 See external documentation.
248 getEditControl(This) -> wxTextCtrl:wxTextCtrl()
250 Types:
252 This = wxTreeCtrl()
254 See external documentation.
256 getFirstChild(This, Item) -> Result
258 Types:
260 Result = {Res::integer(), Cookie::integer()}
262 This = wxTreeCtrl()
263 Item = integer()
264 See external documentation.
266 getNextChild(This, Item, Cookie) -> Result
268 Types:
270 Result = {Res::integer(), Cookie::integer()}
272 This = wxTreeCtrl()
273 Item = integer()
274 Cookie = integer()
275 See external documentation.
277 getFirstVisibleItem(This) -> integer()
279 Types:
281 This = wxTreeCtrl()
283 See external documentation.
285 getImageList(This) -> wxImageList:wxImageList()
287 Types:
289 This = wxTreeCtrl()
291 See external documentation.
293 getIndent(This) -> integer()
295 Types:
297 This = wxTreeCtrl()
299 See external documentation.
301 getItemBackgroundColour(This, Item) -> wx:wx_colour4()
303 Types:
305 This = wxTreeCtrl()
307 Item = integer()
308 See external documentation.
310 getItemData(This, Item) -> term()
312 Types:
314 This = wxTreeCtrl()
316 Item = integer()
317 See external documentation.
319 getItemFont(This, Item) -> wxFont:wxFont()
321 Types:
323 This = wxTreeCtrl()
325 Item = integer()
326 See external documentation.
328 getItemImage(This, Item) -> integer()
330 Types:
332 This = wxTreeCtrl()
334 Item = integer()
335 See external documentation.
337 getItemImage(This, Item, Options::[Option]) -> integer()
339 Types:
341 This = wxTreeCtrl()
343 Item = integer()
344 Option = {which, wx:wx_enum()}
345 See external documentation.
347 Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wx‐
348 TreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wx‐
349 TreeItemIcon_Max
350 getItemText(This, Item) -> unicode:charlist()
352 Types:
354 This = wxTreeCtrl()
356 Item = integer()
357 See external documentation.
359 getItemTextColour(This, Item) -> wx:wx_colour4()
361 Types:
363 This = wxTreeCtrl()
365 Item = integer()
366 See external documentation.
368 getLastChild(This, Item) -> integer()
370 Types:
372 This = wxTreeCtrl()
374 Item = integer()
375 See external documentation.
377 getNextSibling(This, Item) -> integer()
379 Types:
381 This = wxTreeCtrl()
383 Item = integer()
384 See external documentation.
386 getNextVisible(This, Item) -> integer()
388 Types:
390 This = wxTreeCtrl()
392 Item = integer()
393 See external documentation.
395 getItemParent(This, Item) -> integer()
397 Types:
399 This = wxTreeCtrl()
401 Item = integer()
402 See external documentation.
404 getPrevSibling(This, Item) -> integer()
406 Types:
408 This = wxTreeCtrl()
410 Item = integer()
411 See external documentation.
413 getPrevVisible(This, Item) -> integer()
415 Types:
417 This = wxTreeCtrl()
419 Item = integer()
420 See external documentation.
422 getRootItem(This) -> integer()
424 Types:
426 This = wxTreeCtrl()
428 See external documentation.
430 getSelection(This) -> integer()
432 Types:
434 This = wxTreeCtrl()
436 See external documentation.
438 getSelections(This) -> Result
440 Types:
442 Result = {Res::integer(), Val::[integer()]}
444 This = wxTreeCtrl()
445 See external documentation.
447 getStateImageList(This) -> wxImageList:wxImageList()
449 Types:
451 This = wxTreeCtrl()
453 See external documentation.
455 hitTest(This, Point) -> Result
457 Types:
459 Result = {Res::integer(), Flags::integer()}
461 This = wxTreeCtrl()
462 Point = {X::integer(), Y::integer()}
463 See external documentation.
465 insertItem(This, Parent, Pos, Text) -> integer()
467 Types:
469 This = wxTreeCtrl()
471 Parent = integer()
472 Pos = integer()
473 Text = unicode:chardata()
474 Equivalent to insertItem(This, Parent, Pos, Text, []).
476 insertItem(This, Parent, Pos, Text, Options::[Option]) -> integer()
478 Types:
480 This = wxTreeCtrl()
482 Parent = integer()
483 Pos = integer()
484 Text = unicode:chardata()
485 Option = {image, integer()} | {selImage, integer()} | {data,
486 term()}
487 See external documentation.
489 isBold(This, Item) -> boolean()
491 Types:
493 This = wxTreeCtrl()
495 Item = integer()
496 See external documentation.
498 isExpanded(This, Item) -> boolean()
500 Types:
502 This = wxTreeCtrl()
504 Item = integer()
505 See external documentation.
507 isSelected(This, Item) -> boolean()
509 Types:
511 This = wxTreeCtrl()
513 Item = integer()
514 See external documentation.
516 isVisible(This, Item) -> boolean()
518 Types:
520 This = wxTreeCtrl()
522 Item = integer()
523 See external documentation.
525 itemHasChildren(This, Item) -> boolean()
527 Types:
529 This = wxTreeCtrl()
531 Item = integer()
532 See external documentation.
534 isTreeItemIdOk(Id) -> boolean()
536 Types:
538 Id = integer()
540 See external documentation.
542 prependItem(This, Parent, Text) -> integer()
544 Types:
546 This = wxTreeCtrl()
548 Parent = integer()
549 Text = unicode:chardata()
550 Equivalent to prependItem(This, Parent, Text, []).
552 prependItem(This, Parent, Text, Options::[Option]) -> integer()
554 Types:
556 This = wxTreeCtrl()
558 Parent = integer()
559 Text = unicode:chardata()
560 Option = {image, integer()} | {selectedImage, integer()} |
561 {data, term()}
562 See external documentation.
564 scrollTo(This, Item) -> ok
566 Types:
568 This = wxTreeCtrl()
570 Item = integer()
571 See external documentation.
573 selectItem(This, Item) -> ok
575 Types:
577 This = wxTreeCtrl()
579 Item = integer()
580 See external documentation.
582 selectItem(This, Item, Options::[Option]) -> ok
584 Types:
586 This = wxTreeCtrl()
588 Item = integer()
589 Option = {select, boolean()}
590 See external documentation.
592 setIndent(This, Indent) -> ok
594 Types:
596 This = wxTreeCtrl()
598 Indent = integer()
599 See external documentation.
601 setImageList(This, ImageList) -> ok
603 Types:
605 This = wxTreeCtrl()
607 ImageList = wxImageList:wxImageList()
608 See external documentation.
610 setItemBackgroundColour(This, Item, Col) -> ok
612 Types:
614 This = wxTreeCtrl()
616 Item = integer()
617 Col = wx:wx_colour()
618 See external documentation.
620 setItemBold(This, Item) -> ok
622 Types:
624 This = wxTreeCtrl()
626 Item = integer()
627 Equivalent to setItemBold(This, Item, []).
629 setItemBold(This, Item, Options::[Option]) -> ok
631 Types:
633 This = wxTreeCtrl()
635 Item = integer()
636 Option = {bold, boolean()}
637 See external documentation.
639 setItemData(This, Item, Data) -> ok
641 Types:
643 This = wxTreeCtrl()
645 Item = integer()
646 Data = term()
647 See external documentation.
649 setItemDropHighlight(This, Item) -> ok
651 Types:
653 This = wxTreeCtrl()
655 Item = integer()
656 Equivalent to setItemDropHighlight(This, Item, []).
658 setItemDropHighlight(This, Item, Options::[Option]) -> ok
660 Types:
662 This = wxTreeCtrl()
664 Item = integer()
665 Option = {highlight, boolean()}
666 See external documentation.
668 setItemFont(This, Item, Font) -> ok
670 Types:
672 This = wxTreeCtrl()
674 Item = integer()
675 Font = wxFont:wxFont()
676 See external documentation.
678 setItemHasChildren(This, Item) -> ok
680 Types:
682 This = wxTreeCtrl()
684 Item = integer()
685 Equivalent to setItemHasChildren(This, Item, []).
687 setItemHasChildren(This, Item, Options::[Option]) -> ok
689 Types:
691 This = wxTreeCtrl()
693 Item = integer()
694 Option = {has, boolean()}
695 See external documentation.
697 setItemImage(This, Item, Image) -> ok
699 Types:
701 This = wxTreeCtrl()
703 Item = integer()
704 Image = integer()
705 See external documentation.
707 setItemImage(This, Item, Image, Options::[Option]) -> ok
709 Types:
711 This = wxTreeCtrl()
713 Item = integer()
714 Image = integer()
715 Option = {which, wx:wx_enum()}
716 See external documentation.
718 Which = ?wxTreeItemIcon_Normal | ?wxTreeItemIcon_Selected | ?wx‐
719 TreeItemIcon_Expanded | ?wxTreeItemIcon_SelectedExpanded | ?wx‐
720 TreeItemIcon_Max
721 setItemText(This, Item, Text) -> ok
723 Types:
725 This = wxTreeCtrl()
727 Item = integer()
728 Text = unicode:chardata()
729 See external documentation.
731 setItemTextColour(This, Item, Col) -> ok
733 Types:
735 This = wxTreeCtrl()
737 Item = integer()
738 Col = wx:wx_colour()
739 See external documentation.
741 setStateImageList(This, ImageList) -> ok
743 Types:
745 This = wxTreeCtrl()
747 ImageList = wxImageList:wxImageList()
748 See external documentation.
750 setWindowStyle(This, Styles) -> ok
752 Types:
754 This = wxTreeCtrl()
756 Styles = integer()
757 See external documentation.
759 sortChildren(This, Item) -> ok
761 Types:
763 This = wxTreeCtrl()
765 Item = integer()
766 See external documentation.
768 toggle(This, Item) -> ok
770 Types:
772 This = wxTreeCtrl()
774 Item = integer()
775 See external documentation.
777 toggleItemSelection(This, Item) -> ok
779 Types:
781 This = wxTreeCtrl()
783 Item = integer()
784 See external documentation.
786 unselect(This) -> ok
788 Types:
790 This = wxTreeCtrl()
792 See external documentation.
794 unselectAll(This) -> ok
796 Types:
798 This = wxTreeCtrl()
800 See external documentation.
802 unselectItem(This, Item) -> ok
804 Types:
806 This = wxTreeCtrl()
808 Item = integer()
809 See external documentation.
811 destroy(This::wxTreeCtrl()) -> ok
813 Destroys this object, do not use object again
815
817 <>
818 wx 1.9.3.1 wxTreeCtrl(3)