wxTreeEvent(3erl)

💖 NAME 💖

okay bestie, welcome to wxTreeEvent — this is the Erlang Module Definition manual page (3erl), and the official name line is wxTreeEvent - Functions for wxTreeEvent class. We're folding that manual-name goodness right up here so you never lose the plot. ✨

✨ DESCRIPTION ✨

A tree event is the little info packet that holds details about events tied to wxTreeCtrl objects. It's giving "I was there, I know what happened in the tree." 🌳

To process input from a tree control, use these event handler macros to direct input to member functions that take a wxTreeEvent argument. That's the whole routing situation, fr fr.

See: wxTreeCtrl

This class is derived (and can use functions) from: wxNotifyEvent wxCommandEvent wxEvent

wxWidgets docs: wxTreeEvent

🌈 EVENTS 🌈

Use wxEvtHandler:connect/3 with wxTreeEventType to subscribe to events of this type. That's your subscription era. 🎟️

🦋 DATA TYPES 🦋

wxTreeEvent() = wx:wx_object()

wxTree() =
    #wxTree{type = wxTreeEvent:wxTreeEventType(),
            item = integer(),
            itemOld = integer(),
            pointDrag = {X :: integer(), Y :: integer()}}

wxTreeEventType() =
    command_tree_begin_drag | command_tree_begin_rdrag |
    command_tree_begin_label_edit | command_tree_end_label_edit |
    command_tree_delete_item | command_tree_get_info |
    command_tree_set_info | command_tree_item_expanded |
    command_tree_item_expanding | command_tree_item_collapsed |
    command_tree_item_collapsing | command_tree_sel_changed |
    command_tree_sel_changing | command_tree_key_down |
    command_tree_item_activated | command_tree_item_right_click |
    command_tree_item_middle_click | command_tree_end_drag |
    command_tree_state_image_click |
    command_tree_item_gettooltip | command_tree_item_menu |
    dirctrl_selectionchanged | dirctrl_fileactivated

👑 EXPORTS 👑

getKeyCode(This) -> integer()

Types:

This = wxTreeEvent()

If this is a key event, it gives you the key code. Wanna know the modifier keys for this event (i.e. Shift or Ctrl)? Use getKeyEvent/1 for those values. 🔑

getItem(This) -> integer()

Types:

This = wxTreeEvent()

Hands you the item — valid for all events. No cap. 🎀

getKeyEvent(This) -> wxKeyEvent:wxKeyEvent()

Types:

This = wxTreeEvent()

Gives you the key event for EVT_TREE_KEY_DOWN events. ⌨️

getLabel(This) -> unicode:charlist()

Types:

This = wxTreeEvent()

If the event is a begin or end edit label event, this returns the label. Label girlies rise. 🏷️

getOldItem(This) -> integer()

Types:

This = wxTreeEvent()

Returns the old item index — valid for EVT_TREE_SEL_CHANGING and EVT_TREE_SEL_CHANGED events. 🕰️

getPoint(This) -> {X :: integer(), Y :: integer()}

Types:

This = wxTreeEvent()

If the event is a drag or menu-context event, this returns the position of the mouse pointer.

In both cases the position is in client coordinates - i.e. relative to the wxTreeCtrl window (so that you can pass it directly to e.g. wxWindow:popupMenu/4). 🖱️

isEditCancelled(This) -> boolean()

Types:

This = wxTreeEvent()

Returns true if the label edit was cancelled.

This should be called from within an EVT_TREE_END_LABEL_EDIT handler. 🚫

setToolTip(This, Tooltip) -> ok

Types:

This = wxTreeEvent()
Tooltip = unicode:chardata()

Set the tooltip for the item (valid for EVT_TREE_ITEM_GETTOOLTIP events).

Windows only. 🪟

---

and that's the whole page, bestie! 💅 cute sign-off time: the footer says wxWidgets team., version wx 2.2.2.1, and manual name wxTreeEvent(3erl). There's no separate date on this footer, so that's the full tea. 🫶✨