wxtreeevent

a tree event holds information about events associated with wxtreectrl objects.

derived from

wxnotifyevent
wxcommandevent
wxevent
wxobject

include files

event table macros

to process input from a tree control, use these event handler macros to direct input to member functions that take a wxtreeevent argument.

evt_tree_begin_drag(id, func)	the user has started dragging an item with the left mouse button. the event handler must call wxtreeevent::allow() for the drag operation to continue.
evt_tree_begin_rdrag(id, func)	the user has started dragging an item with the right mouse button. the event handler must call wxtreeevent::allow() for the drag operation to continue.
evt_tree_begin_label_edit(id, func)	begin editing a label. this can be prevented by calling veto().
evt_tree_end_drag(id, func)	the user has released the mouse after dragging an item.
evt_tree_end_label_edit(id, func)	the user has finished editing a label. this can be prevented by calling veto().
evt_tree_delete_item(id, func)	a tree item has been deleted.
evt_tree_item_activated(id, func)	an item has been activated (e.g. double clicked).
evt_tree_item_collapsed(id, func)	the item has been collapsed.
evt_tree_item_collapsing(id, func)	the item is being collapsed. this can be prevented by calling veto().
evt_tree_item_expanded(id, func)	the item has been expanded.
evt_tree_item_expanding(id, func)	the item is being expanded. this can be prevented by calling veto().
evt_tree_item_right_click(id, func)	the user has clicked the item with the right mouse button.
evt_tree_item_middle_click(id, func)	the user has clicked the item with the middle mouse button.
evt_tree_key_down(id, func)	a key has been pressed.
evt_tree_sel_changed(id, func)	selection has changed.
evt_tree_sel_changing(id, func)	selection is changing. this can be prevented by calling veto().
evt_tree_key_down(id, func)	a key has been pressed.
evt_tree_item_gettooltip(id, func)	the opportunity to set the item tooltip is being given to the application (call wxtreeevent::settooltip). windows only.
evt_tree_item_menu(id, func)	the context menu for the selected item has been requested, either by a right click or by using the menu key.
evt_tree_state_image_click(id, func)	the state image has been clicked. windows only.

see also

wxtreectrl

members

wxtreeevent::wxtreeevent
wxtreeevent::getkeycode
wxtreeevent::getitem
wxtreeevent::getkeyevent
wxtreeevent::getlabel
wxtreeevent::getolditem
wxtreeevent::getpoint
wxtreeevent::iseditcancelled
wxtreeevent::settooltip

wxtreeevent::wxtreeevent

wxtreeevent(wxeventtype commandtype, wxtreectrl *tree, const wxtreeitemid&item = wxtreeitemid())

constructor, used by wxwidgets itself only.

wxtreeevent::getkeycode

int getkeycode() const

returns the key code if the event is a key event. use getkeyevent to get the values of the modifier keys for this event (i.e. shift or ctrl).

wxtreeevent::getitem

wxtreeitemid getitem() const

returns the item (valid for all events).

wxtreeevent::getkeyevent

const wxkeyevent& getkeyevent() const

returns the key event for evt_tree_key_down events.

wxtreeevent::getlabel

const wxstring& getlabel() const

returns the label if the event is a begin or end edit label event.

wxtreeevent::getolditem

wxtreeitemid getolditem() const

returns the old item index (valid for evt_tree_item_changing and changed events)

wxtreeevent::getpoint

wxpoint getpoint() const

returns the position of the mouse pointer if the event is a drag or menu-context event. 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).

wxtreeevent::iseditcancelled

bool iseditcancelled() const

returns true if the label edit was cancelled. this should be called from within an evt_tree_end_label_edit handler.

wxtreeevent::settooltip

void settooltip(const wxstring& tooltip)

set the tooltip for the item (valid for evt_tree_item_gettooltip events). windows only.