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

NAME

6       wxTreeEvent - Functions for wxTreeEvent class
7

DESCRIPTION

9       A  tree event holds information about events associated with wxTreeCtrl
10       objects.
11
12       To process input from a tree control, use these event handler macros to
13       direct input to member functions that take a wxTreeEvent argument.
14
15       See: wxTreeCtrl
16
17       This  class  is derived (and can use functions) from: wxNotifyEvent wx‐
18       CommandEvent wxEvent
19
20       wxWidgets docs: wxTreeEvent
21

EVENTS

23       Use wxEvtHandler:connect/3 with wxTreeEventType to subscribe to  events
24       of this type.
25

DATA TYPES

27       wxTreeEvent() = wx:wx_object()
28
29       wxTree() =
30           #wxTree{type = wxTreeEvent:wxTreeEventType(),
31                   item = integer(),
32                   itemOld = integer(),
33                   pointDrag = {X :: integer(), Y :: integer()}}
34
35       wxTreeEventType() =
36           command_tree_begin_drag | command_tree_begin_rdrag |
37           command_tree_begin_label_edit | command_tree_end_label_edit |
38           command_tree_delete_item | command_tree_get_info |
39           command_tree_set_info | command_tree_item_expanded |
40           command_tree_item_expanding | command_tree_item_collapsed |
41           command_tree_item_collapsing | command_tree_sel_changed |
42           command_tree_sel_changing | command_tree_key_down |
43           command_tree_item_activated | command_tree_item_right_click |
44           command_tree_item_middle_click | command_tree_end_drag |
45           command_tree_state_image_click |
46           command_tree_item_gettooltip | command_tree_item_menu |
47           dirctrl_selectionchanged | dirctrl_fileactivated
48

EXPORTS

50       getKeyCode(This) -> integer()
51
52              Types:
53
54                 This = wxTreeEvent()
55
56              Returns the key code if the event is a key event.
57
58              Use  getKeyEvent/1  to  get  the values of the modifier keys for
59              this event (i.e. Shift or Ctrl).
60
61       getItem(This) -> integer()
62
63              Types:
64
65                 This = wxTreeEvent()
66
67              Returns the item (valid for all events).
68
69       getKeyEvent(This) -> wxKeyEvent:wxKeyEvent()
70
71              Types:
72
73                 This = wxTreeEvent()
74
75              Returns the key event for EVT_TREE_KEY_DOWN events.
76
77       getLabel(This) -> unicode:charlist()
78
79              Types:
80
81                 This = wxTreeEvent()
82
83              Returns the label if the event is a  begin  or  end  edit  label
84              event.
85
86       getOldItem(This) -> integer()
87
88              Types:
89
90                 This = wxTreeEvent()
91
92              Returns  the old item index (valid for EVT_TREE_SEL_CHANGING and
93              EVT_TREE_SEL_CHANGED events).
94
95       getPoint(This) -> {X :: integer(), Y :: integer()}
96
97              Types:
98
99                 This = wxTreeEvent()
100
101              Returns the position of the mouse pointer if the event is a drag
102              or menu-context event.
103
104              In both cases the position is in client coordinates - i.e. rela‐
105              tive to the wxTreeCtrl window (so that you can pass it  directly
106              to e.g. wxWindow:popupMenu/4).
107
108       isEditCancelled(This) -> boolean()
109
110              Types:
111
112                 This = wxTreeEvent()
113
114              Returns true if the label edit was cancelled.
115
116              This  should  be  called  from within an EVT_TREE_END_LABEL_EDIT
117              handler.
118
119       setToolTip(This, Tooltip) -> ok
120
121              Types:
122
123                 This = wxTreeEvent()
124                 Tooltip = unicode:chardata()
125
126              Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP
127              events).
128
129              Windows only.
130
131
132
133wxWidgets team.                     wx 2.1                      wxTreeEvent(3)